@d-zero/lint-staged-config 5.0.0-dev.34

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,4 @@
+# `@d-zero/lint-staged-config`
+
+- 使用: 🆗 使用可
+- 解説: 🚧 準備中

package/index.mjs

@@ -0,0 +1,96 @@
+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
+			? // 引数がないならカレントディレクトリ
+			  cwd
+			: // 絶対パスかどうか
+			path.isAbsolute(dir)
+			? // 絶対パスならそのまま
+			  dir
+			: // 相対パスなら絶対パスに変換
+			  path.resolve(cwd, dir);
+
+		mapping = mapping ?? defaultMapping;
+
+		Object.entries(mapping).forEach(([ext, commandTypes]) => {
+			commandTypes.forEach((commandType) => {
+				const shell = commands[commandType];
+
+				if (!shell) {
+					return;
+				}
+
+				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) {
+					return;
+				}
+
+				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/index.spec.mjs

@@ -0,0 +1,19 @@
+import path from 'node:path';
+
+import lintStagedConfigGenerator from './index.mjs';
+
+describe('lintStagedConfigGenerator', () => {
+	const defaultConfig = lintStagedConfigGenerator();
+	const cwd = process.cwd().replaceAll(path.sep, '/');
+
+	test('defaultMapping', () => {
+		expect(
+			defaultConfig([path.resolve(process.cwd(), 'README.md')]).map((shell) =>
+				shell.replaceAll(cwd + '/', './').replaceAll(cwd, '.'),
+			),
+		).toStrictEqual([
+			'prettier --write "./README.md"',
+			'cspell --no-must-find-files --show-suggestions "./README.md"',
+		]);
+	});
+});

package/package.json

@@ -0,0 +1,22 @@
+{
+	"name": "@d-zero/lint-staged-config",
+	"version": "5.0.0-dev.34+c65aa52",
+	"description": "Configurations of lint-staged",
+	"repository": "https://github.com/d-zero-dev/frontend-env.git",
+	"author": "D-ZERO Co., Ltd.",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"exports": {
+		"import": "./index.mjs",
+		"types": "./types.ts"
+	},
+	"prettier": "@d-zero/prettier-config",
+	"dependencies": {
+		"lint-staged": "13.2.1"
+	},
+	"gitHead": "c65aa521b5014591272ca6c1d659111830e4d8b3"
+}

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+	"extends": "@d-zero/tsconfig/tsconfig.json",
+	"compilerOptions": {
+		"noEmit": true
+	}
+}

package/types.ts

@@ -0,0 +1,38 @@
+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[];