@deot/dev-commitlint 2.9.8 → 2.9.9

package/README.md

@@ -1,2 +1,14 @@
 # @deot/dev-commitlint
 
+- commit message
+
+```
+dd-commitlint --message [file-path] --message-exclude
+```
+
+- commit file-path (kebabCase: `xxx-xxx-xxx`)
+
+```
+dd-commitlint --file-path [file-path1] [file-path2] --file-path-exclude
+```
+

package/dist/index.cjs

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 const fs = require('node:fs');
+const path = require('node:path');
 
 function _interopNamespaceDefault(e) {
 	const n = Object.create(null, { [Symbol.toStringTag]: { value: 'Module' } });
@@ -22,69 +23,125 @@ function _interopNamespaceDefault(e) {
 }
 
 const fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
+const path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 
 const commitRE = /^(revert:? "?|Revert "?)?(void|fix|feat|docs|style|perf|test|types|build|chore|refactor|workflow|ci|wip|release|breaking change)(\(.+\))?: .{1,50}/;
 const mergeRE = /Merge (remote-tracking )?branch /;
-const run = (commitMessage) => {
-  let content = "";
-  if (!commitRE.test(commitMessage) && !mergeRE.test(commitMessage)) {
-    content += `
-Invalid commit message: "${commitMessage}".
-`;
-    content += `
+class Message {
+  static lint = (commitMessage) => {
+    let content = "";
+    if (!commitRE.test(commitMessage) && !mergeRE.test(commitMessage)) {
+      content += `
+Invalid Commit Message: "${commitMessage}".
+`;
+      content += `
 Examples: 
 `;
-    content += `	- fix(Button): incorrect style
+      content += `	- fix(Button): incorrect style
 `;
-    content += `	- feat(Button): incorrect style
+      content += `	- feat(Button): incorrect style
 `;
-    content += `	- docs(Button): fix typo
+      content += `	- docs(Button): fix typo
 `;
-    content += `
+      content += `
 Allowed Types:
 `;
-    content += `	- fix：修补bug
+      content += `	- fix：修补bug
 `;
-    content += `	- feat：新功能（feature）
+      content += `	- feat：新功能（feature）
 `;
-    content += `	- docs：文档（documentation）
+      content += `	- docs：文档（documentation）
 `;
-    content += `	- style：不影响代码含义的更改，可能与代码格式有关，例如空格、缺少分号等
+      content += `	- style：不影响代码含义的更改，可能与代码格式有关，例如空格、缺少分号等
 `;
-    content += `	- test：包括新的或更正以前的测试
+      content += `	- test：包括新的或更正以前的测试
 `;
-    content += `	- chore：构建过程或辅助工具的变动
+      content += `	- chore：构建过程或辅助工具的变动
 `;
-    content += `	- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+      content += `	- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
 `;
-    content += `	- perf：性能改进（performance improvements）
+      content += `	- perf：性能改进（performance improvements）
 `;
-    content += `	- types：类型
+      content += `	- types：类型
 `;
-    content += `	- build：影响构建系统或外部依赖项的更改
+      content += `	- build：影响构建系统或外部依赖项的更改
 `;
-    content += `	- ci: 持续集成相关
+      content += `	- ci: 持续集成相关
 `;
-    content += `	- breaking change：破坏性修改
+      content += `	- breaking change：破坏性修改
 `;
-    content += `	- void：无类型，通常用于初始化
+      content += `	- void：无类型，通常用于初始化
 `;
-    content += `	- Merge branch 'foo' into 'bar'
+      content += `	- Merge branch 'foo' into 'bar'
 `;
-    content += `	- Revert ""
+      content += `	- Revert ""
 `;
+    }
+    return content;
+  };
+  /* istanbul ignore next -- @preserve */
+  static run = (argvStartIndex, argv = process.argv) => {
+    const filepath = argv[argvStartIndex];
+    const message = filepath && fs__namespace.existsSync(filepath) ? fs__namespace.readFileSync(filepath, "utf-8").trim() : filepath || "";
+    const excludeIndex = argv.findIndex((i) => i === "--message-exclude");
+    const excludes = excludeIndex !== -1 && argv[excludeIndex + 1] ? new RegExp(`(${argv[excludeIndex + 1].replace(/,/g, "|")})`) : void 0;
+    if (message) {
+      if (excludes && excludes.test(message)) {
+        return;
+      }
+      return Message.lint(message);
+    }
+  };
+}
+
+const cwd = process.cwd();
+class FilePath {
+  static lint = (filePath) => {
+    if (/[A-Z]/g.test(filePath)) {
+      return filePath;
+    }
+  };
+  /* istanbul ignore next -- @preserve */
+  static run = (argvStartIndex, argv = process.argv) => {
+    const filePaths = argv.slice(argvStartIndex, argv.length);
+    const excludeIndex = argv.findIndex((i) => i === "--file-path-exclude");
+    const excludes = excludeIndex !== -1 && argv[excludeIndex + 1] ? new RegExp(`(${argv[excludeIndex + 1].replace(/,/g, "|")})`) : void 0;
+    const errors = [];
+    for (let i = 0; i < filePaths.length; i++) {
+      const filePath = filePaths[i];
+      if (filePath && fs__namespace.existsSync(filePath) && path__namespace.extname(filePath) !== ".md") {
+        const filePathV2 = path__namespace.relative(cwd, filePath);
+        if (excludes && excludes.test(filePath)) continue;
+        const error = FilePath.lint(filePathV2);
+        error && errors.push(error);
+      }
+    }
+    if (errors.length) {
+      return `Invalid Commit FilePaths: 
+
+${errors.join("\n")}
+
+Allowed Filepath: xxx-xxx-xxx
+`;
+    }
+  };
+}
+
+const check = () => {
+  for (let i = 0; i < process.argv.length; i++) {
+    if (["--edit", "--message"].includes(process.argv[i])) {
+      return Message.run(i + 1);
+    }
+    if (["--file-path"].includes(process.argv[i])) {
+      return FilePath.run(i + 1);
+    }
   }
-  return content;
 };
-const index = process.argv.findIndex((arg) => arg === "--edit");
-const filepath = index !== -1 && process.argv[index + 1];
-const message = filepath && fs__namespace.existsSync(filepath) ? fs__namespace.readFileSync(filepath, "utf-8").trim() : filepath || "";
-if (message) {
-  const error = run(message);
-  if (error) {
-    console.error(error);
-    process.exit(1);
-  }
+const error = check();
+if (error) {
+  console.error(error);
+  process.exit(1);
 }
 
-exports.run = run;
+exports.FilePath = FilePath;
+exports.Message = Message;

package/dist/index.d.ts

@@ -1,3 +1,11 @@
-export declare const run: (commitMessage: string) => string;
+export declare class FilePath {
+    static lint: (filePath: string) => string | undefined;
+    static run: (argvStartIndex: number, argv?: string[]) => string | undefined;
+}
+
+export declare class Message {
+    static lint: (commitMessage: string) => string;
+    static run: (argvStartIndex: number, argv?: string[]) => string | undefined;
+}
 
 export { }

package/dist/index.js

@@ -1,67 +1,122 @@
 import * as fs from 'node:fs';
+import * as path from 'node:path';
 
 const commitRE = /^(revert:? "?|Revert "?)?(void|fix|feat|docs|style|perf|test|types|build|chore|refactor|workflow|ci|wip|release|breaking change)(\(.+\))?: .{1,50}/;
 const mergeRE = /Merge (remote-tracking )?branch /;
-const run = (commitMessage) => {
-  let content = "";
-  if (!commitRE.test(commitMessage) && !mergeRE.test(commitMessage)) {
-    content += `
-Invalid commit message: "${commitMessage}".
-`;
-    content += `
+class Message {
+  static lint = (commitMessage) => {
+    let content = "";
+    if (!commitRE.test(commitMessage) && !mergeRE.test(commitMessage)) {
+      content += `
+Invalid Commit Message: "${commitMessage}".
+`;
+      content += `
 Examples: 
 `;
-    content += `	- fix(Button): incorrect style
+      content += `	- fix(Button): incorrect style
 `;
-    content += `	- feat(Button): incorrect style
+      content += `	- feat(Button): incorrect style
 `;
-    content += `	- docs(Button): fix typo
+      content += `	- docs(Button): fix typo
 `;
-    content += `
+      content += `
 Allowed Types:
 `;
-    content += `	- fix：修补bug
+      content += `	- fix：修补bug
 `;
-    content += `	- feat：新功能（feature）
+      content += `	- feat：新功能（feature）
 `;
-    content += `	- docs：文档（documentation）
+      content += `	- docs：文档（documentation）
 `;
-    content += `	- style：不影响代码含义的更改，可能与代码格式有关，例如空格、缺少分号等
+      content += `	- style：不影响代码含义的更改，可能与代码格式有关，例如空格、缺少分号等
 `;
-    content += `	- test：包括新的或更正以前的测试
+      content += `	- test：包括新的或更正以前的测试
 `;
-    content += `	- chore：构建过程或辅助工具的变动
+      content += `	- chore：构建过程或辅助工具的变动
 `;
-    content += `	- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+      content += `	- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
 `;
-    content += `	- perf：性能改进（performance improvements）
+      content += `	- perf：性能改进（performance improvements）
 `;
-    content += `	- types：类型
+      content += `	- types：类型
 `;
-    content += `	- build：影响构建系统或外部依赖项的更改
+      content += `	- build：影响构建系统或外部依赖项的更改
 `;
-    content += `	- ci: 持续集成相关
+      content += `	- ci: 持续集成相关
 `;
-    content += `	- breaking change：破坏性修改
+      content += `	- breaking change：破坏性修改
 `;
-    content += `	- void：无类型，通常用于初始化
+      content += `	- void：无类型，通常用于初始化
 `;
-    content += `	- Merge branch 'foo' into 'bar'
+      content += `	- Merge branch 'foo' into 'bar'
 `;
-    content += `	- Revert ""
+      content += `	- Revert ""
 `;
+    }
+    return content;
+  };
+  /* istanbul ignore next -- @preserve */
+  static run = (argvStartIndex, argv = process.argv) => {
+    const filepath = argv[argvStartIndex];
+    const message = filepath && fs.existsSync(filepath) ? fs.readFileSync(filepath, "utf-8").trim() : filepath || "";
+    const excludeIndex = argv.findIndex((i) => i === "--message-exclude");
+    const excludes = excludeIndex !== -1 && argv[excludeIndex + 1] ? new RegExp(`(${argv[excludeIndex + 1].replace(/,/g, "|")})`) : void 0;
+    if (message) {
+      if (excludes && excludes.test(message)) {
+        return;
+      }
+      return Message.lint(message);
+    }
+  };
+}
+
+const cwd = process.cwd();
+class FilePath {
+  static lint = (filePath) => {
+    if (/[A-Z]/g.test(filePath)) {
+      return filePath;
+    }
+  };
+  /* istanbul ignore next -- @preserve */
+  static run = (argvStartIndex, argv = process.argv) => {
+    const filePaths = argv.slice(argvStartIndex, argv.length);
+    const excludeIndex = argv.findIndex((i) => i === "--file-path-exclude");
+    const excludes = excludeIndex !== -1 && argv[excludeIndex + 1] ? new RegExp(`(${argv[excludeIndex + 1].replace(/,/g, "|")})`) : void 0;
+    const errors = [];
+    for (let i = 0; i < filePaths.length; i++) {
+      const filePath = filePaths[i];
+      if (filePath && fs.existsSync(filePath) && path.extname(filePath) !== ".md") {
+        const filePathV2 = path.relative(cwd, filePath);
+        if (excludes && excludes.test(filePath)) continue;
+        const error = FilePath.lint(filePathV2);
+        error && errors.push(error);
+      }
+    }
+    if (errors.length) {
+      return `Invalid Commit FilePaths: 
+
+${errors.join("\n")}
+
+Allowed Filepath: xxx-xxx-xxx
+`;
+    }
+  };
+}
+
+const check = () => {
+  for (let i = 0; i < process.argv.length; i++) {
+    if (["--edit", "--message"].includes(process.argv[i])) {
+      return Message.run(i + 1);
+    }
+    if (["--file-path"].includes(process.argv[i])) {
+      return FilePath.run(i + 1);
+    }
   }
-  return content;
 };
-const index = process.argv.findIndex((arg) => arg === "--edit");
-const filepath = index !== -1 && process.argv[index + 1];
-const message = filepath && fs.existsSync(filepath) ? fs.readFileSync(filepath, "utf-8").trim() : filepath || "";
-if (message) {
-  const error = run(message);
-  if (error) {
-    console.error(error);
-    process.exit(1);
-  }
+const error = check();
+if (error) {
+  console.error(error);
+  process.exit(1);
 }
 
-export { run };
+export { FilePath, Message };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deot/dev-commitlint",
-  "version": "2.9.8",
+  "version": "2.9.9",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",