@d-zero/lint-staged-config 5.0.0-alpha.2 → 5.0.0-alpha.21

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,29 @@
 # `@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(process.cwd(), {
+	...defaultMapping,
+	// 例: PHPファイルに対して`markuplint`、`prettier`、`cspell`を実行する
+	php: ['markuplint', 'prettier', 'cspell'],
+});
+```

package/index.mjs

@@ -73,24 +73,24 @@ export const commands = {
  * @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'],
-	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'],
+	ts: ['eslint', 'prettier', 'cspell'],
+	tsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
 	vue: ['eslint', 'markuplint', 'prettier', 'cspell'],
+	yaml: ['cspell'],
+	yml: ['cspell'],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/lint-staged-config",
-	"version": "5.0.0-alpha.2",
+	"version": "5.0.0-alpha.21",
 	"description": "Configurations of lint-staged",
 	"repository": "https://github.com/d-zero-dev/linters.git",
 	"author": "D-ZERO Co., Ltd.",
@@ -19,7 +19,7 @@
 		"types": "./types.ts"
 	},
 	"dependencies": {
-		"lint-staged": "15.2.0"
+		"lint-staged": "15.2.2"
 	},
-	"gitHead": "f025a02438b76518dabddd9a8c14a8245568e3c4"
+	"gitHead": "144e19343efd0bbd97600bb624751fa6cad20b15"
 }