feat(commitlint): support file-path check & *-exclude

Author: deot

.lintstagedrc.json

@@ -1,5 +1,8 @@
 {
   "**/*.{js,ts,jsx,tsx,md}": [
     "eslint --fix"
+  ],
+  "*": [
+    "node packages/commitlint/dist/index.js --file-path"
   ]
 }

packages/commitlint/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
+```
+

packages/commitlint/__tests__/fixtures/filepath

@@ -0,0 +1 @@
+any

packages/commitlint/__tests__/fixtures/message

@@ -1,20 +1,41 @@
-import { run } from '@deot/dev-commitlint';
+import * as path from 'node:path';
+import { Message, FilePath } from '@deot/dev-commitlint';
 
 describe('index.ts', () => {
-	it('allow', async () => {
+	it('message/allow', async () => {
 		expect.hasAssertions();
-		expect(run('feat: any')).toBeFalsy();
-		expect(run('void: any\n')).toBeFalsy();
-		expect(run('revert: feat: any')).toBeFalsy();
-		expect(run('Revert "style: any"')).toBeFalsy();
-		expect(run(`Merge remote-tracking branch 'origin/xx' into test`)).toBeFalsy();
+		expect(Message.lint('feat: any')).toBeFalsy();
+		expect(Message.lint('void: any\n')).toBeFalsy();
+		expect(Message.lint('revert: feat: any')).toBeFalsy();
+		expect(Message.lint('Revert "style: any"')).toBeFalsy();
+		expect(Message.lint(`Merge remote-tracking branch 'origin/xx' into test`)).toBeFalsy();
 
-		expect(run(`Merge branch 'foo' into 'bar'`)).toBeFalsy();
+		expect(Message.lint(`Merge branch 'foo' into 'bar'`)).toBeFalsy();
 	});
 
-	it('throw error', async () => {
+	it('message/throw error', async () => {
 		expect.hasAssertions();
-		expect(run('any')).toBeTruthy();
-		expect(run('aaa: any')).toBeTruthy();
+		expect(Message.lint('any')).toBeTruthy();
+		expect(Message.lint('aaa: any')).toBeTruthy();
+	});
+
+	it('message/allow/run', async () => {
+		const fakePath = path.resolve(__dirname, './fixtures/message');
+		expect.hasAssertions();
+		expect(Message.run(1, ['--message', fakePath])).toBeTruthy();
+		expect(Message.run(1, ['--message', fakePath, '--message-exclude', 'any,any1'])).toBeFalsy();
+	});
+
+	it('file-path/allow/run', async () => {
+		const fakePath = path.resolve(__dirname, './fixtures/message');
+		expect.hasAssertions();
+		expect(FilePath.run(1, ['--file-path', fakePath])).toBeFalsy();
+		expect(FilePath.run(1, ['--file-path', fakePath, '--file-path-exclude', 'message'])).toBeFalsy();
+	});
+
+	it('file-path/throw error', async () => {
+		expect.hasAssertions();
+		expect(FilePath.lint('Any')).toBeTruthy();
+		expect(FilePath.lint('any')).toBeFalsy();
 	});
 });

packages/commitlint/__tests__/index.spec.ts

@@ -0,0 +1,36 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+const cwd = process.cwd();
+
+export class FilePath {
+	static lint = (filePath: string) => {
+		if (/[A-Z]/g.test(filePath)) {
+			return filePath;
+		}
+	};
+
+	/* istanbul ignore next -- @preserve */
+	static run = (argvStartIndex: number, 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 = [] as string[];
+		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: \n\n${errors.join('\n')}\n\nAllowed Filepath: xxx-xxx-xxx\n`;
+		}
+	};
+};

packages/commitlint/src/file-path.ts

@@ -1,50 +1,31 @@
-import * as fs from 'node:fs';
+import { Message } from './message.ts';
+import { FilePath } from './file-path.ts';
 
-// eslint-disable-next-line @stylistic/max-len
-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 /;
+export { Message, FilePath };
 
-export const run = (commitMessage: string) => {
-	let content = '';
-	if (!commitRE.test(commitMessage) && !mergeRE.test(commitMessage)) {
-		content += `\nInvalid commit message: "${commitMessage}".\n`;
-		content += `\nExamples: \n`;
-		content += `	- fix(Button): incorrect style\n`;
-		content += `	- feat(Button): incorrect style\n`;
-		content += `	- docs(Button): fix typo\n`;
-		content += `\nAllowed Types:\n`;
-		content += `	- fix：修补bug\n`;
-		content += `	- feat：新功能（feature）\n`;
-		content += `	- docs：文档（documentation）\n`;
-		content += `	- style：不影响代码含义的更改，可能与代码格式有关，例如空格、缺少分号等\n`;
-		content += `	- test：包括新的或更正以前的测试\n`;
-		content += `	- chore：构建过程或辅助工具的变动\n`;
-		content += `	- refactor：重构（即不是新增功能，也不是修改bug的代码变动）\n`;
-		content += `	- perf：性能改进（performance improvements）\n`;
-		content += `	- types：类型\n`;
-		content += `	- build：影响构建系统或外部依赖项的更改\n`;
-		content += `	- ci: 持续集成相关\n`;
-		content += `	- breaking change：破坏性修改\n`;
-		content += `	- void：无类型，通常用于初始化\n`;
-		content += `	- Merge branch 'foo' into 'bar'\n`;
-		content += `	- Revert ""\n`;
-	}
-	return content;
-};
+/**
+ * 一次只执行一项任务
+ * @returns error
+ */
+const check = () => {
+	for (let i = 0; i < process.argv.length; i++) {
+		/* istanbul ignore next -- @preserve */
+		if (['--edit', '--message'].includes(process.argv[i])) { // @deprecated（--edit）
+			/* istanbul ignore next -- @preserve */
+			return Message.run(i + 1);
+		}
 
-const index = process.argv.findIndex(arg => arg === '--edit');
-/* istanbul ignore next -- @preserve */
-const filepath = index !== -1 && process.argv[index + 1];
-/* istanbul ignore next -- @preserve */
-const message = filepath && fs.existsSync(filepath)
-	? fs.readFileSync(filepath, 'utf-8').trim()
-	: (filepath || '');
+		/* istanbul ignore next -- @preserve */
+		if (['--file-path'].includes(process.argv[i])) {
+			/* istanbul ignore next -- @preserve */
+			return FilePath.run(i + 1);
+		}
+	};
+};
 
+const error = check();
 /* istanbul ignore next -- @preserve */
-if (message) {
-	const error = run(message);
-	if (error) {
-		console.error(error);
-		process.exit(1);
-	}
-}
+if (error) {
+	console.error(error);
+	process.exit(1);
+};

packages/commitlint/src/index.ts

@@ -0,0 +1,57 @@
+import * as fs from 'node:fs';
+
+// eslint-disable-next-line @stylistic/max-len
+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 /;
+
+export class Message {
+	static lint = (commitMessage: string) => {
+		let content = '';
+		if (!commitRE.test(commitMessage) && !mergeRE.test(commitMessage)) {
+			content += `\nInvalid Commit Message: "${commitMessage}".\n`;
+			content += `\nExamples: \n`;
+			content += `	- fix(Button): incorrect style\n`;
+			content += `	- feat(Button): incorrect style\n`;
+			content += `	- docs(Button): fix typo\n`;
+			content += `\nAllowed Types:\n`;
+			content += `	- fix：修补bug\n`;
+			content += `	- feat：新功能（feature）\n`;
+			content += `	- docs：文档（documentation）\n`;
+			content += `	- style：不影响代码含义的更改，可能与代码格式有关，例如空格、缺少分号等\n`;
+			content += `	- test：包括新的或更正以前的测试\n`;
+			content += `	- chore：构建过程或辅助工具的变动\n`;
+			content += `	- refactor：重构（即不是新增功能，也不是修改bug的代码变动）\n`;
+			content += `	- perf：性能改进（performance improvements）\n`;
+			content += `	- types：类型\n`;
+			content += `	- build：影响构建系统或外部依赖项的更改\n`;
+			content += `	- ci: 持续集成相关\n`;
+			content += `	- breaking change：破坏性修改\n`;
+			content += `	- void：无类型，通常用于初始化\n`;
+			content += `	- Merge branch 'foo' into 'bar'\n`;
+			content += `	- Revert ""\n`;
+		}
+		return content;
+	};
+
+	/* istanbul ignore next -- @preserve */
+	static run = (argvStartIndex: number, 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;
+
+		/* istanbul ignore next -- @preserve */
+		if (message) {
+			if (excludes && excludes.test(message)) {
+				return;
+			}
+			return Message.lint(message);
+		}
+	};
+};