@d-zero/lint-staged-config 5.0.0-alpha.4 → 5.0.0-alpha.40

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 D-ZERO Co., Ltd.
+Copyright (c) 2024 D-ZERO Co., Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,34 @@
 # `@d-zero/lint-staged-config`
 
-- 使用: 🆗 使用可
-- 解説: 🚧 準備中
+## 個別インストール
+
+```sh
+yarn add -D @d-zero/lint-staged-config
+```
+
+## 使い方
+
+`lint-staged.config.mjs`を作成し、読み込んだジェネレーター関数で設定を生成しエクスポートします。
+
+```js
+import lintStagedConfigGenerator from '@d-zero/lint-staged-config';
+export default lintStagedConfigGenerator();
+```
+
+### 拡張
+
+プロジェクトに合わせて設定を追加します。
+
+```js
+import lintStagedConfigGenerator, { defaultMapping } from '@d-zero/lint-staged-config';
+export default lintStagedConfigGenerator(
+	{
+		ignore: [path.resolve(process.cwd(), 'dist', '**', '*')],
+	},
+	{
+		...defaultMapping,
+		// 例: PHPファイルに対して`markuplint`、`prettier`、`cspell`を実行する
+		php: ['markuplint', 'prettier', 'cspell'],
+	},
+);
+```

package/dist/commands.js

@@ -0,0 +1,9 @@
+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',
+    textlint: 'textlint',
+};

package/dist/default-mapping.js

@@ -0,0 +1,22 @@
+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'],
+};

package/dist/index.js

@@ -0,0 +1,43 @@
+import path from 'node:path';
+import micromatch from 'micromatch';
+import { commands } from './commands.js';
+import { defaultMapping } from './default-mapping.js';
+export default function (dirOptions, mapping) {
+    return (allStagedFiles) => {
+        const commandList = [];
+        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/dist/index.spec.js

@@ -0,0 +1,35 @@
+import path from 'node:path';
+import { describe, test, expect } from 'vitest';
+import lintStagedConfigGenerator from './index.js';
+function resolve(...paths) {
+    return path.resolve(...paths).replaceAll(path.sep, '/');
+}
+function toRelativePath(...paths) {
+    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/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/lint-staged-config",
-	"version": "5.0.0-alpha.4",
+	"version": "5.0.0-alpha.40",
 	"description": "Configurations of lint-staged",
 	"repository": "https://github.com/d-zero-dev/linters.git",
 	"author": "D-ZERO Co., Ltd.",
@@ -9,17 +9,25 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"engines": {
+		"node": ">=22.0.0"
+	},
 	"type": "module",
+	"exports": {
+		"import": "./dist/index.js"
+	},
 	"files": [
-		"index.mjs",
-		"types.ts"
+		"dist"
 	],
-	"exports": {
-		"import": "./index.mjs",
-		"types": "./types.ts"
+	"scripts": {
+		"build": "tsc"
 	},
 	"dependencies": {
-		"lint-staged": "15.2.0"
+		"lint-staged": "15.2.7",
+		"micromatch": "4.0.7"
+	},
+	"devDependencies": {
+		"@types/micromatch": "4.0.9"
 	},
-	"gitHead": "de8f9c035cfb70bbf4cc5b203869dc39427c9d3a"
+	"gitHead": "7c0ce7713b288098b230e149502cd1fe910b4468"
 }

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 = {
-	md: ['prettier', 'textlint', 'cspell'],
-	mdx: ['prettier', 'textlint', 'cspell'],
-	json: ['prettier', 'cspell'],
-	yaml: ['cspell'],
-	yml: ['cspell'],
-	js: ['eslint', 'prettier', 'cspell'],
-	cjs: ['eslint', 'prettier', 'cspell'],
-	mjs: ['eslint', 'prettier', 'cspell'],
-	jsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	ts: ['eslint', 'prettier', 'cspell'],
-	cts: ['eslint', 'prettier', 'cspell'],
-	mts: ['eslint', 'prettier', 'cspell'],
-	tsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	html: ['markuplint', 'prettier', 'cspell'],
-	pug: ['markuplint', 'prettier', 'cspell'],
-	css: ['stylelint', 'prettier', 'cspell'],
-	scss: ['stylelint', 'prettier', 'cspell'],
-	astro: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	svelte: ['eslint', 'markuplint', 'prettier', 'cspell'],
-	vue: ['eslint', 'markuplint', 'prettier', 'cspell'],
-};

package/types.ts

@@ -1,38 +0,0 @@
-export type TargetFileExtension =
-	| 'md'
-	| 'mdx'
-	| 'json'
-	| 'yaml'
-	| 'yml'
-	| 'js'
-	| 'cjs'
-	| 'mjs'
-	| 'jsx'
-	| 'ts'
-	| 'cts'
-	| 'mts'
-	| 'tsx'
-	| 'html'
-	| 'pug'
-	| 'css'
-	| 'scss'
-	| 'astro'
-	| 'svelte'
-	| 'vue';
-
-export type CommandType =
-	| 'cspell'
-	| 'eslint'
-	| 'markuplint'
-	| 'prettier'
-	| 'stylelint'
-	| 'textlint';
-
-export type CommandMappings = Readonly<
-	Partial<Record<TargetFileExtension, CommandType[]>>
->;
-
-/**
- * @see https://github.com/okonet/lint-staged#example-export-a-function-to-build-your-own-matchers
- */
-export type LintStagedCommandMapper = (allStagedFiles: readonly string[]) => string[];