@w5s/eslint-config 3.11.0 → 3.12.0

package/src/config/e18e.ts

@@ -1,7 +1,10 @@
 import { interopDefault } from '@w5s/dev';
-import { StylisticConfig, type Config, type PluginOptionsBase } from '../type.js';
+
 import type { RuleOptions } from '../typegen/e18e.js';
+
 import { sourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
 
 const defaultFiles = [sourceGlob];
 
@@ -11,7 +14,7 @@ const defaultFiles = [sourceGlob];
  */
 export async function e18e(options: e18e.Options = {}) {
   const [e18ePlugin] = await Promise.all([interopDefault(import('@e18e/eslint-plugin'))] as const);
-  const { files = defaultFiles, rules = {}, stylistic = true, modernization = true, moduleReplacements = false, performanceImprovements = true } = options;
+  const { files, modernization = true, moduleReplacements = false, performanceImprovements = true, rules = {}, stylistic = true } = options;
   const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
 
   return [
@@ -22,8 +25,8 @@ export async function e18e(options: e18e.Options = {}) {
       },
     },
     {
+      files: withDefaultFiles(files, defaultFiles),
       name: 'w5s/e18e/rules',
-      files,
       rules: {
         ...modernization ? e18ePlugin.configs.modernization.rules : {},
         ...moduleReplacements ? e18ePlugin.configs.moduleReplacements.rules : {},
@@ -44,8 +47,6 @@ export async function e18e(options: e18e.Options = {}) {
 }
 
 export namespace e18e {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {
     /**
      * Include modernization default configuration
@@ -68,4 +69,6 @@ export namespace e18e {
      */
     performanceImprovements?: boolean;
   }
+
+  export type Rules = RuleOptions;
 }

package/src/config/es.ts

@@ -1,10 +1,12 @@
-import globals from 'globals';
 import eslintConfig from '@eslint/js';
 import { Project } from '@w5s/dev';
-import { type PluginOptionsBase, type Config } from '../type.js';
+import globals from 'globals';
+
 import type { RuleOptions } from '../typegen/jsonc.js';
-import { esRules } from '../rules/esRules.js';
+
 import { esSourceGlob } from '../glob.js';
+import { esRules } from '../rules/esRules.js';
+import { type Config, type PluginOptionsBase } from '../type.js';
 
 const defaultFiles = [esSourceGlob];
 
@@ -13,7 +15,6 @@ export async function es(options: es.Options) {
 
   return [
     {
-      name: 'w5s/es/setup',
       languageOptions: {
         ecmaVersion: Project.ecmaVersion(),
         globals: {
@@ -39,10 +40,11 @@ export async function es(options: es.Options) {
       linterOptions: {
         reportUnusedDisableDirectives: true,
       },
+      name: 'w5s/es/setup',
     },
     {
-      name: 'w5s/es/rules',
       files: defaultFiles,
+      name: 'w5s/es/rules',
       rules: {
         ...(recommended ? es['recommended'] : {}),
         ...rules,
@@ -60,7 +62,7 @@ es['recommended'] = {
 };
 
 export namespace es {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/ignores.ts

@@ -1,4 +1,4 @@
-import { eslintIgnores, type ESLintIgnoreOptions } from '@w5s/eslint-config-ignore';
+import { type ESLintIgnoreOptions, eslintIgnores } from '@w5s/eslint-config-ignore';
 
 export async function ignores(options: ignores.Options = {}) {
   const config = await eslintIgnores(options);

package/src/config/imports.ts

@@ -1,9 +1,11 @@
 import { interopDefault } from '@w5s/dev';
-import { type PluginOptionsBase, StylisticConfig, type Config } from '../type.js';
+
 import type { RuleOptions } from '../typegen/import.js';
 
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
+
 export async function imports(options: imports.Options = {}) {
-  const { rules = {}, recommended = true, stylistic = true } = options;
+  const { recommended = true, rules = {}, stylistic = true } = options;
   const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
   const [importPlugin] = await Promise.all([interopDefault(import('eslint-plugin-import'))] as const);
   return [
@@ -42,7 +44,7 @@ imports['stylistic'] = {
 };
 
 export namespace imports {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/jsdoc.ts

@@ -1,14 +1,17 @@
 import { interopDefault } from '@w5s/dev';
-import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+
 import type { RuleOptions } from '../typegen/jsdoc.js';
+
 import { sourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
 
 const defaultFiles = [sourceGlob];
 
 export async function jsdoc(options: jsdoc.Options = {}): Promise<readonly Config[]> {
   const [jsdocPlugin] = await Promise.all([interopDefault(import('eslint-plugin-jsdoc'))] as const);
   const {
-    files = defaultFiles,
+    files,
     recommended = true,
     rules = {},
     stylistic = true,
@@ -23,8 +26,8 @@ export async function jsdoc(options: jsdoc.Options = {}): Promise<readonly Confi
       },
     },
     {
+      files: withDefaultFiles(files, defaultFiles),
       name: 'w5s/jsdoc/rules',
-      files,
       rules: {
         ...(recommended ? jsdocPlugin.configs['flat/recommended-typescript-flavor'].rules : {}),
 
@@ -61,7 +64,7 @@ export async function jsdoc(options: jsdoc.Options = {}): Promise<readonly Confi
 }
 
 export namespace jsdoc {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/jsonc.ts

@@ -1,8 +1,11 @@
 /* cSpell:disable */
 import { interopDefault } from '@w5s/dev';
-import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+
 import type { RuleOptions } from '../typegen/jsonc.js';
+
 import { jsonSourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
 
 const defaultFiles = [jsonSourceGlob];
 
@@ -12,7 +15,7 @@ export async function jsonc(options: jsonc.Options = {}): Promise<readonly Confi
     interopDefault(import('jsonc-eslint-parser')),
   ] as const);
   const {
-    files = defaultFiles,
+    files,
     recommended = true,
     rules = {},
     stylistic = true,
@@ -27,7 +30,7 @@ export async function jsonc(options: jsonc.Options = {}): Promise<readonly Confi
       },
     },
     {
-      files,
+      files: withDefaultFiles(files, defaultFiles),
       languageOptions: {
         parser: jsoncParser,
       },
@@ -56,25 +59,6 @@ export async function jsonc(options: jsonc.Options = {}): Promise<readonly Confi
   ] as [Config, Config, Config, Config] satisfies Array<Config>;
 }
 
-function sortTsconfigJson() {
-  return {
-    files: ['**/tsconfig*.json'],
-    rules: {
-      'jsonc/sort-keys': [
-        'error',
-        {
-          order: ['$schema', 'display', 'extends', 'compilerOptions', 'include', 'exclude', 'files', 'references'],
-          pathPattern: '^$',
-        },
-        {
-          order: { type: 'asc' },
-          pathPattern: '.*',
-        },
-      ],
-    },
-  };
-}
-
 function sortPackageJson() {
   return {
     files: ['**/package.json'],
@@ -235,8 +219,27 @@ function sortPackageJson() {
   };
 }
 
-export namespace jsonc {
-  export type Rules = RuleOptions;
+function sortTsconfigJson() {
+  return {
+    files: ['**/tsconfig*.json'],
+    rules: {
+      'jsonc/sort-keys': [
+        'error',
+        {
+          order: ['$schema', 'display', 'extends', 'compilerOptions', 'include', 'exclude', 'files', 'references'],
+          pathPattern: '^$',
+        },
+        {
+          order: { type: 'asc' },
+          pathPattern: '.*',
+        },
+      ],
+    },
+  };
+}
 
+export namespace jsonc {
   export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/markdown.ts

@@ -1,15 +1,19 @@
 import { interopDefault, Project } from '@w5s/dev';
 import { mergeProcessors, processorPassThrough } from 'eslint-merge-processors';
-import { StylisticConfig, type Config, type PluginOptionsBase } from '../type.js';
+
 import type { RuleOptions } from '../typegen/markdown.js';
 
-const defaultFiles = [`**/${Project.extensionsToGlob(Project.queryExtensions(['markdown']))}`];
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
+
+const defaultFiles = [`**/${Project.extensionsToGlob(Project.queryExtensions(['markdown']))}`, '**/CHANGELOG.md', '**/CODE_OF_CONDUCT.md'];
 
 export async function markdown(options: markdown.Options = {}) {
   const [markdownPlugin] = await Promise.all([interopDefault(import('@eslint/markdown'))] as const);
   const {
+    files,
     language = 'markdown/gfm',
-    files = defaultFiles,
+    languageOptions,
     recommended = true,
     rules = {},
     stylistic = true,
@@ -24,8 +28,12 @@ export async function markdown(options: markdown.Options = {}) {
       },
     },
     {
-      files,
-      language: language,
+      files: withDefaultFiles(files, defaultFiles),
+      language,
+      languageOptions: {
+        frontmatter: 'yaml',
+        ...languageOptions,
+      },
       name: 'w5s/markdown/rules',
       // eslint-disable-next-line ts/no-non-null-assertion
       processor: mergeProcessors([markdownPlugin.processors!.markdown, processorPassThrough]),
@@ -39,12 +47,21 @@ export async function markdown(options: markdown.Options = {}) {
 }
 
 export namespace markdown {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {
     /**
      * Default to 'markdown/gfm' (Github Flavored Markdown)
      */
-    language?: 'markdown/gfm' | 'markdown/commonmark';
+    language?: 'markdown/commonmark' | 'markdown/gfm';
+
+    /**
+     * Default to 'yaml'
+     * If you want to use TOML frontmatter, set this to 'toml'
+     * If you want to disable frontmatter parsing, set this to undefined
+     */
+    languageOptions?: {
+      frontmatter?: 'toml' | 'yaml';
+    };
   }
+
+  export type Rules = RuleOptions;
 }

package/src/config/next.ts

@@ -1,7 +1,10 @@
 import { ESLintConfig, interopDefault } from '@w5s/dev';
-import { type Config, type PluginOptionsBase } from '../type.js';
+
 import type { RuleOptions } from '../typegen/next.js';
+
 import { sourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase } from '../type.js';
 
 const defaultFiles = [sourceGlob];
 
@@ -9,7 +12,7 @@ export async function next(options: next.Options = {}) {
   const [nextPlugin] = await Promise.all([
     interopDefault(import('@next/eslint-plugin-next')),
   ] as const);
-  const { files = defaultFiles, recommended = true, rules = {} } = options;
+  const { files, recommended = true, rules = {} } = options;
 
   return [
     {
@@ -19,8 +22,7 @@ export async function next(options: next.Options = {}) {
       },
     },
     {
-      name: 'w5s/next/rules',
-      files,
+      files: withDefaultFiles(files, defaultFiles),
       languageOptions: {
         parserOptions: {
           ecmaFeatures: {
@@ -29,22 +31,23 @@ export async function next(options: next.Options = {}) {
         },
         sourceType: 'module',
       },
-      settings: {
-        react: {
-          version: 'detect',
-        },
-      },
+      name: 'w5s/next/rules',
       rules: {
         ...(recommended ? ESLintConfig.renameRules(nextPlugin.configs.recommended.rules ?? {}, { '@next/next': 'next' }) : {}),
         ...(recommended ? ESLintConfig.renameRules(nextPlugin.configs['core-web-vitals'].rules ?? {}, { '@next/next': 'next' }) : {}),
         ...rules,
       },
+      settings: {
+        react: {
+          version: 'detect',
+        },
+      },
     },
   ] as [Config, Config] satisfies Array<Config>;
 }
 
 export namespace next {
-  export type Rules = RuleOptions;
-
   export interface Options extends Omit<PluginOptionsBase<Rules>, 'stylistic'> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/node.ts

@@ -1,7 +1,9 @@
 import { interopDefault } from '@w5s/dev';
-import { type Config, type PluginOptionsBase } from '../type.js';
+
 import type { RuleOptions } from '../typegen/node.js';
 
+import { type Config, type PluginOptionsBase } from '../type.js';
+
 export async function node(options: node.Options = {}) {
   const [nodePlugin] = await Promise.all([
     interopDefault(import('eslint-plugin-n')),
@@ -41,7 +43,7 @@ export async function node(options: node.Options = {}) {
 }
 
 export namespace node {
-  export type Rules = RuleOptions;
-
   export interface Options extends Omit<PluginOptionsBase<Rules>, 'files' | 'stylistic'> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/perfectionist.ts

@@ -0,0 +1,44 @@
+import { interopDefault } from '@w5s/dev';
+
+import type { RuleOptions } from '../typegen/perfectionist.js';
+
+import { sourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
+
+const defaultFiles = [sourceGlob];
+
+export async function perfectionist(options: perfectionist.Options = {}) {
+  const [perfectionistPlugin] = await Promise.all([interopDefault(import('eslint-plugin-perfectionist'))] as const);
+  const {
+    files,
+    recommended = true,
+    rules = {},
+    stylistic = true,
+  } = options;
+  const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
+
+  return [
+    {
+      name: 'w5s/perfectionist/setup',
+      plugins: {
+        perfectionist: perfectionistPlugin,
+      },
+    },
+    {
+      files: withDefaultFiles(files, defaultFiles),
+      name: 'w5s/perfectionist/rules',
+      rules: {
+        ...(recommended ? perfectionistPlugin.configs['recommended-natural'].rules : {}),
+        ...(stylisticEnabled ? {} : {}),
+        ...rules,
+      },
+    },
+  ] as [Config, Config] satisfies Array<Config>;
+}
+
+export namespace perfectionist {
+  export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
+}

package/src/config/react.ts

@@ -1,7 +1,10 @@
 import { interopDefault } from '@w5s/dev';
-import { type Config, type PluginOptionsBase } from '../type.js';
+
 import type { RuleOptions } from '../typegen/react.js';
+
 import { sourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase } from '../type.js';
 
 const defaultFiles = [sourceGlob];
 
@@ -9,7 +12,7 @@ export async function react(options: react.Options = {}) {
   const [reactPlugin] = await Promise.all([
     interopDefault(import('@eslint-react/eslint-plugin')),
   ] as const);
-  const { files = defaultFiles, recommended, rules = {} } = options;
+  const { files, recommended, rules = {} } = options;
   return [
     {
       name: 'w5s/react/setup',
@@ -18,8 +21,7 @@ export async function react(options: react.Options = {}) {
       },
     },
     {
-      name: 'w5s/react/rules',
-      files,
+      files: withDefaultFiles(files, defaultFiles),
       languageOptions: {
         parserOptions: {
           ecmaFeatures: {
@@ -28,6 +30,7 @@ export async function react(options: react.Options = {}) {
         },
         sourceType: 'module',
       },
+      name: 'w5s/react/rules',
       rules: {
         ...(recommended ? reactPlugin.configs['recommended'].rules : {}),
         ...rules,
@@ -37,7 +40,7 @@ export async function react(options: react.Options = {}) {
 }
 
 export namespace react {
-  export type Rules = RuleOptions;
-
   export interface Options extends Omit<PluginOptionsBase<Rules>, 'stylistic'> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/stylistic.ts

@@ -1,7 +1,9 @@
 import { interopDefault } from '@w5s/dev';
-import { StylisticConfig, type PluginOptionsBase, type Config, type StylisticParameters } from '../type.js';
+
 import type { RuleOptions } from '../typegen/style.js';
 
+import { type Config, type PluginOptionsBase, StylisticConfig, type StylisticParameters } from '../type.js';
+
 export async function stylistic(options: stylistic.Options = {}) {
   const [stylisticPlugin] = await Promise.all([
     interopDefault(import('@stylistic/eslint-plugin')),
@@ -33,8 +35,8 @@ export async function stylistic(options: stylistic.Options = {}) {
               ...config.rules,
               'style/arrow-parens': ['error', 'always'],
               'style/brace-style': ['error', '1tbs'],
-              'style/operator-linebreak': ['error', 'after', { overrides: { ':': 'before', '?': 'before', '|>': 'before', '|': 'before' } }],
-              'style/quotes': ['error', quotes ?? StylisticConfig.default.quotes, { avoidEscape: true, allowTemplateLiterals: 'always' }],
+              'style/operator-linebreak': ['error', 'after', { overrides: { ':': 'before', '?': 'before', '|': 'before', '|>': 'before' } }],
+              'style/quotes': ['error', quotes ?? StylisticConfig.default.quotes, { allowTemplateLiterals: 'always', avoidEscape: true }],
             }
           : {}),
         ...rules,
@@ -44,7 +46,7 @@ export async function stylistic(options: stylistic.Options = {}) {
 }
 
 export namespace stylistic {
-  export type Rules = RuleOptions;
-
   export interface Options extends Pick<PluginOptionsBase<Rules>, 'rules'>, StylisticParameters {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/test.ts

@@ -1,7 +1,10 @@
 import { ESLintConfig, interopDefault, Project } from '@w5s/dev';
-import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+
 import type { RuleOptions } from '../typegen/test.js';
 
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
+
 const sourceGlob = Project.extensionsToGlob(Project.sourceExtensions());
 const defaultFiles = [
   `**/__mocks__/**/${sourceGlob}`,
@@ -13,7 +16,7 @@ export async function test(options: test.Options = {}) {
   const [vitestPlugin] = await Promise.all([
     interopDefault(import('@vitest/eslint-plugin')),
   ] as const);
-  const { files = defaultFiles, recommended = true, rules = {}, stylistic = true } = options;
+  const { files, recommended = true, rules = {}, stylistic = true } = options;
   const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
 
   return [
@@ -24,7 +27,7 @@ export async function test(options: test.Options = {}) {
       },
     },
     {
-      files,
+      files: withDefaultFiles(files, defaultFiles),
       name: 'w5s/test/rules',
       rules: {
         ...(recommended
@@ -32,9 +35,9 @@ export async function test(options: test.Options = {}) {
               vitest: 'test',
             })
           : {}),
-        'test/valid-title': ESLintConfig.fixme(undefined),
-
         'e18e/prefer-static-regex': 'off',
+
+        'test/valid-title': ESLintConfig.fixme(undefined),
         ...(stylisticEnabled
           ? {}
           : {}),
@@ -45,7 +48,7 @@ export async function test(options: test.Options = {}) {
 }
 
 export namespace test {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
 }

package/src/config/ts.ts

@@ -1,9 +1,12 @@
 /* eslint-disable ts/no-non-null-assertion */
 import { ESLintConfig, interopDefault } from '@w5s/dev';
-import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
+
 import type { RuleOptions } from '../typegen/ts.js';
-import { tsRules } from '../rules/tsRules.js';
+
 import { tsSourceGlob } from '../glob.js';
+import { withDefaultFiles } from '../internal/withDefaultFiles.js';
+import { tsRules } from '../rules/tsRules.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
 
 const defaultFiles = [tsSourceGlob];
 
@@ -15,7 +18,7 @@ export async function ts(options: ts.Options = {}) {
   const tsRecommendedRules = tsPlugin.configs['eslint-recommended']!.overrides![0]!.rules!;
   const tsStrictRules = tsPlugin.configs['strict']!.rules!;
   const tsTypeCheckedRules = tsPlugin.configs['recommended-type-checked-only']!.rules!;
-  const { files = defaultFiles, rules = {}, stylistic = true, typeChecked = false } = options;
+  const { files, rules = {}, stylistic = true, typeChecked = false } = options;
   const { enabled: stylisticEnabled } = StylisticConfig.from(stylistic);
 
   return [
@@ -26,7 +29,7 @@ export async function ts(options: ts.Options = {}) {
       },
     },
     {
-      files,
+      files: withDefaultFiles(files, defaultFiles),
       languageOptions: {
         parser: tsParser,
         parserOptions: {
@@ -65,12 +68,12 @@ export async function ts(options: ts.Options = {}) {
           },
         ] as const)
       : []),
-  ] as [Config, Config] | [Config, Config, Config] satisfies Array<Config>;
+  ] as [Config, Config, Config] | [Config, Config] satisfies Array<Config>;
 }
 export namespace ts {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {
     typeChecked?: boolean;
   }
+
+  export type Rules = RuleOptions;
 }

package/src/config/unicorn.ts

@@ -1,7 +1,9 @@
 import { interopDefault } from '@w5s/dev';
-import { StylisticConfig, type Config, type PluginOptionsBase } from '../type.js';
+
 import type { RuleOptions } from '../typegen/unicorn.js';
+
 import { sourceGlob } from '../glob.js';
+import { type Config, type PluginOptionsBase, StylisticConfig } from '../type.js';
 
 const defaultFiles = [sourceGlob];
 
@@ -18,8 +20,8 @@ export async function unicorn(options: unicorn.Options = {}) {
       },
     },
     {
-      name: 'w5s/unicorn/rules',
       files,
+      name: 'w5s/unicorn/rules',
       rules: {
         ...(recommended && unicornPlugin.configs['unopinionated'].rules),
         // Disabled for safety
@@ -40,8 +42,8 @@ export async function unicorn(options: unicorn.Options = {}) {
     },
     // TODO: move to another file ?
     {
-      name: 'w5s/unicorn/overrides',
       files: ['**/*.config.cjs', '**/*.config.js'],
+      name: 'w5s/unicorn/overrides',
       rules: {
         'unicorn/prefer-module': 'off',
       },
@@ -50,7 +52,7 @@ export async function unicorn(options: unicorn.Options = {}) {
 }
 
 export namespace unicorn {
-  export type Rules = RuleOptions;
-
   export interface Options extends PluginOptionsBase<Rules> {}
+
+  export type Rules = RuleOptions;
 }