@d-zero/lint-staged-config 5.0.0-alpha.36 → 5.0.0-alpha.38

package/README.md

@@ -21,9 +21,14 @@ export default lintStagedConfigGenerator();
 
 ```js
 import lintStagedConfigGenerator, { defaultMapping } from '@d-zero/lint-staged-config';
-export default lintStagedConfigGenerator(process.cwd(), {
-	...defaultMapping,
-	// 例: PHPファイルに対して`markuplint`、`prettier`、`cspell`を実行する
-	php: ['markuplint', 'prettier', 'cspell'],
-});
+export default lintStagedConfigGenerator(
+	{
+		ignore: [path.resolve(process.cwd(), 'dist', '**', '*')],
+	},
+	{
+		...defaultMapping,
+		// 例: PHPファイルに対して`markuplint`、`prettier`、`cspell`を実行する
+		php: ['markuplint', 'prettier', 'cspell'],
+	},
+);
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/lint-staged-config",
-	"version": "5.0.0-alpha.36",
+	"version": "5.0.0-alpha.38",
 	"description": "Configurations of lint-staged",
 	"repository": "https://github.com/d-zero-dev/linters.git",
 	"author": "D-ZERO Co., Ltd.",
@@ -13,16 +13,21 @@
 		"node": ">=22.0.0"
 	},
 	"type": "module",
+	"exports": {
+		"import": "./dist/index.js"
+	},
 	"files": [
-		"index.mjs",
-		"types.ts"
+		"src"
 	],
-	"exports": {
-		"import": "./index.mjs",
-		"types": "./types.ts"
+	"scripts": {
+		"build": "tsc"
 	},
 	"dependencies": {
-		"lint-staged": "15.2.7"
+		"lint-staged": "15.2.7",
+		"micromatch": "4.0.7"
+	},
+	"devDependencies": {
+		"@types/micromatch": "4.0.9"
 	},
-	"gitHead": "4f91c703f88f9bc8a0458e8c369d6a37e980af7d"
+	"gitHead": "ffb91050c95bb824e92b618ee6d40d9bed708574"
 }

package/src/commands.ts

@@ -0,0 +1,11 @@
+import type { CommandType } from './types.js';
+
+export const commands: Record<CommandType, string> = {
+	cspell: 'cspell --no-must-find-files --show-suggestions',
+	eslint: 'eslint --fix',
+	markuplint: 'markuplint',
+	prettier: 'prettier --write',
+	puglint: 'pug-lint',
+	stylelint: 'stylelint --fix',
+	textlint: 'textlint',
+};

package/src/default-mapping.ts

@@ -0,0 +1,24 @@
+import type { CommandMappings } from './types.js';
+
+export const defaultMapping: CommandMappings = {
+	astro: ['eslint', 'markuplint', 'prettier', 'cspell'],
+	cjs: ['eslint', 'prettier', 'cspell'],
+	css: ['stylelint', 'prettier', 'cspell'],
+	cts: ['eslint', 'prettier', 'cspell'],
+	html: ['markuplint', 'prettier', 'cspell'],
+	js: ['eslint', 'prettier', 'cspell'],
+	json: ['prettier', 'cspell'],
+	jsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
+	md: ['prettier', 'textlint', 'cspell'],
+	mdx: ['prettier', 'textlint', 'cspell'],
+	mjs: ['eslint', 'prettier', 'cspell'],
+	mts: ['eslint', 'prettier', 'cspell'],
+	pug: ['markuplint', 'prettier', 'cspell'],
+	scss: ['stylelint', 'prettier', 'cspell'],
+	svelte: ['eslint', 'markuplint', 'prettier', 'cspell'],
+	ts: ['eslint', 'prettier', 'cspell'],
+	tsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
+	vue: ['eslint', 'markuplint', 'prettier', 'cspell'],
+	yaml: ['cspell'],
+	yml: ['cspell'],
+};

package/src/index.spec.ts

@@ -0,0 +1,44 @@
+import path from 'node:path';
+
+import { describe, test, expect } from 'vitest';
+
+import lintStagedConfigGenerator from './index.js';
+
+function resolve(...paths: string[]): string {
+	return path.resolve(...paths).replaceAll(path.sep, '/');
+}
+
+function toRelativePath(...paths: string[]): string[] {
+	const cwd = process.cwd().replaceAll(path.sep, '/');
+	return paths.map((p) => p.replaceAll(cwd, '.'));
+}
+
+describe('lintStagedConfigGenerator', () => {
+	test('defaultMapping', () => {
+		const config = lintStagedConfigGenerator();
+		const commands = toRelativePath(...config([resolve('README.md')]));
+		expect(commands).toStrictEqual([
+			'prettier --write "./README.md"',
+			'textlint "./README.md"',
+			'cspell --no-must-find-files --show-suggestions "./README.md"',
+		]);
+	});
+
+	test('ignore option', () => {
+		const config = lintStagedConfigGenerator({
+			ignore: [resolve('packages', '@d-zero', 'eslint-config', '*')],
+		});
+		const commands = toRelativePath(
+			...config([
+				resolve('packages', '@d-zero', 'eslint-config', 'CHANGELOG.md'),
+				resolve('packages', '@d-zero', 'lint-staged-config', 'CHANGELOG.md'),
+			]),
+		);
+
+		expect(commands).toStrictEqual([
+			'prettier --write "./packages/@d-zero/lint-staged-config/CHANGELOG.md"',
+			'textlint "./packages/@d-zero/lint-staged-config/CHANGELOG.md"',
+			'cspell --no-must-find-files --show-suggestions "./packages/@d-zero/lint-staged-config/CHANGELOG.md"',
+		]);
+	});
+});

package/src/index.ts

@@ -0,0 +1,75 @@
+import type { CommandMappings, LintStagedCommandMapper } from './types.js';
+
+import path from 'node:path';
+
+import micromatch from 'micromatch';
+
+import { commands } from './commands.js';
+import { defaultMapping } from './default-mapping.js';
+
+export interface DirectoryOptions {
+	/**
+	 * ファイルを検索するディレクトリ
+	 */
+	dir?: string;
+
+	/**
+	 * 除外するファイルのパターン
+	 */
+	ignore?: string[];
+}
+
+export default function (
+	dirOptions?: string | DirectoryOptions,
+	mapping?: CommandMappings,
+): LintStagedCommandMapper {
+	return (allStagedFiles) => {
+		const commandList: string[] = [];
+		const cwd = process.cwd();
+
+		const dir = typeof dirOptions === 'string' ? dirOptions : dirOptions?.dir;
+		const ignore = typeof dirOptions === 'string' ? null : dirOptions?.ignore;
+
+		const baseDir = dir
+			? // 絶対パスかどうか
+				path.isAbsolute(dir)
+				? // 絶対パスならそのまま
+					dir
+				: // 相対パスなら絶対パスに変換
+					path.resolve(cwd, dir)
+			: // 引数がないならカレントディレクトリ
+				cwd;
+
+		mapping = mapping ?? defaultMapping;
+
+		for (const [ext, commandTypes] of Object.entries(mapping)) {
+			for (const commandType of commandTypes) {
+				const shell = commands[commandType];
+
+				if (!shell) {
+					continue;
+				}
+
+				const pattern = path
+					.resolve(baseDir, '**', `{*.${ext},.*.${ext}}`)
+					.replaceAll(path.sep, '/');
+
+				const files = allStagedFiles.map((f) => f.replaceAll(path.sep, '/'));
+
+				let targetFiles = micromatch(files, pattern);
+
+				if (ignore) {
+					targetFiles = micromatch.not(targetFiles, ignore);
+				}
+
+				if (targetFiles.length <= 0) {
+					continue;
+				}
+
+				commandList.push(shell + ' ' + targetFiles.map((f) => `"${f}"`).join(' '));
+			}
+		}
+
+		return commandList;
+	};
+}

package/{types.ts → src/types.ts}

@@ -1,30 +1,31 @@
 export type TargetFileExtension =
+	| 'astro'
+	| 'cjs'
+	| 'css'
+	| 'cts'
+	| 'html'
+	| 'js'
+	| 'json'
+	| 'jsx'
 	| 'md'
 	| 'mdx'
-	| 'json'
-	| 'yaml'
-	| 'yml'
-	| 'js'
-	| 'cjs'
 	| 'mjs'
-	| 'jsx'
-	| 'ts'
-	| 'cts'
 	| 'mts'
-	| 'tsx'
-	| 'html'
 	| 'pug'
-	| 'css'
 	| 'scss'
-	| 'astro'
 	| 'svelte'
-	| 'vue';
+	| 'ts'
+	| 'tsx'
+	| 'vue'
+	| 'yaml'
+	| 'yml';
 
 export type CommandType =
 	| 'cspell'
 	| 'eslint'
 	| 'markuplint'
 	| 'prettier'
+	| 'puglint'
 	| 'stylelint'
 	| 'textlint';
 

package/index.mjs

@@ -1,96 +0,0 @@
-import path from 'node:path';
-
-import micromatch from 'micromatch';
-
-/**
- * lint-staged Config generator
- *
- * @param {string} [dir]
- * @param {import("./types").CommandMappings} [mapping]
- * @return {import("./types").LintStagedCommandMapper}
- */
-export default function (dir, mapping) {
-	return (allStagedFiles) => {
-		/**
-		 * @type {string[]}
-		 */
-		const commandList = [];
-		const cwd = process.cwd();
-
-		dir = dir
-			? // 絶対パスかどうか
-				path.isAbsolute(dir)
-				? // 絶対パスならそのまま
-					dir
-				: // 相対パスなら絶対パスに変換
-					path.resolve(cwd, dir)
-			: // 引数がないならカレントディレクトリ
-				cwd;
-
-		mapping = mapping ?? defaultMapping;
-
-		for (const [ext, commandTypes] of Object.entries(mapping)) {
-			for (const commandType of commandTypes) {
-				const shell = commands[commandType];
-
-				if (!shell) {
-					continue;
-				}
-
-				const pattern = path
-					.resolve(dir, '**', `{*.${ext},.*.${ext}}`)
-					.replaceAll(path.sep, '/');
-
-				const files = allStagedFiles.map((f) => f.replaceAll(path.sep, '/'));
-
-				const targetFiles = micromatch(files, pattern);
-
-				if (targetFiles.length <= 0) {
-					continue;
-				}
-
-				commandList.push(shell + ' ' + targetFiles.map((f) => `"${f}"`).join(' '));
-			}
-		}
-
-		return commandList;
-	};
-}
-
-/**
- * @type {Record<import("./types").CommandType, string>}
- */
-export const commands = {
-	cspell: 'cspell --no-must-find-files --show-suggestions',
-	eslint: 'eslint --fix',
-	markuplint: 'markuplint',
-	prettier: 'prettier --write',
-	puglint: 'pug-lint',
-	stylelint: 'stylelint --fix',
-};
-
-/**
- * @type {import("./types").CommandMappings}
- */
-export const defaultMapping = {
-	astro: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	cjs: ['eslint', 'prettier', 'cspell'],
-	css: ['stylelint', 'prettier', 'cspell'],
-	cts: ['eslint', 'prettier', 'cspell'],
-	html: ['markuplint', 'prettier', 'cspell'],
-	js: ['eslint', 'prettier', 'cspell'],
-	json: ['prettier', 'cspell'],
-	jsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	md: ['prettier', 'textlint', 'cspell'],
-	mdx: ['prettier', 'textlint', 'cspell'],
-	mjs: ['eslint', 'prettier', 'cspell'],
-	mts: ['eslint', 'prettier', 'cspell'],
-	pug: ['markuplint', 'prettier', 'cspell'],
-	scss: ['stylelint', 'prettier', 'cspell'],
-	svelte: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	ts: ['eslint', 'prettier', 'cspell'],
-	tsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	vue: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	yaml: ['cspell'],
-	yml: ['cspell'],
-};