@d-zero/lint-staged-config 6.0.0-alpha.2 → 6.0.0-alpha.3

package/README.md

@@ -15,6 +15,20 @@ import lintStagedConfigGenerator from '@d-zero/lint-staged-config';
 export default lintStagedConfigGenerator();
 ```
 
+### Markuplint
+
+Markuplint v5 を前提に、`markuplint`は`--no-allow-warnings`付きで実行し、警告（`warning`）でもコミットを止めます。コマンドの文字列は変更できないため、警告で止めたくない場合は、該当するルールの severity をMarkuplintの設定で変えてください。
+
+Markuplintは、パーサーが設定されていない拡張子のファイルを**エラーにせず黙って飛ばします**。既定のマッピングは`.pug`/`.jsx`/`.tsx`/`.vue`/`.svelte`/`.astro`も`markuplint`に渡すため、これらを検査するにはMarkuplintの設定で対応するパーサーを読み込んでください。表のパッケージは`@d-zero/markuplint-config`の依存に含まれないので、使うものを開発依存に追加します。
+
+| 拡張子          | Markuplintの設定                                                                                   |
+| --------------- | -------------------------------------------------------------------------------------------------- |
+| `.pug`          | `@markuplint/pug-parser`を追加し`@d-zero/markuplint-config/pug`をextends                           |
+| `.jsx` / `.tsx` | `@markuplint/jsx-parser`と`@markuplint/react-spec`を追加し`@d-zero/markuplint-config/jsx`をextends |
+| `.vue`          | `@markuplint/vue-parser`と`@markuplint/vue-spec`を設定                                             |
+| `.svelte`       | `@markuplint/svelte-parser`と`@markuplint/svelte-spec`を設定                                       |
+| `.astro`        | `@markuplint/astro-parser`を設定                                                                   |
+
 ### 拡張
 
 プロジェクトに合わせて設定を追加します。

package/dist/commands.js

@@ -1,7 +1,10 @@
 export const commands = {
     cspell: 'cspell --no-must-find-files --show-suggestions',
     eslint: 'eslint --fix',
-    markuplint: 'markuplint',
+    // Markuplint v5 は警告だけなら終了コード 0 で終わるため、Markuplint v4 と同じく警告でもコミットを止める
+    markuplint: 'markuplint --no-allow-warnings',
+    oxfmt: 'oxfmt --write',
+    oxlint: 'oxlint --fix',
     prettier: 'prettier --write',
     puglint: 'pug-lint',
     stylelint: 'stylelint --fix',

package/dist/default-mapping.js

@@ -1,22 +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'],
+    astro: ['oxlint', 'markuplint', 'prettier', 'cspell'],
+    cjs: ['oxlint', 'oxfmt', 'cspell'],
+    css: ['stylelint', 'oxfmt', 'cspell'],
+    cts: ['oxlint', 'oxfmt', 'cspell'],
+    html: ['markuplint', 'oxfmt', 'cspell'],
+    js: ['oxlint', 'oxfmt', 'cspell'],
+    json: ['oxfmt', 'cspell'],
+    jsx: ['oxlint', 'markuplint', 'oxfmt', 'cspell'],
+    md: ['oxfmt', 'textlint', 'cspell'],
+    mdx: ['oxfmt', 'textlint', 'cspell'],
+    mjs: ['oxlint', 'oxfmt', 'cspell'],
+    mts: ['oxlint', 'oxfmt', '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'],
+    scss: ['stylelint', 'oxfmt', 'cspell'],
+    svelte: ['oxlint', 'markuplint', 'oxfmt', 'cspell'],
+    ts: ['oxlint', 'oxfmt', 'cspell'],
+    tsx: ['oxlint', 'markuplint', 'oxfmt', 'cspell'],
+    vue: ['oxlint', 'markuplint', 'oxfmt', 'cspell'],
+    yaml: ['oxfmt', 'cspell'],
+    yml: ['oxfmt', 'cspell'],
 };

package/dist/index.d.ts

@@ -12,7 +12,8 @@ export interface DirectoryOptions {
 export type IgnoreMap = Partial<Record<CommandType, string | string[]>>;
 /**
  *
- * @param dirOptions
- * @param mapping
+ * @param dirOptions - The directory to search, or an options object
+ * @param mapping - The extension-to-command mapping to use instead of the default
+ * @returns A lint-staged command mapper
  */
-export default function (dirOptions?: string | DirectoryOptions, mapping?: CommandMappings): LintStagedCommandMapper;
+export default function lintStagedConfigGenerator(dirOptions?: string | DirectoryOptions, mapping?: CommandMappings): LintStagedCommandMapper;

package/dist/index.js

@@ -3,15 +3,16 @@ import { commands } from './commands.js';
 import { defaultMapping } from './default-mapping.js';
 /**
  *
- * @param dirOptions
- * @param mapping
+ * @param dirOptions - The directory to search, or an options object
+ * @param mapping - The extension-to-command mapping to use instead of the default
+ * @returns A lint-staged command mapper
  */
-export default function (dirOptions, mapping) {
+export default function lintStagedConfigGenerator(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 ignore = typeof dirOptions === 'string' ? undefined : dirOptions?.ignore;
         const baseDir = dir
             ? // 絶対パスかどうか
                 path.isAbsolute(dir)

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 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 CommandType = 'cspell' | 'eslint' | 'markuplint' | 'oxfmt' | 'oxlint' | '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

package/package.json

@@ -1,33 +1,33 @@
 {
 	"name": "@d-zero/lint-staged-config",
-	"version": "6.0.0-alpha.2",
+	"version": "6.0.0-alpha.3",
 	"description": "Configurations of lint-staged",
+	"license": "MIT",
+	"author": "D-ZERO Co., Ltd.",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/d-zero-dev/linters.git",
 		"directory": "packages/@d-zero/lint-staged-config"
 	},
-	"author": "D-ZERO Co., Ltd.",
-	"license": "MIT",
-	"publishConfig": {
-		"access": "public"
-	},
-	"engines": {
-		"node": ">=22.0.0"
-	},
+	"files": [
+		"dist"
+	],
 	"type": "module",
 	"exports": {
 		"import": "./dist/index.js",
 		"types": "./dist/index.d.ts"
 	},
-	"files": [
-		"dist"
-	],
+	"publishConfig": {
+		"access": "public"
+	},
 	"scripts": {
 		"build": "tsc"
 	},
 	"dependencies": {
-		"lint-staged": "16.3.1"
+		"lint-staged": "17.6.0"
+	},
+	"engines": {
+		"node": ">=22.0.0"
 	},
-	"gitHead": "b2d753122349a8d4dd4b7d484276d03fec498f0d"
+	"gitHead": "b03aff7503c8440b023d79f81c11d44887aa9fc9"
 }