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

package/README.md

@@ -24,6 +24,10 @@ import lintStagedConfigGenerator, { defaultMapping } from '@d-zero/lint-staged-c
 export default lintStagedConfigGenerator(
 	{
 		ignore: [path.resolve(process.cwd(), 'dist', '**', '*')],
+		{
+			// 例: `CHANGELOG.md`に対してのみ`textlint`を除外する
+			textlint: "CHANGELOG.md",
+		}
 	},
 	{
 		...defaultMapping,

package/dist/commands.d.ts

@@ -0,0 +1,2 @@
+import type { CommandType } from './types.js';
+export declare const commands: Record<CommandType, string>;

package/dist/default-mapping.d.ts

@@ -0,0 +1,2 @@
+import type { CommandMappings } from './types.js';
+export declare const defaultMapping: CommandMappings;

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import type { CommandMappings, CommandType, LintStagedCommandMapper } from './types.js';
+export interface DirectoryOptions {
+    /**
+     * ファイルを検索するディレクトリ
+     */
+    dir?: string;
+    /**
+     * 除外するファイルのパターン
+     */
+    ignore?: (string | IgnoreMap)[];
+}
+export type IgnoreMap = Partial<Record<CommandType, string | string[]>>;
+export default function (dirOptions?: string | DirectoryOptions, mapping?: CommandMappings): LintStagedCommandMapper;

package/dist/index.js

@@ -30,7 +30,22 @@ export default function (dirOptions, mapping) {
                 const files = allStagedFiles.map((f) => f.replaceAll(path.sep, '/'));
                 let targetFiles = micromatch(files, pattern);
                 if (ignore) {
-                    targetFiles = micromatch.not(targetFiles, ignore);
+                    for (const ignoreMap of ignore) {
+                        const ignorePattern = typeof ignoreMap === 'string' ? ignoreMap : ignoreMap[commandType];
+                        if (!ignorePattern) {
+                            continue;
+                        }
+                        const ignorePatterns = Array.isArray(ignorePattern)
+                            ? ignorePattern
+                            : [ignorePattern];
+                        const absIgnorePatterns = ignorePatterns.map((p) => {
+                            if (p === path.basename(p)) {
+                                return path.resolve('**', p);
+                            }
+                            return path.isAbsolute(p) ? p : path.resolve(baseDir, p);
+                        });
+                        targetFiles = micromatch.not(targetFiles, absIgnorePatterns);
+                    }
                 }
                 if (targetFiles.length <= 0) {
                     continue;

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+export type TargetFileExtension = 'astro' | 'cjs' | 'css' | 'cts' | 'html' | 'js' | 'json' | 'jsx' | 'md' | 'mdx' | 'mjs' | 'mts' | 'pug' | 'scss' | 'svelte' | 'ts' | 'tsx' | 'vue' | 'yaml' | 'yml';
+export type CommandType = 'cspell' | 'eslint' | 'markuplint' | 'prettier' | 'puglint' | '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[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/lint-staged-config",
-	"version": "5.0.0-alpha.40",
+	"version": "5.0.0-alpha.41",
 	"description": "Configurations of lint-staged",
 	"repository": "https://github.com/d-zero-dev/linters.git",
 	"author": "D-ZERO Co., Ltd.",
@@ -14,7 +14,8 @@
 	},
 	"type": "module",
 	"exports": {
-		"import": "./dist/index.js"
+		"import": "./dist/index.js",
+		"types": "./dist/index.d.ts"
 	},
 	"files": [
 		"dist"
@@ -29,5 +30,5 @@
 	"devDependencies": {
 		"@types/micromatch": "4.0.9"
 	},
-	"gitHead": "7c0ce7713b288098b230e149502cd1fe910b4468"
+	"gitHead": "25f71f1dfef6d627b908f832124d4e4a0b1572bb"
 }

package/dist/index.spec.js

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