@bratel/dgit 0.0.13 → 0.0.14

package/.github/workflows/nodejs.yml

@@ -4,13 +4,13 @@ on: [push]
 
 jobs:
   build:
-    if: startsWith(github.ref_name, 'v')
+    # if: startsWith(github.ref_name, 'v')
     permissions:
       pull-requests: write # for writing comments
       issues: write # for writing comments
       contents: write # for creating a release
-      id-token: write  # Required for OIDC
- 
+      id-token: write # Required for OIDC
+
     runs-on: ubuntu-latest
 
     strategy:
@@ -37,20 +37,20 @@ jobs:
           npm run test:mocha
         env:
           CI: true
-      - name: check auth
-        run: |
-          cat .npmrc || echo "pass"
-          cat ~/.npmrc || echo "pass"
-          echo "=== npm config list ==="
-          npm config list
-          cat /home/runner/work/_temp/.npmrc || echo "pass"
-          cp /home/runner/work/_temp/.npmrc x-npmrc || echo "pass"
-          # ls -la "$(npm config get prefix)/etc/npmrc" 2>/dev/null || echo "Not found"
-      - name: Upload npmrc
-        uses: actions/upload-artifact@v4
-        with:
-          name: 'npmrc'
-          path: 'x-npmrc'
+      # - name: check auth
+      #   run: |
+      #     cat .npmrc || echo "pass"
+      #     cat ~/.npmrc || echo "pass"
+      #     echo "=== npm config list ==="
+      #     npm config list
+      #     cat /home/runner/work/_temp/.npmrc || echo "pass"
+      #     cp /home/runner/work/_temp/.npmrc x-npmrc || echo "pass"
+      #     # ls -la "$(npm config get prefix)/etc/npmrc" 2>/dev/null || echo "Not found"
+      # - name: Upload npmrc
+      #   uses: actions/upload-artifact@v4
+      #   with:
+      #     name: 'npmrc'
+      #     path: 'x-npmrc'
       - name: Publish
         if: startsWith(github.ref_name, 'v')
         run: |

package/README.en_US.md

@@ -52,20 +52,19 @@ $ dgit d https://github.com/JohnApache/hasaki-cli/tree/master/src -d ./abc
 import dgit from '@bratel/dgit';
 
 (async () => {
-    await dgit(
-        {
-            owner: 'JohnApache',
-            repoName: 'hasaki-cli',
-            ref: 'master',
-            relativePath: 'src',
-        },
-        './aaa',
-    );
-    console.log('download succeed');
-})()
+  await dgit(
+    {
+      owner: 'JohnApache',
+      repoName: 'hasaki-cli',
+      ref: 'master',
+      relativePath: 'src',
+    },
+    './aaa',
+  );
+  console.log('download succeed');
+})();
 ```
 
-
 ## Configuration
 + Global installation, used as command line, configurable parameters
      - Commands:
@@ -84,18 +83,18 @@ import dgit from '@bratel/dgit';
         * -i --include, <relativePath,...,relativePath>  Specifies the collection of files or directories that need to be included again in the currently excluded file path collection.
         * -h, --help                      Output usage information
 
-+ Local installation, configurable parameters when used as a module   
++ Local installation, configurable parameters when used as a module
     ```js
     import dgit from '@bratel/dgit';
     import path from 'path';
     const repoOption = {
-        owner: 'JohnApache'; // Git repository author name
-        repoName: 'hasaki-cli'; // Git repo name
+        owner: 'JohnApache', // Git repository author name
+        repoName: 'hasaki-cli', // Git repo name
         ref: 'master'; // Git repo branch，commit hash or tagname，
-        relativePath: '.'; // Specifies the relative location of the directory or file that git needs to download
-        username: ''; // Specify git account name.
-        password: ''; // Specify the git account password.
-        token: ''; // Git token is another configurable parameter of login mode.
+        relativePath: '.', // Specifies the relative location of the directory or file that git needs to download
+        username: '', // Specify git account name.
+        password: '', // Specify the git account password.
+        token: '', // Git token is another configurable parameter of login mode.
     }
 
     const githubLinkOption = {
@@ -121,7 +120,6 @@ import dgit from '@bratel/dgit';
         onResolved: (status) => void,
     }
 
-
     (async () => {
         await dgit(
             repoOption,
@@ -139,11 +137,11 @@ import dgit from '@bratel/dgit';
         );
         console.log('githubLinkOption download succeed.');
     })()
-    ``` 
+    ```
 
 ## TIPS
 When downloading the private repo, you need to provide download permission. At this time, you need to pass in additional parameters in two ways
-+ Basic authentication 
++ Basic authentication
 
     Download permission is provided by passing in user name and password. When passing in user name, password can not be provided explicitly. When password is not provided, password input option will appear password prompt;
     ```bash

package/README.md

@@ -1,5 +1,5 @@
-# Dgit 
-<!-- 
+# Dgit
+<!--
 [![NPM version][npm-image]][npm-url]
 [![build status][travis-image]][travis-url]
 [![Test coverage][codecov-image]][codecov-url]
@@ -52,17 +52,17 @@ $ dgit d https://github.com/JohnApache/hasaki-cli/tree/master/src -d ./abc
 import dgit from '@bratel/dgit';
 
 (async () => {
-    await dgit(
-        {
-            owner: 'JohnApache',
-            repoName: 'hasaki-cli',
-            ref: 'master',
-            relativePath: 'src',
-        },
-        './aaa',
-    );
-    console.log('download succeed');
-})()
+  await dgit(
+    {
+      owner: 'JohnApache',
+      repoName: 'hasaki-cli',
+      ref: 'master',
+      relativePath: 'src',
+    },
+    './aaa',
+  );
+  console.log('download succeed');
+})();
 ```
 
 ## 配置
@@ -91,13 +91,13 @@ import dgit from '@bratel/dgit';
     import dgit from '@bratel/dgit';
     import path from 'path';
     const repoOption = {
-        owner: 'JohnApache'; // git 仓库作者名
-        repoName: 'hasaki-cli'; // git 仓库名称
-        ref: 'master'; // git 仓库指定 branch，commit 或 tag，
-        relativePath: '.'; // 指定git所需要下载的目录或者文件相对位置
-        username: ''; // 指定git用户名, 在下载私有仓库时需要的配置参数.
-        password: ''; // 指定git密码, 同username 一起使用，在下载私有仓库时需要的配置参数.
-        token: ''; // git token 是另一种登录方式的可配置参数，用于下载私有仓库.
+        owner: 'JohnApache', // git 仓库作者名
+        repoName: 'hasaki-cli', // git 仓库名称
+        ref: 'master', // git 仓库指定 branch，commit 或 tag，
+        relativePath: '.', // 指定git所需要下载的目录或者文件相对位置
+        username: '', // 指定git用户名, 在下载私有仓库时需要的配置参数.
+        password: '', // 指定git密码, 同username 一起使用，在下载私有仓库时需要的配置参数.
+        token: '', // git token 是另一种登录方式的可配置参数，用于下载私有仓库.
     }
 
     const githubLinkOption = {
@@ -122,7 +122,6 @@ import dgit from '@bratel/dgit';
         onResolved: (status) => void,
     }
 
-
     (async () => {
         await dgit(
             repoOption,
@@ -140,10 +139,10 @@ import dgit from '@bratel/dgit';
         );
         console.log('githubLinkOption download succeed.');
     })()
-    ```    
+    ```
 ## 注意
 1. 在下载私有仓库的时候需要提供下载权限，此时需要传入额外的参数，方式有两种
-+ Basic authentication 
++ Basic authentication
 
     通过传入 用户名 和 密码，来提供下载权限, 当传入用户名，可以不显式提供密码，在没有提供密码时，会单独出现密码提示
 
@@ -160,9 +159,9 @@ import dgit from '@bratel/dgit';
     $ dgit d https://github.com/JohnApache/hasaki-cli/tree/master/src -d ./abc -t OAUTH-TOKEN
     ```
 
-2. 下载资源失败 `raw.githubusercontent.com` 连接失败  
-    由于国内访问 `raw.githubusercontent.com` 地址，除了墙以外，大多数还有一种情况就是域名 `dns污染` ，需要查询正确的 ip 地址 
-    - **【查询方案1】**：打开 `https://www.ipaddress.com/` 输入访问不了的域名，查询之后可以获得正确的 IP 地址， 
+2. 下载资源失败 `raw.githubusercontent.com` 连接失败
+    由于国内访问 `raw.githubusercontent.com` 地址，除了墙以外，大多数还有一种情况就是域名 `dns污染` ，需要查询正确的 ip 地址
+    - **【查询方案1】**：打开 `https://www.ipaddress.com/` 输入访问不了的域名，查询之后可以获得正确的 IP 地址，
 
     > Tips: 可能该 ip 因为墙的问题还是访问不了，可以使用下面的方案
     - **【查询方案2】**：打开 `https://site.ip138.com/raw.githubusercontent.com/` ，可以查询到对应国内中国香港的 IP 地址

package/eslint.config.mjs

@@ -0,0 +1,15 @@
+// eslint.config.mjs
+import antfu from '@antfu/eslint-config';
+
+export default antfu({
+  rules: {
+    'no-console': ['error', { allow: ['warn', 'log', 'error'] }],
+  },
+  ignores: ['*.log', 'lib/**', '*.md'],
+  gitignore: true,
+  stylistic: {
+    indent: 2,
+    quotes: 'single',
+    semi: true,
+  },
+});

package/lib/cmd/action.d.ts

@@ -1,4 +1,4 @@
-import { Command } from 'commander';
-import { CommandInfo } from './type';
-declare const DownloadAction: (githubLink: string | undefined, cmd: Command & CommandInfo) => Promise<any>;
+import type { Command } from 'commander';
+import type { CommandInfo } from './type';
+declare function DownloadAction(githubLink: string | undefined, cmd: Command & CommandInfo): Promise<any>;
 export default DownloadAction;

package/lib/cmd/action.js

@@ -4,89 +4,91 @@ const tslib_1 = require("tslib");
 const ora_1 = tslib_1.__importDefault(require("ora"));
 const progress_1 = tslib_1.__importDefault(require("progress"));
 const dgit_1 = tslib_1.__importDefault(require("../dgit"));
-const utils_1 = require("./utils");
 const prompt_1 = require("./prompt");
+const utils_1 = require("./utils");
 const MAX_TEXT_ELLIPSIS = 30;
-const DownloadAction = (githubLink, cmd) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    let { ref = '', dest = '', owner = '', repoName = '', relativePath = '', password, } = cmd;
-    const { exclude = '', include = '', log = false, logPrefix = '[dgit-logger]', } = cmd;
-    const { parallelLimit = '', username, token, } = cmd;
-    const { proxy = '' } = cmd;
-    if (githubLink && utils_1.isHttpsLink(githubLink)) {
-        const parseResult = utils_1.ParseGithubHttpsLink(githubLink);
-        ref = parseResult.ref;
-        owner = parseResult.owner;
-        repoName = parseResult.repoName;
-        relativePath = parseResult.relativePath;
-    }
-    if (username && !password) {
-        const pwdAnswer = yield prompt_1.PasswordPrompt();
-        password = pwdAnswer.password;
-    }
-    const answer = yield prompt_1.DownloadPrompt({
-        ref,
-        dest,
-        owner,
-        repoName,
-        relativePath,
-    });
-    ref = answer.ref;
-    dest = answer.dest;
-    owner = answer.owner;
-    repoName = answer.repoName;
-    relativePath = answer.relativePath;
-    const excludeList = exclude.split(',').filter(Boolean);
-    const includeList = include.split(',').filter(Boolean);
-    const spinner = ora_1.default(' loading remote repo tree...');
-    let bar;
-    try {
-        yield dgit_1.default({
+function DownloadAction(githubLink, cmd) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        let { ref = '', dest = '', owner = '', repoName = '', relativePath = '', password, } = cmd;
+        const { exclude = '', include = '', log = false, logPrefix = '[dgit-logger]', } = cmd;
+        const { parallelLimit = '', username, token, } = cmd;
+        const { proxy = '', } = cmd;
+        if (githubLink && (0, utils_1.isHttpsLink)(githubLink)) {
+            const parseResult = (0, utils_1.ParseGithubHttpsLink)(githubLink);
+            ref = parseResult.ref;
+            owner = parseResult.owner;
+            repoName = parseResult.repoName;
+            relativePath = parseResult.relativePath;
+        }
+        if (username && !password) {
+            const pwdAnswer = yield (0, prompt_1.PasswordPrompt)();
+            password = pwdAnswer.password;
+        }
+        const answer = yield (0, prompt_1.DownloadPrompt)({
             ref,
+            dest,
             owner,
             repoName,
             relativePath,
-            username,
-            password,
-            token,
-            proxy,
-        }, dest, {
-            log,
-            logPrefix,
-            parallelLimit: Number(parallelLimit.trim()),
-            exclude: excludeList,
-            include: includeList,
-        }, {
-            beforeLoadTree() {
-                spinner.start();
-            },
-            afterLoadTree() {
-                spinner.succeed(' load remote repo tree succeed! ');
-            },
-            onResolved(status) {
-                if (log)
-                    return;
-                const green = '\u001b[42m \u001b[0m';
-                const red = '\u001b[41m \u001b[0m';
-                const index = 0;
-                bar = new progress_1.default(' DOWNLOAD |:bar| :current/:total :percent elapsed: :elapseds eta: :eta :file, done.', {
-                    total: status.totalCount,
-                    width: 50,
-                    complete: green,
-                    incomplete: red,
-                });
-                bar.update(index);
-            },
-            onProgress(_, node) {
-                if (log)
-                    return;
-                bar.tick({ file: utils_1.TextEllipsis(node.path, MAX_TEXT_ELLIPSIS) });
-            },
         });
-        spinner.succeed(' download all files succeed!');
-    }
-    catch (error) {
-        console.error(error);
-        spinner.fail(' download files failed!');
-    }
-});
+        ref = answer.ref;
+        dest = answer.dest;
+        owner = answer.owner;
+        repoName = answer.repoName;
+        relativePath = answer.relativePath;
+        const excludeList = exclude.split(',').filter(Boolean);
+        const includeList = include.split(',').filter(Boolean);
+        const spinner = (0, ora_1.default)(' loading remote repo tree...');
+        let bar;
+        try {
+            yield (0, dgit_1.default)({
+                ref,
+                owner,
+                repoName,
+                relativePath,
+                username,
+                password,
+                token,
+                proxy,
+            }, dest, {
+                log,
+                logPrefix,
+                parallelLimit: Number(parallelLimit.trim()),
+                exclude: excludeList,
+                include: includeList,
+            }, {
+                beforeLoadTree() {
+                    spinner.start();
+                },
+                afterLoadTree() {
+                    spinner.succeed(' load remote repo tree succeed! ');
+                },
+                onResolved(status) {
+                    if (log)
+                        return;
+                    const green = '\u001B[42m \u001B[0m';
+                    const red = '\u001B[41m \u001B[0m';
+                    const index = 0;
+                    bar = new progress_1.default(' DOWNLOAD |:bar| :current/:total :percent elapsed: :elapseds eta: :eta :file, done.', {
+                        total: status.totalCount,
+                        width: 50,
+                        complete: green,
+                        incomplete: red,
+                    });
+                    bar.update(index);
+                },
+                onProgress(_, node) {
+                    if (log)
+                        return;
+                    bar.tick({ file: (0, utils_1.TextEllipsis)(node.path, MAX_TEXT_ELLIPSIS) });
+                },
+            });
+            spinner.succeed(' download all files succeed!');
+        }
+        catch (error) {
+            console.error(error);
+            spinner.fail(' download files failed!');
+        }
+    });
+}
 exports.default = DownloadAction;

package/lib/cmd/main.js

@@ -1,20 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const commander_1 = tslib_1.__importDefault(require("commander"));
+const node_process_1 = tslib_1.__importDefault(require("node:process"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const utils_1 = require("./utils");
+const commander_1 = require("commander");
 const action_1 = tslib_1.__importDefault(require("./action"));
+const utils_1 = require("./utils");
 const EXIT_CODE = 1;
-const Exit = () => {
-    process.exit(EXIT_CODE);
-};
-const UnknownCommand = (cmdName) => {
+const program = new commander_1.Command();
+function Exit() {
+    node_process_1.default.exit(EXIT_CODE);
+}
+function UnknownCommand(cmdName) {
     console.log(`${chalk_1.default.red('Unknown command')} ${chalk_1.default.yellow(cmdName)}.`);
-};
-const packageInfo = utils_1.GetPackageInfo();
-commander_1.default.version(packageInfo.version);
-commander_1.default
+}
+const packageInfo = (0, utils_1.GetPackageInfo)();
+program.version(packageInfo.version);
+program
     .command('download [githubLink]')
     .option('--owner <ownerName>', 'git repo author.')
     .option('--repo-name <repoName>', 'git repo name.')
@@ -33,15 +35,15 @@ commander_1.default
     .alias('d')
     .description('download the file with the specified path of the remote repo.')
     .action(action_1.default);
-commander_1.default.on('command:*', (cmdObj = []) => {
+program.on('command:*', (cmdObj = []) => {
     const [cmd] = cmdObj;
     if (cmd) {
-        commander_1.default.outputHelp();
+        program.outputHelp();
         UnknownCommand(cmd);
         Exit();
     }
 });
-if (process.argv.slice(2).length <= 0) {
-    commander_1.default.help();
+if (node_process_1.default.argv.slice(2).length <= 0) {
+    program.help();
 }
-commander_1.default.parse(process.argv);
+program.parse(node_process_1.default.argv);

package/lib/cmd/prompt.d.ts

@@ -1,5 +1,5 @@
-import { Question } from 'inquirer';
-import { DownloadPromptInfo, PasswordPromptInfo } from './type';
+import type { Question } from 'inquirer';
+import type { DownloadPromptInfo, PasswordPromptInfo } from './type';
 export declare const CreatePrompt: (questions: Array<Question>) => Promise<any>;
-export declare const DownloadPrompt: (currentInfo: DownloadPromptInfo) => Promise<DownloadPromptInfo>;
-export declare const PasswordPrompt: () => Promise<PasswordPromptInfo>;
+export declare function DownloadPrompt(currentInfo: DownloadPromptInfo): Promise<DownloadPromptInfo>;
+export declare function PasswordPrompt(): Promise<PasswordPromptInfo>;

package/lib/cmd/prompt.js

@@ -1,86 +1,92 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PasswordPrompt = exports.DownloadPrompt = exports.CreatePrompt = void 0;
+exports.CreatePrompt = void 0;
+exports.DownloadPrompt = DownloadPrompt;
+exports.PasswordPrompt = PasswordPrompt;
 const tslib_1 = require("tslib");
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
-exports.CreatePrompt = (questions) => inquirer_1.default.prompt(questions);
-exports.DownloadPrompt = (currentInfo) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    if (currentInfo.owner &&
-        currentInfo.repoName &&
-        currentInfo.ref &&
-        currentInfo.relativePath &&
-        currentInfo.dest)
-        return currentInfo;
-    const questions = [
-        {
-            type: 'input',
-            name: 'owner',
-            when() {
-                return !currentInfo.owner;
+const CreatePrompt = (questions) => inquirer_1.default.prompt(questions);
+exports.CreatePrompt = CreatePrompt;
+function DownloadPrompt(currentInfo) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (currentInfo.owner
+            && currentInfo.repoName
+            && currentInfo.ref
+            && currentInfo.relativePath
+            && currentInfo.dest) {
+            return currentInfo;
+        }
+        const questions = [
+            {
+                type: 'input',
+                name: 'owner',
+                when() {
+                    return !currentInfo.owner;
+                },
+                validate(input) {
+                    return input && input.length > 0;
+                },
+                message: 'input github ownername.',
             },
-            validate(input) {
-                return input && input.length > 0;
+            {
+                type: 'input',
+                name: 'repoName',
+                when() {
+                    return !currentInfo.repoName;
+                },
+                validate(input) {
+                    return input && input.length > 0;
+                },
+                message: 'input github repoName.',
             },
-            message: 'input github ownername.',
-        },
-        {
-            type: 'input',
-            name: 'repoName',
-            when() {
-                return !currentInfo.repoName;
-            },
-            validate(input) {
-                return input && input.length > 0;
-            },
-            message: 'input github repoName.',
-        },
-        {
-            type: 'input',
-            name: 'ref',
-            when() {
-                return !currentInfo.ref;
-            },
-            validate(input) {
-                return input && input.length > 0;
+            {
+                type: 'input',
+                name: 'ref',
+                when() {
+                    return !currentInfo.ref;
+                },
+                validate(input) {
+                    return input && input.length > 0;
+                },
+                default: 'master',
+                message: 'input github branch or commit hash or tagname.',
             },
-            'default': 'master',
-            message: 'input github branch or commit hash or tagname.',
-        },
-        {
-            type: 'input',
-            name: 'relativePath',
-            when() {
-                return !currentInfo.relativePath;
+            {
+                type: 'input',
+                name: 'relativePath',
+                when() {
+                    return !currentInfo.relativePath;
+                },
+                validate(input) {
+                    return input && input.length > 0;
+                },
+                default: '.',
+                message: 'input github relative path.',
             },
-            validate(input) {
-                return input && input.length > 0;
+            {
+                type: 'input',
+                name: 'dest',
+                when() {
+                    return !currentInfo.dest;
+                },
+                validate(input) {
+                    return input && input.length > 0;
+                },
+                default: '.',
+                message: 'input template output dest path.',
             },
-            'default': '.',
-            message: 'input github relative path.',
-        },
-        {
-            type: 'input',
-            name: 'dest',
-            when() {
-                return !currentInfo.dest;
-            },
-            validate(input) {
-                return input && input.length > 0;
-            },
-            'default': '.',
-            message: 'input template output dest path.',
-        },
-    ];
-    const answer = yield exports.CreatePrompt(questions);
-    return {
-        owner: answer.owner || currentInfo.owner,
-        dest: answer.dest || currentInfo.dest,
-        repoName: answer.repoName || currentInfo.repoName,
-        relativePath: answer.relativePath || currentInfo.relativePath,
-        ref: answer.ref || currentInfo.ref,
-    };
-});
-exports.PasswordPrompt = () => {
+        ];
+        const answer = yield (0, exports.CreatePrompt)(questions);
+        return {
+            owner: answer.owner || currentInfo.owner,
+            dest: answer.dest || currentInfo.dest,
+            repoName: answer.repoName || currentInfo.repoName,
+            relativePath: answer.relativePath || currentInfo.relativePath,
+            ref: answer.ref || currentInfo.ref,
+        };
+    });
+}
+function PasswordPrompt() {
     const question = {
         type: 'password',
         name: 'password',
@@ -89,5 +95,5 @@ exports.PasswordPrompt = () => {
         },
         message: 'input github account password.',
     };
-    return exports.CreatePrompt([question]);
-};
+    return (0, exports.CreatePrompt)([question]);
+}