@soybeanjs/cli 0.5.6 → 0.5.8

package/README.md

@@ -20,37 +20,38 @@ pnpm soy -h
 
 ## 命令介绍
 
-| 命令              | 作用                                                               |
-| ----------------- | ------------------------------------------------------------------ |
-| help              | 查看全部命令用法                                                   |
-| git-commit        | 生成符合 Angular 规范的 git 提交信息                               |
-| git-commit-verify | 校验 git 的提交信息是否符合 Angular 规范                           |
-| cleanup           | 清空依赖和构建产物                                                 |
-| init-git-hooks    | 初始化 simple-git-hooks 钩子                                       |
-| update-pkg        | 升级依赖                                                           |
-| prettier-format   | prettier 格式化                                                    |
-| lint-staged       | 执行 lint-staged                                                   |
-| changelog         | 根据两次 tag 生成 changelog (--total: 根据所有 tag 生成 changelog) |
-| release           | 发布：更新版本号、生成 changelog、提交代码                         |
-
-### prettier-format
-
-底层调用 prettier --write 达到格式化文件的目的
-
-默认忽略的格式化文件夹货文件：
-
-- js,jsx,mjs,cjs,json,ts,tsx,mts,cts,vue,svelte,astro (通过 eslint 去格式化)
-- node_modules
-- _.min._
-- CHANGELOG.md
-- dist
-- LICENSE\*
-- output
-- coverage
-- public
-- temp
-- package-lock.json
-- pnpm-lock.yaml
-- yarn.lock
-- .github
-- **snapshots**
+| 命令                  | 作用                                                               |
+| --------------------- | ------------------------------------------------------------------ |
+| help(-h)              | 查看全部命令用法                                                   |
+| git-commit            | 生成符合 Angular 规范的 git 提交信息                               |
+| git-commit-verify     | 校验 git 的提交信息是否符合 Angular 规范                           |
+| cleanup               | 清空依赖和构建产物                                                 |
+| init-simple-git-hooks | 初始化 simple-git-hooks 钩子                                       |
+| ncu                   | 命令 npm-check-updates, 升级依赖                                   |
+| prettier-write        | 执行 prettier --write 格式化                                       |
+| lint-staged           | 执行 lint-staged                                                   |
+| changelog             | 根据两次 tag 生成 changelog (--total: 根据所有 tag 生成 changelog) |
+| release               | 发布：更新版本号、生成 changelog、提交代码                         |
+| init-git-hooks        | 该命令已废弃，请使用 init-simple-git-hooks                         |
+| update-pkg            | 该命令已废弃，请使用 ncu                                           |
+| prettier-format       | 该命令已废弃，请使用 prettier-write                                |
+| eslint-prettier       | 该命令已废弃                                                       |
+
+## 更多自定义配置
+
+- 在项目根目录新建 soybean-config.ts
+
+- 导入 defineConfig 函数
+
+  ```ts
+  import { defineConfig } from "@soybeanjs/cli";
+
+  export default defineConfig({
+    //options
+  });
+  ```
+
+- 配置参考
+  ```ts
+  import type { CliOption } from "@soybeanjs/cli";
+  ```

package/dist/index.cjs

@@ -3,6 +3,7 @@
 
 const cac = require('cac');
 const enquirer = require('enquirer');
+const path = require('path');
 const fs = require('fs');
 const kolorist = require('kolorist');
 const rimraf = require('rimraf');
@@ -14,9 +15,10 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 const cac__default = /*#__PURE__*/_interopDefaultCompat(cac);
 const enquirer__default = /*#__PURE__*/_interopDefaultCompat(enquirer);
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
 const versionBump__default = /*#__PURE__*/_interopDefaultCompat(versionBump);
 
-const version = "0.5.6";
+const version = "0.5.8";
 
 async function execCommand(cmd, args, options) {
   const { execa } = await import('execa');
@@ -60,8 +62,9 @@ async function gitCommit(gitCommitTypes, gitCommitScopes) {
   execCommand("git", ["commit", "-m", commitMsg], { stdio: "inherit" });
 }
 
-function gitCommitVerify(cwd = process.cwd()) {
-  const gitMsgPath = `${cwd}/.git/COMMIT_EDITMSG`;
+async function gitCommitVerify() {
+  const gitPath = await execCommand("git", ["rev-parse", "--show-toplevel"]);
+  const gitMsgPath = path__default.join(gitPath, ".git/COMMIT_EDITMSG");
   const commitMsg = fs.readFileSync(gitMsgPath, "utf-8").trim();
   const REG_EXP = /(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
   if (!REG_EXP.test(commitMsg)) {
@@ -78,13 +81,14 @@ async function cleanup(paths) {
 }
 
 async function initSimpleGitHooks(cwd = process.cwd()) {
-  const huskyDir = `${cwd}/.husky`;
+  const huskyDir = path__default.join(cwd, ".husky");
   const existHusky = fs.existsSync(huskyDir);
+  const gitHooksDir = path__default.join(cwd, ".git/hooks");
   if (existHusky) {
     await rimraf.rimraf(huskyDir);
-    await execCommand("git", ["config", "core.hooksPath", `${cwd}/.git/hooks/`], { stdio: "inherit" });
+    await execCommand("git", ["config", "core.hooksPath", gitHooksDir], { stdio: "inherit" });
   }
-  await rimraf.rimraf(`${cwd}/.git/hooks`);
+  await rimraf.rimraf(gitHooksDir);
   await execCommand("npx", ["simple-git-hooks"], { stdio: "inherit" });
 }
 
@@ -190,18 +194,23 @@ const defaultOptions = {
   lintStagedConfig: {
     [eslintExt]: "eslint --fix",
     "*": "soy prettier-write"
-  }
+  },
+  useSoybeanToken: false
 };
+const SOYBEAN_GITHUB_TOKEN = "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";
 async function loadCliOptions(overrides, cwd = process.cwd()) {
   const { config } = await c12.loadConfig({
     name: "soybean",
     defaults: defaultOptions,
     overrides,
-    cwd
+    cwd,
+    packageJson: true
   });
+  if (config?.useSoybeanToken) {
+    config.changelogOptions = { ...config.changelogOptions, github: { repo: "", token: SOYBEAN_GITHUB_TOKEN } };
+  }
   return config;
 }
-const SOYBEAN_GITHUB_TOKEN = "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";
 
 async function setupCli() {
   const cliOptions = await loadCliOptions();
@@ -217,7 +226,7 @@ async function setupCli() {
     "git-commit-verify": {
       desc: "\u6821\u9A8C git \u7684 commit \u662F\u5426\u7B26\u5408 Angular \u89C4\u8303",
       action: () => {
-        gitCommitVerify(cliOptions.cwd);
+        gitCommitVerify();
       }
     },
     cleanup: {
@@ -246,12 +255,11 @@ async function setupCli() {
     },
     "lint-staged": {
       desc: "\u6267\u884Clint-staged",
-      action: () => {
-        execLintStaged(cliOptions.lintStagedConfig).then((passed) => {
-          process.exitCode = passed ? 0 : 1;
-        }).catch(() => {
+      action: async () => {
+        const passed = await execLintStaged(cliOptions.lintStagedConfig).catch(() => {
           process.exitCode = 1;
         });
+        process.exitCode = passed ? 0 : 1;
       }
     },
     changelog: {
@@ -299,9 +307,9 @@ async function setupCli() {
       action: eslintPretter
     }
   };
-  Object.entries(commands).forEach(([command, { desc, action }]) => {
+  for await (const [command, { desc, action }] of Object.entries(commands)) {
     cli.command(command, desc).action(action);
-  });
+  }
   cli.parse();
 }
 setupCli();
@@ -309,5 +317,4 @@ function defineConfig(config) {
   return config;
 }
 
-exports.SOYBEAN_GITHUB_TOKEN = SOYBEAN_GITHUB_TOKEN;
 exports.defineConfig = defineConfig;

package/dist/index.d.ts

@@ -41,10 +41,12 @@ interface CliOption {
      * lint-staged config
      */
     lintStagedConfig: Record<string, string | string[]>;
+    /**
+     * use soybean token
+     */
+    useSoybeanToken: boolean;
 }
 
-declare const SOYBEAN_GITHUB_TOKEN = "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";
-
 declare function defineConfig(config?: Partial<CliOption>): Partial<CliOption> | undefined;
 
-export { CliOption, SOYBEAN_GITHUB_TOKEN, defineConfig };
+export { CliOption, defineConfig };

package/dist/index.mjs

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import cac from 'cac';
 import enquirer from 'enquirer';
+import path from 'path';
 import { readFileSync, existsSync } from 'fs';
 import { bgRed, red, green } from 'kolorist';
 import { rimraf } from 'rimraf';
@@ -8,7 +9,7 @@ import { generateTotalChangelog, generateChangelog } from '@soybeanjs/changelog'
 import versionBump from 'bumpp';
 import { loadConfig } from 'c12';
 
-const version = "0.5.6";
+const version = "0.5.8";
 
 async function execCommand(cmd, args, options) {
   const { execa } = await import('execa');
@@ -52,8 +53,9 @@ async function gitCommit(gitCommitTypes, gitCommitScopes) {
   execCommand("git", ["commit", "-m", commitMsg], { stdio: "inherit" });
 }
 
-function gitCommitVerify(cwd = process.cwd()) {
-  const gitMsgPath = `${cwd}/.git/COMMIT_EDITMSG`;
+async function gitCommitVerify() {
+  const gitPath = await execCommand("git", ["rev-parse", "--show-toplevel"]);
+  const gitMsgPath = path.join(gitPath, ".git/COMMIT_EDITMSG");
   const commitMsg = readFileSync(gitMsgPath, "utf-8").trim();
   const REG_EXP = /(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
   if (!REG_EXP.test(commitMsg)) {
@@ -70,13 +72,14 @@ async function cleanup(paths) {
 }
 
 async function initSimpleGitHooks(cwd = process.cwd()) {
-  const huskyDir = `${cwd}/.husky`;
+  const huskyDir = path.join(cwd, ".husky");
   const existHusky = existsSync(huskyDir);
+  const gitHooksDir = path.join(cwd, ".git/hooks");
   if (existHusky) {
     await rimraf(huskyDir);
-    await execCommand("git", ["config", "core.hooksPath", `${cwd}/.git/hooks/`], { stdio: "inherit" });
+    await execCommand("git", ["config", "core.hooksPath", gitHooksDir], { stdio: "inherit" });
   }
-  await rimraf(`${cwd}/.git/hooks`);
+  await rimraf(gitHooksDir);
   await execCommand("npx", ["simple-git-hooks"], { stdio: "inherit" });
 }
 
@@ -182,18 +185,23 @@ const defaultOptions = {
   lintStagedConfig: {
     [eslintExt]: "eslint --fix",
     "*": "soy prettier-write"
-  }
+  },
+  useSoybeanToken: false
 };
+const SOYBEAN_GITHUB_TOKEN = "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";
 async function loadCliOptions(overrides, cwd = process.cwd()) {
   const { config } = await loadConfig({
     name: "soybean",
     defaults: defaultOptions,
     overrides,
-    cwd
+    cwd,
+    packageJson: true
   });
+  if (config?.useSoybeanToken) {
+    config.changelogOptions = { ...config.changelogOptions, github: { repo: "", token: SOYBEAN_GITHUB_TOKEN } };
+  }
   return config;
 }
-const SOYBEAN_GITHUB_TOKEN = "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";
 
 async function setupCli() {
   const cliOptions = await loadCliOptions();
@@ -209,7 +217,7 @@ async function setupCli() {
     "git-commit-verify": {
       desc: "\u6821\u9A8C git \u7684 commit \u662F\u5426\u7B26\u5408 Angular \u89C4\u8303",
       action: () => {
-        gitCommitVerify(cliOptions.cwd);
+        gitCommitVerify();
       }
     },
     cleanup: {
@@ -238,12 +246,11 @@ async function setupCli() {
     },
     "lint-staged": {
       desc: "\u6267\u884Clint-staged",
-      action: () => {
-        execLintStaged(cliOptions.lintStagedConfig).then((passed) => {
-          process.exitCode = passed ? 0 : 1;
-        }).catch(() => {
+      action: async () => {
+        const passed = await execLintStaged(cliOptions.lintStagedConfig).catch(() => {
           process.exitCode = 1;
         });
+        process.exitCode = passed ? 0 : 1;
       }
     },
     changelog: {
@@ -291,9 +298,9 @@ async function setupCli() {
       action: eslintPretter
     }
   };
-  Object.entries(commands).forEach(([command, { desc, action }]) => {
+  for await (const [command, { desc, action }] of Object.entries(commands)) {
     cli.command(command, desc).action(action);
-  });
+  }
   cli.parse();
 }
 setupCli();
@@ -301,4 +308,4 @@ function defineConfig(config) {
   return config;
 }
 
-export { SOYBEAN_GITHUB_TOKEN, defineConfig };
+export { defineConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soybeanjs/cli",
-  "version": "0.5.6",
+  "version": "0.5.8",
   "description": "SoybeanJS's command line tools",
   "author": {
     "name": "Soybean",
@@ -25,6 +25,9 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "bin": {
     "soybean": "dist/index.cjs",
     "soy": "dist/index.cjs"
@@ -59,6 +62,9 @@
     "commit-msg": "pnpm soy git-commit-verify",
     "pre-commit": "pnpm typecheck && pnpm soy lint-staged"
   },
+  "soybean": {
+    "useSoybeanToken": true
+  },
   "scripts": {
     "build": "pnpm typecheck && unbuild",
     "lint": "eslint . --fix",