@boses/github-clone 1.0.9 → 1.1.3

package/README.md

@@ -1,86 +1,126 @@
-# github-clone
+# GitHub-clone
 
-![mlt](https://img.shields.io/badge/License-MIT-brightgreen) ![mlt](https://img.shields.io/badge/npm-1.0.9-brightgreen)
+![mlt](https://img.shields.io/badge/License-MIT-brightgreen) ![mlt](https://img.shields.io/badge/npm-1.1.1-brightgreen)
 
-解决国内 Github clone 速度慢的工具
+为了解决国内 GitHub clone 速度慢较慢的工具
 
-## 工作流程
+> 注意以下文档书写形式遵循下述规范：
+>
+> `[]`代表这个字段必填，`<>`则为选填，而`name?:string`，表示这个参数为非必填为`string`类型。
 
-首先根据镜像网站替换掉输入的`github.com`，之后拉取完成后执行`git remote set-url origin [url]`的操作
+## 执行流程
 
-## 安装
+- 首先将输入的 `github.com`替换成设置的镜像网站地址，默认为（github.com.cnpmjs.org）
+- 执行 `git clone [url]` 的操作
+- 拉取镜像完成之后，重写 git 的远程仓库推送地址，将镜像推送地址重置为 github 的镜像地址
+
+## CLI 使用方式
+
+### 安装
 
 ```sh
-npm i -g @boses/github-clone
-# or
 yarn global add @boses/github-clone
 ```
 
-之后可以通过`g clone <path>`来使用，更多详细输出可以使用`g ---help`来查看
+之后通过`g clone <path>`形式来使用，更多`API`和`clone`的使用方法可以调用`g ---help`查看。
 
-## 用法
+### API
 
-### clone <path> [dir] <--branch [branchName]>
+#### Clone
 
-#### path
+**clone <path> [dir] <--branch [branchName]>**
 
-- type:`stirng`
-- require: `true`
+- `<path>`
+
+  - type:`stirng`
+  - require:`true`
+
+  拉取 GitHub 仓库 对应的地址，可以拉取以下三种类型地址
+
+  | 类型                                             | 说明                          |
+  | ------------------------------------------------ | ----------------------------- |
+  | https://github.com/bosens-China/github-clone     | 默认浏览器导航栏的地址        |
+  | https://github.com/bosens-China/github-clone.git | Github 右侧 Code HTTPS 的地址 |
+  | git@github.com:bosens-China/breeze-clone.git     | Github 右侧 Code SSH 的地址   |
+
+- `[dir]`
+
+  - type:`stirng`
+  - require:`false`
 
-拉取 Github 仓库 对应的地址，可以拉取以下三种类型地址
+  clone 到本地的目录名称
 
-1. https://github.com/bosens-China/github-clone
+- `--branch [branchName]`
 
-   默认浏览器导航栏的地址
+  - type:`stirng`
+  - require:`false`
 
-2. https://github.com/bosens-China/github-clone.git
+  指定拉取的分支名称，可以以`--branch`长形式使用也可以以`-b`的短形式使用，例如：
 
-   Github 右侧 Code HTTPS 的地址
+  ```sh
+  g clone https://github.com/bosens-China/github-clone.git -b dev
+  ```
 
-3. git@github.com:bosens-China/breeze-clone.git
+#### set [url]
 
-   Github 右侧 Code SSH 的地址
+- `[url]`
 
-#### dir
+  - type:`stirng`
+  - require:`true`
 
-- type:`stirng`
-- require: `false`
-- default: `undefined`
+  用于配置镜像网站
 
-重命名 clone 拉取到本地目录名称
+#### get
 
-#### branch
+返回用户配置的`set [url]`地址，默认为`github.com.cnpmjs.org`
 
-- type:`stirng`
-- require: `false`
-- default: `undefined`
+## Node
 
-指定拉取的分支名称，可以以`--branch`长形式使用也可以以`-b`的短形式使用，例如
+### 安装
 
 ```sh
-g clone https://github.com/bosens-China/github-clone.git -b dev
+yarn add @boses/github-clone
 ```
 
-### set [url]
+```js
+const clone = require('@boses/github-clone');
+// 也可以通过es模块引用
+// import clone from '@boses/github-clone/gitClone.esm'
+clone('https://github.com/SunshowerC/blog');
+```
+
+> clone 会以同步的形式运行，记得使用 `try` 包裹住可能的错误
+
+### API
+
+`clone: (url: string, options: Partial<Options>) => void`
 
 #### url
 
-- type:`stirng`
-- require: `false`
-- default: `github.com.cnpmjs.org`
+- type:`string`
+- require: `true`
 
-用于配置`cloe`替换地址的 url
+拉取的 GitHub 仓库地址
 
-### get
+#### options
 
-返回用户配置的`set [url]`地址
+| 名称          | 类型      | 是否必填 | 描述                                       |
+| ------------- | --------- | -------- | ------------------------------------------ |
+| dir           | `string`  | `false`  | 拉取的目录名称                             |
+| branch        | `string`  | `false`  | 拉取的分支名称                             |
+| mirrorAddress | `string`  | `false`  | 镜像网站，如果你需要使用镜像可以填写此网站 |
+| silence       | `boolean` | `false`  | 是否静默模式执行 clone                     |
 
 ## 其他
 
+目前版本更新导致对`1.0.9`之前的`g get`不支持，请重新执行`g set [url]`的操作
+
 如果发现错误或者需要有更好的建议欢迎在 [issues](https://github.com/bosens-China/github-clone) 中提出
 
 ## 参考
-- [知乎 git clone一个github上的仓库，太慢，经常连接失败...](https://www.zhihu.com/question/27159393/answer/1117219745)
+
+- [知乎 git clone 一个 github 上的仓库，太慢，经常连接失败...](https://www.zhihu.com/question/27159393/answer/1117219745)
+
 ## 协议
 
 [MIT License](/License)

package/dist/gitClone.esm.js

@@ -0,0 +1,2 @@
+import{execSync as t,spawnSync as r}from"child_process";import i from"process";import"path";const o=(o,e)=>{if(!(()=>{try{return t("git --version"),!0}catch(t){return!1}})())throw new Error("Git does not exist!");if(!(t=>!!/^(https:\/\/github\.com\/|git@github\.com:)[\s\S]+\/[\s\S]+(\.git)?$/.exec(t))(o))throw new Error(`The current URL ${o} is not in a valid GitHub clone format!`);const{dir:s,branch:c,mirrorAddress:h,silence:n}=e||{};((t,i)=>{const o=t.split(" "),e=o.shift()||"",s=r(e,o,i);if(s.error)throw s.error})(`git clone ${h?((t,r)=>{let i=t;if(i.startsWith("git@")){const[,t,r]=i.match(/^git@github\.com:([\s\S]+)\/([\s\S]+)\.git$/)||[];i=`https://github.com/${t}/${r}.git`}return i.endsWith(".git")||(i+=".git"),i=i.replace("github.com",r),i})(o,h):o}${s?` ${s}`:""}${c?` --branch ${c}`:""}`,{cwd:i.cwd(),stdio:n?"pipe":"inherit"})};export{o as default};
+//# sourceMappingURL=gitClone.esm.js.map

package/dist/gitClone.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitClone.esm.js","sources":["../src/utils.ts","../src/gitClone.ts"],"sourcesContent":["import path from 'path';\nimport { execSync } from 'child_process';\n\n/**\n * 替换git的远程推送源地址，这里暂定origin名称为固定的\n */\nexport const setGitSource = (dir: string, url: string) => {\n  // 仓库所在文件地址\n  const dirPath = path.join(process.cwd(), dir);\n  // 先删除在执行\n  const shellStr = `git remote set-url origin ${url}`;\n  execSync(shellStr, { cwd: dirPath });\n};\n\n/**\n * 根据github的url返回对应的文件夹名称\n * https://github.com.cnpmjs.org/bosens-China/github-clone会返回github-clone\n *\n */\nexport const getDir = (url: string) => {\n  const str = url;\n  const dir = str.split('/').pop() || '';\n  return dir.includes('.git') ? dir.slice(0, dir.indexOf('.git')) : dir;\n};\n\n/* 是否为支持的git clone拉取格式\n * https://github.com/bosens-China/breeze-cli\n * https://github.com/bosens-China/breeze-cli.git\n * git@github.com:bosens-China/breeze-cli.git\n */\nexport const isGithubLink = (url: string) => {\n  const reg = /^(https:\\/\\/github\\.com\\/|git@github\\.com:)[\\s\\S]+\\/[\\s\\S]+(\\.git)?$/;\n  return !!reg.exec(url);\n};\n\n/**\n * 将当前的网站替换成镜像网站，例如\n * https://github.com/bosens-China/github-clone会被替换成\n * https://github.com.cnpmjs.org/bosens-China/github-clone\n */\n\nexport const replaceMirror = (currentWebsite: string, replaceWebsite: string) => {\n  let s = currentWebsite;\n  // 这里处理一下以git@开头的情况，如果git@开头，把用户名和仓库提取出来，用https的形式拉取\n  // https://github.com/bosens-China/breeze-cli.git\n  // git@github.com:bosens-China/breeze-cli.git\n  if (s.startsWith('git@')) {\n    const [, name, warehouse] = s.match(/^git@github\\.com:([\\s\\S]+)\\/([\\s\\S]+)\\.git$/) || [];\n    s = `https://github.com/${name}/${warehouse}.git`;\n  }\n  if (!s.endsWith('.git')) {\n    s += '.git';\n  }\n  s = s.replace('github.com', replaceWebsite);\n  return s;\n};\n","import { execSync, spawnSync, SpawnSyncOptionsWithBufferEncoding } from 'child_process';\nimport process from 'process';\nimport { isGithubLink, replaceMirror } from './utils';\n\n/**\n * 判断git是否存在\n */\nconst gitExist = () => {\n  try {\n    execSync(`git --version`);\n    return true;\n  } catch {\n    return false;\n  }\n};\n\nconst pull = (shellStr: string, option?: SpawnSyncOptionsWithBufferEncoding) => {\n  const args = shellStr.split(' ');\n  const name = args.shift() || '';\n  const info = spawnSync(name, args, option);\n  if (info.error) {\n    throw info.error;\n  }\n  return info;\n};\ninterface Options {\n  dir: string;\n  branch: string;\n  mirrorAddress: string;\n  silence: boolean;\n}\n\nconst clone = (url: string, options: Partial<Options>) => {\n  if (!gitExist()) {\n    throw new Error(`Git does not exist!`);\n  }\n  if (!isGithubLink(url)) {\n    throw new Error(`The current URL ${url} is not in a valid GitHub clone format!`);\n  }\n  const { dir, branch, mirrorAddress, silence } = options || {};\n  // 如果存在镜像网站就替换一下格式\n  const template = mirrorAddress ? replaceMirror(url, mirrorAddress) : url;\n  const shell = `git clone ${template}${dir ? ` ${dir}` : ''}${branch ? ` --branch ${branch}` : ''}`;\n  pull(shell, { cwd: process.cwd(), stdio: silence ? 'pipe' : 'inherit' });\n};\n\nexport default clone;\n"],"names":["clone","url","options","execSync","gitExist","Error","exec","isGithubLink","dir","branch","mirrorAddress","silence","shellStr","option","args","split","name","shift","info","spawnSync","error","pull","currentWebsite","replaceWebsite","s","startsWith","warehouse","match","endsWith","replace","replaceMirror","cwd","process","stdio"],"mappings":"4FA8BO,MCEDA,EAAQ,CAACC,EAAaC,KAC1B,IA1Be,MACf,IAEE,OADAC,EAAS,kBACF,EACP,SACA,OAAO,IAqBJC,GACH,MAAM,IAAIC,MAAM,uBAElB,IDN0B,CAACJ,KACf,uEACCK,KAAKL,GCIbM,CAAaN,GAChB,MAAM,IAAII,MAAM,mBAAmBJ,4CAErC,MAAMO,IAAEA,EAAGC,OAAEA,EAAMC,cAAEA,EAAaC,QAAEA,GAAYT,GAAW,GAvBhD,EAACU,EAAkBC,KAC9B,MAAMC,EAAOF,EAASG,MAAM,KACtBC,EAAOF,EAAKG,SAAW,GACvBC,EAAOC,EAAUH,EAAMF,EAAMD,GACnC,GAAIK,EAAKE,MACP,MAAMF,EAAKE,OAsBbC,CADc,aADGX,EDAU,EAACY,EAAwBC,KACpD,IAAIC,EAAIF,EAIR,GAAIE,EAAEC,WAAW,QAAS,CACxB,OAAST,EAAMU,GAAaF,EAAEG,MAAM,gDAAkD,GACtFH,EAAI,sBAAsBR,KAAQU,QAMpC,OAJKF,EAAEI,SAAS,UACdJ,GAAK,QAEPA,EAAIA,EAAEK,QAAQ,aAAcN,GACrBC,GCb0BM,CAAc7B,EAAKS,GAAiBT,IAC/BO,EAAM,IAAIA,IAAQ,KAAKC,EAAS,aAAaA,IAAW,KAClF,CAAEsB,IAAKC,EAAQD,MAAOE,MAAOtB,EAAU,OAAS"}

package/dist/gitClone.js

@@ -0,0 +1,2 @@
+"use strict";var t=require("child_process"),r=require("process");function e(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}require("path");var i=e(r);module.exports=(r,e)=>{if(!(()=>{try{return t.execSync("git --version"),!0}catch(t){return!1}})())throw new Error("Git does not exist!");if(!(t=>!!/^(https:\/\/github\.com\/|git@github\.com:)[\s\S]+\/[\s\S]+(\.git)?$/.exec(t))(r))throw new Error(`The current URL ${r} is not in a valid GitHub clone format!`);const{dir:o,branch:c,mirrorAddress:s,silence:n}=e||{};((r,e)=>{const i=r.split(" "),o=i.shift()||"",c=t.spawnSync(o,i,e);if(c.error)throw c.error})(`git clone ${s?((t,r)=>{let e=t;if(e.startsWith("git@")){const[,t,r]=e.match(/^git@github\.com:([\s\S]+)\/([\s\S]+)\.git$/)||[];e=`https://github.com/${t}/${r}.git`}return e.endsWith(".git")||(e+=".git"),e=e.replace("github.com",r),e})(r,s):r}${o?` ${o}`:""}${c?` --branch ${c}`:""}`,{cwd:i.default.cwd(),stdio:n?"pipe":"inherit"})};
+//# sourceMappingURL=gitClone.js.map

package/dist/gitClone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitClone.js","sources":["../src/gitClone.ts","../src/utils.ts"],"sourcesContent":["import { execSync, spawnSync, SpawnSyncOptionsWithBufferEncoding } from 'child_process';\nimport process from 'process';\nimport { isGithubLink, replaceMirror } from './utils';\n\n/**\n * 判断git是否存在\n */\nconst gitExist = () => {\n  try {\n    execSync(`git --version`);\n    return true;\n  } catch {\n    return false;\n  }\n};\n\nconst pull = (shellStr: string, option?: SpawnSyncOptionsWithBufferEncoding) => {\n  const args = shellStr.split(' ');\n  const name = args.shift() || '';\n  const info = spawnSync(name, args, option);\n  if (info.error) {\n    throw info.error;\n  }\n  return info;\n};\ninterface Options {\n  dir: string;\n  branch: string;\n  mirrorAddress: string;\n  silence: boolean;\n}\n\nconst clone = (url: string, options: Partial<Options>) => {\n  if (!gitExist()) {\n    throw new Error(`Git does not exist!`);\n  }\n  if (!isGithubLink(url)) {\n    throw new Error(`The current URL ${url} is not in a valid GitHub clone format!`);\n  }\n  const { dir, branch, mirrorAddress, silence } = options || {};\n  // 如果存在镜像网站就替换一下格式\n  const template = mirrorAddress ? replaceMirror(url, mirrorAddress) : url;\n  const shell = `git clone ${template}${dir ? ` ${dir}` : ''}${branch ? ` --branch ${branch}` : ''}`;\n  pull(shell, { cwd: process.cwd(), stdio: silence ? 'pipe' : 'inherit' });\n};\n\nexport default clone;\n","import path from 'path';\nimport { execSync } from 'child_process';\n\n/**\n * 替换git的远程推送源地址，这里暂定origin名称为固定的\n */\nexport const setGitSource = (dir: string, url: string) => {\n  // 仓库所在文件地址\n  const dirPath = path.join(process.cwd(), dir);\n  // 先删除在执行\n  const shellStr = `git remote set-url origin ${url}`;\n  execSync(shellStr, { cwd: dirPath });\n};\n\n/**\n * 根据github的url返回对应的文件夹名称\n * https://github.com.cnpmjs.org/bosens-China/github-clone会返回github-clone\n *\n */\nexport const getDir = (url: string) => {\n  const str = url;\n  const dir = str.split('/').pop() || '';\n  return dir.includes('.git') ? dir.slice(0, dir.indexOf('.git')) : dir;\n};\n\n/* 是否为支持的git clone拉取格式\n * https://github.com/bosens-China/breeze-cli\n * https://github.com/bosens-China/breeze-cli.git\n * git@github.com:bosens-China/breeze-cli.git\n */\nexport const isGithubLink = (url: string) => {\n  const reg = /^(https:\\/\\/github\\.com\\/|git@github\\.com:)[\\s\\S]+\\/[\\s\\S]+(\\.git)?$/;\n  return !!reg.exec(url);\n};\n\n/**\n * 将当前的网站替换成镜像网站，例如\n * https://github.com/bosens-China/github-clone会被替换成\n * https://github.com.cnpmjs.org/bosens-China/github-clone\n */\n\nexport const replaceMirror = (currentWebsite: string, replaceWebsite: string) => {\n  let s = currentWebsite;\n  // 这里处理一下以git@开头的情况，如果git@开头，把用户名和仓库提取出来，用https的形式拉取\n  // https://github.com/bosens-China/breeze-cli.git\n  // git@github.com:bosens-China/breeze-cli.git\n  if (s.startsWith('git@')) {\n    const [, name, warehouse] = s.match(/^git@github\\.com:([\\s\\S]+)\\/([\\s\\S]+)\\.git$/) || [];\n    s = `https://github.com/${name}/${warehouse}.git`;\n  }\n  if (!s.endsWith('.git')) {\n    s += '.git';\n  }\n  s = s.replace('github.com', replaceWebsite);\n  return s;\n};\n"],"names":["url","options","execSync","gitExist","Error","exec","isGithubLink","dir","branch","mirrorAddress","silence","shellStr","option","args","split","name","shift","info","spawnSync","error","pull","currentWebsite","replaceWebsite","s","startsWith","warehouse","match","endsWith","replace","replaceMirror","cwd","process","stdio"],"mappings":"mLAgCc,CAACA,EAAaC,KAC1B,IA1Be,MACf,IAEE,OADAC,WAAS,kBACF,EACP,SACA,OAAO,IAqBJC,GACH,MAAM,IAAIC,MAAM,uBAElB,ICN0B,CAACJ,KACf,uEACCK,KAAKL,GDIbM,CAAaN,GAChB,MAAM,IAAII,MAAM,mBAAmBJ,4CAErC,MAAMO,IAAEA,EAAGC,OAAEA,EAAMC,cAAEA,EAAaC,QAAEA,GAAYT,GAAW,GAvBhD,EAACU,EAAkBC,KAC9B,MAAMC,EAAOF,EAASG,MAAM,KACtBC,EAAOF,EAAKG,SAAW,GACvBC,EAAOC,YAAUH,EAAMF,EAAMD,GACnC,GAAIK,EAAKE,MACP,MAAMF,EAAKE,OAsBbC,CADc,aADGX,ECAU,EAACY,EAAwBC,KACpD,IAAIC,EAAIF,EAIR,GAAIE,EAAEC,WAAW,QAAS,CACxB,OAAST,EAAMU,GAAaF,EAAEG,MAAM,gDAAkD,GACtFH,EAAI,sBAAsBR,KAAQU,QAMpC,OAJKF,EAAEI,SAAS,UACdJ,GAAK,QAEPA,EAAIA,EAAEK,QAAQ,aAAcN,GACrBC,GDb0BM,CAAc7B,EAAKS,GAAiBT,IAC/BO,EAAM,IAAIA,IAAQ,KAAKC,EAAS,aAAaA,IAAW,KAClF,CAAEsB,IAAKC,UAAQD,MAAOE,MAAOtB,EAAU,OAAS"}

package/dist/main.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+"use strict";var e=require("commander"),t=require("os"),r=require("path"),o=require("fs"),i=require("./gitClone"),c=require("child_process");function n(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var s=n(t),a=n(r),u=n(o),l=n(i);const d=s.default.homedir(),g=a.default.join(d,".g.config"),h="github.com.cnpmjs.org",m=()=>u.default.existsSync(g)&&u.default.readFileSync(g,"utf-8")||h,p=new e.Command;p.version("1.1.2","-v, --version","输出当前版本号"),p.command("clone <url> [warehouse]").description("根据url拉取指定仓库").option("-b, --branch <value>","拉取指定分支").action(((e,t,{branch:r}={})=>{try{l.default(e,{dir:t,branch:r,mirrorAddress:m()});const o=t||(e=>{const t=e.split("/").pop()||"";return t.includes(".git")?t.slice(0,t.indexOf(".git")):t})(m()?((e,t)=>{let r=e;if(r.startsWith("git@")){const[,e,t]=r.match(/^git@github\.com:([\s\S]+)\/([\s\S]+)\.git$/)||[];r=`https://github.com/${e}/${t}.git`}return r.endsWith(".git")||(r+=".git"),r=r.replace("github.com",t),r})(e,m()):e);((e,t)=>{const r=a.default.join(process.cwd(),e),o=`git remote set-url origin ${t}`;c.execSync(o,{cwd:r})})(o,e)}catch(e){console.error(`${e instanceof Error?e.message:e}`)}})),p.command("set [path]").description(`修改github的镜像仓库地址,<path>可选，如果省略，默认为: ${h}`).action(((e=h)=>{try{t=e,u.default.writeFileSync(g,t),console.log(`set ${e}成功`)}catch(e){console.error("set path error")}var t})),p.command("get [path]").description("读取当前的默认镜像地址").action((()=>{const e=m();console.log(`当前镜像地址为：${e}`)})),p.parse(process.argv);
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sources":["../src/config.ts","../src/main.ts","../src/utils.ts"],"sourcesContent":["import os from 'os';\nimport path from 'path';\nimport fs from 'fs';\n\nconst dir = os.homedir();\nconst configPath = path.join(dir, '.g.config');\n\n// 默认github镜像网站\nexport const DEFAULTPATH = 'github.com.cnpmjs.org';\n\n/**\n * 读取配置\n *\n */\nexport const getAddress = () => {\n  if (!fs.existsSync(configPath)) {\n    return DEFAULTPATH;\n  }\n  return fs.readFileSync(configPath, 'utf-8') || DEFAULTPATH;\n};\n\n/**\n * 设置配置\n *\n */\nexport const setAddress = (address: string) => {\n  fs.writeFileSync(configPath, address);\n};\n","#!/usr/bin/env node\n\nimport { Command } from 'commander';\nimport { version } from '../package.json';\nimport { getAddress, setAddress, DEFAULTPATH } from './config';\nimport GitClone from './gitClone';\nimport { setGitSource, getDir, replaceMirror } from './utils';\n\nconst program = new Command();\nprogram.version(version, '-v, --version', '输出当前版本号');\n// git clone 支持多个命令，但是这里只让他支持-b也就是拉取指定分支，非必填\nprogram\n  .command('clone <url> [warehouse]')\n  .description('根据url拉取指定仓库')\n  .option('-b, --branch <value>', '拉取指定分支')\n  .action((url, dir, { branch } = {}) => {\n    try {\n      // 开始拉取\n      GitClone(url, { dir, branch, mirrorAddress: getAddress() });\n      // 拉取成功之后，进入拉取目录修改推送源地址\n      const directory = dir || getDir(getAddress() ? replaceMirror(url, getAddress()) : url);\n      setGitSource(directory, url);\n    } catch (e) {\n      console.error(`${e instanceof Error ? e.message : e}`);\n    }\n  });\n\nprogram\n  .command('set [path]')\n  .description(`修改github的镜像仓库地址,<path>可选，如果省略，默认为: ${DEFAULTPATH}`)\n  .action((pathUrl = DEFAULTPATH) => {\n    try {\n      setAddress(pathUrl);\n      console.log(`set ${pathUrl}成功`);\n    } catch {\n      console.error(`set path error`);\n    }\n  });\nprogram\n  .command('get [path]')\n  .description(`读取当前的默认镜像地址`)\n  .action(() => {\n    const path = getAddress();\n    console.log(`当前镜像地址为：${path}`);\n  });\nprogram.parse(process.argv);\n","import path from 'path';\nimport { execSync } from 'child_process';\n\n/**\n * 替换git的远程推送源地址，这里暂定origin名称为固定的\n */\nexport const setGitSource = (dir: string, url: string) => {\n  // 仓库所在文件地址\n  const dirPath = path.join(process.cwd(), dir);\n  // 先删除在执行\n  const shellStr = `git remote set-url origin ${url}`;\n  execSync(shellStr, { cwd: dirPath });\n};\n\n/**\n * 根据github的url返回对应的文件夹名称\n * https://github.com.cnpmjs.org/bosens-China/github-clone会返回github-clone\n *\n */\nexport const getDir = (url: string) => {\n  const str = url;\n  const dir = str.split('/').pop() || '';\n  return dir.includes('.git') ? dir.slice(0, dir.indexOf('.git')) : dir;\n};\n\n/* 是否为支持的git clone拉取格式\n * https://github.com/bosens-China/breeze-cli\n * https://github.com/bosens-China/breeze-cli.git\n * git@github.com:bosens-China/breeze-cli.git\n */\nexport const isGithubLink = (url: string) => {\n  const reg = /^(https:\\/\\/github\\.com\\/|git@github\\.com:)[\\s\\S]+\\/[\\s\\S]+(\\.git)?$/;\n  return !!reg.exec(url);\n};\n\n/**\n * 将当前的网站替换成镜像网站，例如\n * https://github.com/bosens-China/github-clone会被替换成\n * https://github.com.cnpmjs.org/bosens-China/github-clone\n */\n\nexport const replaceMirror = (currentWebsite: string, replaceWebsite: string) => {\n  let s = currentWebsite;\n  // 这里处理一下以git@开头的情况，如果git@开头，把用户名和仓库提取出来，用https的形式拉取\n  // https://github.com/bosens-China/breeze-cli.git\n  // git@github.com:bosens-China/breeze-cli.git\n  if (s.startsWith('git@')) {\n    const [, name, warehouse] = s.match(/^git@github\\.com:([\\s\\S]+)\\/([\\s\\S]+)\\.git$/) || [];\n    s = `https://github.com/${name}/${warehouse}.git`;\n  }\n  if (!s.endsWith('.git')) {\n    s += '.git';\n  }\n  s = s.replace('github.com', replaceWebsite);\n  return s;\n};\n"],"names":["dir","os","homedir","configPath","path","join","DEFAULTPATH","getAddress","fs","existsSync","readFileSync","program","Command","version","command","description","option","action","url","branch","GitClone","mirrorAddress","directory","split","pop","includes","slice","indexOf","getDir","currentWebsite","replaceWebsite","s","startsWith","name","warehouse","match","endsWith","replace","replaceMirror","dirPath","process","cwd","shellStr","execSync","setGitSource","e","console","error","Error","message","pathUrl","address","writeFileSync","log","parse","argv"],"mappings":";qPAIA,MAAMA,EAAMC,UAAGC,UACTC,EAAaC,UAAKC,KAAKL,EAAK,aAGrBM,EAAc,wBAMdC,EAAa,IACnBC,UAAGC,WAAWN,IAGZK,UAAGE,aAAaP,EAAY,UAF1BG,ECRLK,EAAU,IAAIC,UACpBD,EAAQE,gBAAiB,gBAAiB,WAE1CF,EACGG,QAAQ,2BACRC,YAAY,eACZC,OAAO,uBAAwB,UAC/BC,QAAO,CAACC,EAAKlB,GAAOmB,OAAAA,GAAW,MAC9B,IAEEC,UAASF,EAAK,CAAElB,IAAAA,EAAKmB,OAAAA,EAAQE,cAAed,MAE5C,MAAMe,EAAYtB,GCDF,CAACkB,IACrB,MACMlB,EADMkB,EACIK,MAAM,KAAKC,OAAS,GACpC,OAAOxB,EAAIyB,SAAS,QAAUzB,EAAI0B,MAAM,EAAG1B,EAAI2B,QAAQ,SAAW3B,GDFrC4B,CAAOrB,ICqBT,EAACsB,EAAwBC,KACpD,IAAIC,EAAIF,EAIR,GAAIE,EAAEC,WAAW,QAAS,CACxB,OAASC,EAAMC,GAAaH,EAAEI,MAAM,gDAAkD,GACtFJ,EAAI,sBAAsBE,KAAQC,QAMpC,OAJKH,EAAEK,SAAS,UACdL,GAAK,QAEPA,EAAIA,EAAEM,QAAQ,aAAcP,GACrBC,GDlC4CO,CAAcpB,EAAKX,KAAgBW,GCd5D,EAAClB,EAAakB,KAExC,MAAMqB,EAAUnC,UAAKC,KAAKmC,QAAQC,MAAOzC,GAEnC0C,EAAW,6BAA6BxB,IAC9CyB,WAASD,EAAU,CAAED,IAAKF,KDUtBK,CAAatB,EAAWJ,GACxB,MAAO2B,GACPC,QAAQC,MAAM,GAAGF,aAAaG,MAAQH,EAAEI,QAAUJ,SAIxDlC,EACGG,QAAQ,cACRC,YAAY,sCAAsCT,KAClDW,QAAO,CAACiC,EAAU5C,KACjB,IDNuB6C,ECOVD,EDNf1C,UAAG4C,cAAcjD,EAAYgD,GCOzBL,QAAQO,IAAI,OAAOH,OACnB,SACAJ,QAAQC,MAAM,kBDVM,IAACI,KCa3BxC,EACGG,QAAQ,cACRC,YAAY,eACZE,QAAO,KACN,MAAMb,EAAOG,IACbuC,QAAQO,IAAI,WAAWjD,QAE3BO,EAAQ2C,MAAMd,QAAQe"}

package/dist/src/config.d.ts

@@ -0,0 +1,11 @@
+export declare const DEFAULTPATH = "github.com.cnpmjs.org";
+/**
+ * 读取配置
+ *
+ */
+export declare const getAddress: () => string;
+/**
+ * 设置配置
+ *
+ */
+export declare const setAddress: (address: string) => void;

package/dist/src/gitClone.d.ts

@@ -0,0 +1,8 @@
+interface Options {
+    dir: string;
+    branch: string;
+    mirrorAddress: string;
+    silence: boolean;
+}
+declare const clone: (url: string, options: Partial<Options>) => void;
+export default clone;

package/dist/src/main.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/src/utils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 替换git的远程推送源地址，这里暂定origin名称为固定的
+ */
+export declare const setGitSource: (dir: string, url: string) => void;
+/**
+ * 根据github的url返回对应的文件夹名称
+ * https://github.com.cnpmjs.org/bosens-China/github-clone会返回github-clone
+ *
+ */
+export declare const getDir: (url: string) => string;
+export declare const isGithubLink: (url: string) => boolean;
+/**
+ * 将当前的网站替换成镜像网站，例如
+ * https://github.com/bosens-China/github-clone会被替换成
+ * https://github.com.cnpmjs.org/bosens-China/github-clone
+ */
+export declare const replaceMirror: (currentWebsite: string, replaceWebsite: string) => string;

package/package.json

@@ -1,49 +1,24 @@
 {
   "name": "@boses/github-clone",
-  "version": "1.0.9",
-  "main": "dist/src/main.js",
+  "version": "1.1.3",
+  "main": "./dist/gitClone.js",
+  "module": "./dist/gitClone.esm.js",
   "license": "MIT",
-  "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@babel/preset-typescript": "^7.12.7",
-    "@types/jest": "^26.0.20",
-    "@types/node": "^14.14.22",
-    "@typescript-eslint/eslint-plugin": "^4.14.0",
-    "@typescript-eslint/parser": "^4.14.0",
-    "babel-jest": "^26.6.3",
-    "eslint": "^7.18.0",
-    "eslint-config-alloy": "^3.10.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "jest": "^26.6.3",
-    "prettier": "^2.2.1",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.1.3"
-  },
-  "scripts": {
-    "build": "tsc",
-    "build-watch": "tsc && tsc -w",
-    "test": "jest"
-  },
-  "dependencies": {
-    "commander": "^7.0.0"
-  },
   "bin": {
-    "g": "dist/src/main.js"
+    "g": "./dist/main.js"
   },
+  "types": "./dist/src/gitClone.d.ts",
   "engines": {
     "node": ">=10.6.0"
   },
   "files": [
-    "/dist",
-    "src/*.js",
-    "*.md"
+    "/dist"
   ],
   "author": {
     "name": "boses",
     "email": "yangboses@gmail.com"
   },
-  "description": "工程化解决 Github clone 速度慢的工具",
+  "description": "解决国内 Github clone 速度慢的工具",
   "keywords": [
     "git",
     "github",
@@ -53,5 +28,62 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/bosens-China/github-clone"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.15.8",
+    "@babel/plugin-transform-runtime": "^7.16.0",
+    "@babel/preset-env": "^7.15.8",
+    "@babel/preset-typescript": "^7.15.0",
+    "@rollup/plugin-babel": "^5.3.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.6",
+    "@types/babel__core": "^7.1.16",
+    "@types/fs-extra": "^9.0.13",
+    "@types/jest": "^27.0.2",
+    "@types/node": "^16.11.6",
+    "@typescript-eslint/eslint-plugin": "^5.2.0",
+    "@typescript-eslint/parser": "^5.2.0",
+    "babel-jest": "^27.3.1",
+    "commitizen": "^4.2.4",
+    "cz-conventional-changelog": "3.3.0",
+    "eslint": "^8.1.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^5.1.1",
+    "fs-extra": "^10.0.0",
+    "jest": "^27.3.1",
+    "prettier": "^2.4.1",
+    "rollup": "^2.58.3",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-preserve-shebangs": "^0.2.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.30.0",
+    "ts-node": "^10.4.0",
+    "ts-node-dev": "^1.1.8",
+    "tsconfig-paths": "^3.11.0",
+    "tslib": "^2.3.1",
+    "typescript": "^4.4.4"
+  },
+  "dependencies": {
+    "commander": "^7.0.0"
+  },
+  "scripts": {
+    "lint": "eslint --ext .js,.ts src",
+    "fix": "eslint --fix --ext .js,.ts src",
+    "format": "prettier --write src",
+    "commit": "cz",
+    "dev": "tsnd --respawn main.ts",
+    "test": "jest",
+    "build": "rollup --config ./script/rollup.config.js",
+    "build-watch": "rollup --config ./script/rollup.config.js --watch"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }

package/dist/package.json

@@ -1,57 +0,0 @@
-{
-    "name": "@boses/github-clone",
-    "version": "1.0.9",
-    "main": "dist/src/main.js",
-    "license": "MIT",
-    "devDependencies": {
-        "@babel/core": "^7.12.10",
-        "@babel/preset-env": "^7.12.11",
-        "@babel/preset-typescript": "^7.12.7",
-        "@types/jest": "^26.0.20",
-        "@types/node": "^14.14.22",
-        "@typescript-eslint/eslint-plugin": "^4.14.0",
-        "@typescript-eslint/parser": "^4.14.0",
-        "babel-jest": "^26.6.3",
-        "eslint": "^7.18.0",
-        "eslint-config-alloy": "^3.10.0",
-        "eslint-plugin-prettier": "^3.3.1",
-        "jest": "^26.6.3",
-        "prettier": "^2.2.1",
-        "ts-node": "^9.1.1",
-        "typescript": "^4.1.3"
-    },
-    "scripts": {
-        "build": "tsc",
-        "build-watch": "tsc && tsc -w",
-        "test": "jest"
-    },
-    "dependencies": {
-        "commander": "^7.0.0"
-    },
-    "bin": {
-        "g": "dist/src/main.js"
-    },
-    "engines": {
-        "node": ">=10.6.0"
-    },
-    "files": [
-        "/dist",
-        "src/*.js",
-        "*.md"
-    ],
-    "author": {
-        "name": "boses",
-        "email": "yangboses@gmail.com"
-    },
-    "description": "工程化解决 Github clone 速度慢的工具",
-    "keywords": [
-        "git",
-        "github",
-        "clone",
-        "typescript"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/bosens-China/github-clone"
-    }
-}

package/dist/src/config.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfig = exports.setConfig = exports.DEFAULTPATH = void 0;
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const fs_1 = require("../src/fs");
-exports.DEFAULTPATH = 'github.com.cnpmjs.org';
-const dir = os_1.default.homedir();
-const configPath = path_1.default.join(dir, '.g.config.json');
-async function setConfig(config) {
-    return fs_1.setJsonFile(configPath, config);
-}
-exports.setConfig = setConfig;
-async function getConfig() {
-    const config = await fs_1.getJsonFile(configPath);
-    return (config || { path: exports.DEFAULTPATH });
-}
-exports.getConfig = getConfig;
-//# sourceMappingURL=config.js.map

package/dist/src/fs.js

@@ -1,59 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsonFile = exports.setJsonFile = exports.writeFile = exports.readFile = exports.access = void 0;
-const fs_1 = __importDefault(require("fs"));
-function access(file) {
-    return new Promise((resolve) => {
-        fs_1.default.access(file, fs_1.default.constants.R_OK | fs_1.default.constants.W_OK, (err) => {
-            if (err) {
-                return resolve(false);
-            }
-            return resolve(true);
-        });
-    });
-}
-exports.access = access;
-function readFile(file) {
-    return new Promise((resolve, reject) => {
-        fs_1.default.readFile(file, 'utf-8', (err, data) => {
-            if (err) {
-                return reject(err);
-            }
-            return resolve(data);
-        });
-    });
-}
-exports.readFile = readFile;
-function writeFile(file, content) {
-    return new Promise((resolve, reject) => {
-        fs_1.default.writeFile(file, content, 'utf-8', (err) => {
-            if (err) {
-                return reject(err);
-            }
-            return resolve(content);
-        });
-    });
-}
-exports.writeFile = writeFile;
-function setJsonFile(file, data, indent = 2) {
-    const obj = JSON.stringify(data, null, indent);
-    return writeFile(file, obj);
-}
-exports.setJsonFile = setJsonFile;
-async function getJsonFile(file) {
-    if (!(await access(file))) {
-        return undefined;
-    }
-    const obj = await readFile(file);
-    try {
-        return JSON.parse(obj);
-    }
-    catch (e) {
-        return undefined;
-    }
-}
-exports.getJsonFile = getJsonFile;
-//# sourceMappingURL=fs.js.map

package/dist/src/main.js

@@ -1,55 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const package_json_1 = require("../package.json");
-const utils_1 = require("./utils");
-const config_1 = require("./config");
-const program = new commander_1.Command();
-program.version(package_json_1.version, '-v, --version', '输出当前版本号');
-program
-    .command('clone <url> [warehouse]')
-    .description('根据url拉取指定仓库')
-    .option('-b, --branch <value>', '拉取指定分支')
-    .action(async (url, warehouse, { branch } = {}) => {
-    if (!utils_1.isGithubLink(url)) {
-        return utils_1.error(`${url} 不是一个有效的链接，目前只支持github的shh和https仓库链接!`);
-    }
-    if (!(await utils_1.existenceGit())) {
-        return utils_1.error(`git不存在，请安装git之后在进行操作: https://git-scm.com/`);
-    }
-    const config = await config_1.getConfig();
-    const replaceStr = utils_1.githubReplace(url, config.path);
-    const str = `git clone ${replaceStr}${warehouse ? ` ${warehouse}` : ''}${branch ? ` --branch ${branch}` : ''}`;
-    try {
-        await utils_1.cloneGie(str);
-    }
-    catch (e) {
-        return utils_1.error();
-    }
-    const dir = warehouse || utils_1.gitDir(replaceStr);
-    await utils_1.setGitSource(dir, url);
-    process.exit(0);
-});
-program
-    .command('set [path]')
-    .description(`修改github的镜像仓库地址,<path>可选，如果省略，默认为: ${config_1.DEFAULTPATH}`)
-    .action(async (pathUrl = config_1.DEFAULTPATH) => {
-    try {
-        await config_1.setConfig({ path: pathUrl });
-        process.exit(0);
-    }
-    catch (e) {
-        utils_1.error('set path失败');
-    }
-});
-program
-    .command('get [path]')
-    .description(`读取当前的默认镜像地址`)
-    .action(async () => {
-    const config = await config_1.getConfig();
-    console.log(`当前镜像地址为：${config.path}`);
-    process.exit(0);
-});
-program.parse(process.argv);
-//# sourceMappingURL=main.js.map

package/dist/src/utils.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGitSource = exports.gitDir = exports.githubReplace = exports.cloneGie = exports.existenceGit = exports.shell = exports.error = exports.isGithubLink = void 0;
-const child_process_1 = require("child_process");
-const path_1 = __importDefault(require("path"));
-function isGithubLink(url) {
-    const reg = /^(https:\/\/github\.com\/|git@github\.com:)[\s\S]+\/[\s\S]+(\.git)?$/;
-    return !!reg.exec(url);
-}
-exports.isGithubLink = isGithubLink;
-function error(name) {
-    if (name) {
-        console.error(name);
-    }
-    process.exit(1);
-}
-exports.error = error;
-function shell(shellStr, option) {
-    return new Promise((resolve, reject) => {
-        child_process_1.exec(shellStr, option, (err, data) => {
-            if (err) {
-                return reject(err);
-            }
-            return resolve(data);
-        });
-    });
-}
-exports.shell = shell;
-function existenceGit() {
-    return shell('git --version')
-        .then(() => true)
-        .catch(() => false);
-}
-exports.existenceGit = existenceGit;
-function cloneGie(shellStr) {
-    return new Promise((resolve, reject) => {
-        const args = shellStr.split(' ');
-        const name = args.shift() || '';
-        const git = child_process_1.spawn(name, args, { stdio: 'inherit' });
-        git.on('close', (code) => {
-            if (code !== 0) {
-                return reject(new Error(`code状态码为${code}`));
-            }
-            return resolve(code);
-        });
-        git.on('error', (err) => {
-            return reject(err);
-        });
-    });
-}
-exports.cloneGie = cloneGie;
-function githubReplace(url, replaceStr) {
-    let s = url;
-    if (s.startsWith('git@')) {
-        const [, name, warehouse] = s.match(/^git@github\.com:([\s\S]+)\/([\s\S]+)\.git$/) || [];
-        s = `https://github.com/${name}/${warehouse}.git`;
-    }
-    if (!s.endsWith('.git')) {
-        s += '.git';
-    }
-    s = s.replace('github.com', replaceStr);
-    return s;
-}
-exports.githubReplace = githubReplace;
-function gitDir(str) {
-    const dir = str.split('/').pop() || '';
-    return dir.includes('.git') ? dir.slice(0, dir.indexOf('.git')) : dir;
-}
-exports.gitDir = gitDir;
-function setGitSource(dir, url) {
-    const originUrl = url.endsWith('.git') ? url : `${url}.git`;
-    const dirPath = path_1.default.join(process.cwd(), dir);
-    const shellStr = `git remote set-url origin ${originUrl}`;
-    return shell(shellStr, { cwd: dirPath });
-}
-exports.setGitSource = setGitSource;
-//# sourceMappingURL=utils.js.map