@culur/config-eslint 1.0.4 → 1.0.6

package/src/rules/yarnrc-yml.ts

@@ -0,0 +1,47 @@
+import type { Rules, TypedFlatConfigItem } from '@antfu/eslint-config';
+import type { Linter } from 'eslint';
+
+type YamlSortKeys =
+  NonNullable<Rules['yaml/sort-keys']> extends Linter.RuleEntry<infer F>
+    ? F
+    : never;
+
+type YamlSortKeysRecord = YamlSortKeys[0];
+
+export const yamlOrder = {
+  type: 'asc',
+  caseSensitive: false,
+  natural: true,
+} as const;
+
+export const yamlYarnrcSortKeys = {
+  packageExtensions: {
+    packages: {
+      pathPattern: /^packageExtensions$/.source,
+      order: yamlOrder,
+    },
+    dependenciesTypes: {
+      pathPattern: /^packageExtensions(?:\[".+"\]|\.[^.]+)$/.source,
+      order: yamlOrder,
+    },
+    childPackages: {
+      pathPattern:
+        /^packageExtensions(?:\[".+"\]|\.[^.]+)\.(?:dependencies|peerDependencies|peerDependenciesMeta)$/
+          .source,
+      order: yamlOrder,
+    },
+  },
+} satisfies Record<string, Record<string, YamlSortKeysRecord>>;
+
+export const yamlYarnrcRules: TypedFlatConfigItem = {
+  name: 'culur/yarnrc-yml/rules',
+  files: ['.yarnrc.yml'],
+  rules: {
+    'yaml/sort-keys': [
+      'error',
+      yamlYarnrcSortKeys.packageExtensions.packages,
+      yamlYarnrcSortKeys.packageExtensions.dependenciesTypes,
+      yamlYarnrcSortKeys.packageExtensions.childPackages,
+    ],
+  },
+};

package/src/{overrides/types.test.ts → types/index.test.ts}

@@ -1,17 +1,17 @@
 import type { Awaitable } from 'vitest';
 import { expect, expectTypeOf, it } from 'vitest';
 import type { TypedFlatConfigItem } from '@antfu/eslint-config';
-import type { OverrideConfig } from './types';
-import { defineOverride } from './types';
+import type { OverrideConfig } from '.';
+import { defineOverride } from '.';
 
 it.each<OverrideConfig>([
   {
     name: 'object',
-    config: { rules: {} },
+    partialConfig: { rules: {} },
   },
   {
     name: 'function',
-    config: () => ({ rules: {} }),
+    entireConfig: () => ({ rules: {} }),
   },
 ])('config is $name', options => {
   const overrideParameter = defineOverride(options);

package/src/types/index.ts

@@ -0,0 +1,14 @@
+import type { Awaitable, TypedFlatConfigItem } from '@antfu/eslint-config';
+
+export type OverrideConfig = {
+  name: NonNullable<TypedFlatConfigItem['name']>;
+} & (
+  | { partialConfig: TypedFlatConfigItem } // merge with the original config
+  | { entireConfig: () => Awaitable<TypedFlatConfigItem> } // replace the entire config
+);
+
+export const defineOverride = (config: OverrideConfig) =>
+  [
+    config.name,
+    'partialConfig' in config ? config.partialConfig : config.entireConfig,
+  ] as const;

package/dist/chunk-4NIL3QOR.cjs

@@ -1,8 +0,0 @@
-'use strict';
-
-// src/overrides/types.ts
-var defineOverride = ({ name, config }) => [name, config];
-
-exports.defineOverride = defineOverride;
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-4NIL3QOR.cjs.map

package/dist/chunk-4NIL3QOR.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/overrides/types.ts"],"names":[],"mappings":";AAOO,IAAM,iBAAiB,CAAC,EAAE,MAAM,OAAO,MAC5C,CAAC,MAAM,MAAM","sourcesContent":["import type { Awaitable, TypedFlatConfigItem } from '@antfu/eslint-config';\n\nexport interface OverrideConfig {\n  name: NonNullable<TypedFlatConfigItem['name']>;\n  config: TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>);\n}\n\nexport const defineOverride = ({ name, config }: OverrideConfig) =>\n  [name, config] as const;\n"]}

package/dist/chunk-N7KES6RB.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/overrides/sort-package-json.ts"],"names":[],"mappings":";AAAA,OAAO,YAAY;AACnB,SAAS,mBAAmB,4BAA4B;AAGjD,IAAM,kBAAkC;AAAA,EAC7C,MAAM;AAAA,EACN,MAAM,SAAS;AACb,UAAM,CAAC,UAAU,IAAI,MAAM,qBAAqB;AAChD,WAAO,OAAO,WAAW,SAAS,QAAQ;AAC1C,WAAO,OAAO,WAAW,UAAU,QAAQ;AAE3C,UAAM,WAAW,WAAW,MAAM,iBAAiB;AACnD,WAAO,OAAO,aAAa,QAAQ;AAEnC,UAAM,CAAC,EAAE,OAAO,IAAI;AACpB,WAAO,OAAO,YAAY,QAAQ;AAElC,YAAQ,QAAQ;AAAA;AAAA,MAEd;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MAEA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF","sourcesContent":["import assert from 'node:assert';\nimport { sortPackageJson as sortPackageJsonAntfu } from '@antfu/eslint-config';\nimport type { OverrideConfig } from './types';\n\nexport const sortPackageJson: OverrideConfig = {\n  name: 'antfu/sort/package-json',\n  async config() {\n    const [configItem] = await sortPackageJsonAntfu();\n    assert(typeof configItem.name === 'string');\n    assert(typeof configItem.rules === 'object');\n\n    const sortKeys = configItem.rules['jsonc/sort-keys'];\n    assert(typeof sortKeys === 'object');\n\n    const [, options] = sortKeys;\n    assert(typeof options === 'object');\n\n    options.order = [\n      //? Project\n      'publisher',\n      'name',\n      'displayName',\n      'version',\n      'description',\n      'private',\n      'publishConfig',\n\n      //? Repository\n      'repository',\n      'bugs',\n      'homepage',\n      'funding',\n\n      //? Author & license\n      'contributors',\n      'author',\n      'license',\n\n      //? https://code.visualstudio.com/api/references/extension-manifest\n      'keywords',\n      'categories',\n\n      //? CDN\n      'unpkg',\n      'jsdelivr',\n\n      //? Export\n      'type', // module or commonjs\n      'main',\n      'types',\n      'typings', // synonymous with types\n      'typesVersions',\n      'exports',\n      'bin',\n      'files',\n      'workspaces',\n\n      //? https://code.visualstudio.com/api/references/extension-manifest\n      'icon',\n      'activationEvents',\n      'contributes',\n\n      //? Scripts\n      'scripts',\n\n      //? Node & packageManager\n      'volta',\n      'engines',\n      'packageManager',\n\n      //? Dependencies\n      'dependencies',\n      'devDependencies',\n      'peerDependencies',\n      'peerDependenciesMeta',\n      'bundleDependencies',\n      'optionalDependencies',\n\n      'pnpm',\n      'overrides',\n      'resolutions',\n\n      //? Lib config\n      'husky',\n      'simple-git-hooks',\n      'lint-staged',\n      'eslintConfig',\n    ];\n\n    return configItem;\n  },\n};\n"]}

package/dist/chunk-QYDW5TS2.js

@@ -1,17 +0,0 @@
-// src/rules/unicorn-filename-case.ts
-var unicornFilenameCase = {
-  files: ["**/*.ts", "**/*.js"],
-  rules: {
-    "unicorn/filename-case": [
-      "error",
-      {
-        case: "kebabCase",
-        ignore: ["README.md"]
-      }
-    ]
-  }
-};
-
-export { unicornFilenameCase };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-QYDW5TS2.js.map

package/dist/chunk-QYDW5TS2.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/rules/unicorn-filename-case.ts"],"names":[],"mappings":";AAEO,IAAM,sBAA2C;AAAA,EACtD,OAAO,CAAC,WAAW,SAAS;AAAA,EAC5B,OAAO;AAAA,IACL,yBAAyB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,QAAQ,CAAC,WAAW;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["import type { TypedFlatConfigItem } from '@antfu/eslint-config';\n\nexport const unicornFilenameCase: TypedFlatConfigItem = {\n  files: ['**/*.ts', '**/*.js'],\n  rules: {\n    'unicorn/filename-case': [\n      'error',\n      {\n        case: 'kebabCase',\n        ignore: ['README.md'],\n      },\n    ],\n  },\n};\n"]}

package/dist/chunk-TZB7IM2G.cjs

@@ -1,19 +0,0 @@
-'use strict';
-
-// src/rules/unicorn-filename-case.ts
-var unicornFilenameCase = {
-  files: ["**/*.ts", "**/*.js"],
-  rules: {
-    "unicorn/filename-case": [
-      "error",
-      {
-        case: "kebabCase",
-        ignore: ["README.md"]
-      }
-    ]
-  }
-};
-
-exports.unicornFilenameCase = unicornFilenameCase;
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-TZB7IM2G.cjs.map

package/dist/chunk-TZB7IM2G.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/rules/unicorn-filename-case.ts"],"names":[],"mappings":";AAEO,IAAM,sBAA2C;AAAA,EACtD,OAAO,CAAC,WAAW,SAAS;AAAA,EAC5B,OAAO;AAAA,IACL,yBAAyB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,QAAQ,CAAC,WAAW;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["import type { TypedFlatConfigItem } from '@antfu/eslint-config';\n\nexport const unicornFilenameCase: TypedFlatConfigItem = {\n  files: ['**/*.ts', '**/*.js'],\n  rules: {\n    'unicorn/filename-case': [\n      'error',\n      {\n        case: 'kebabCase',\n        ignore: ['README.md'],\n      },\n    ],\n  },\n};\n"]}

package/dist/chunk-WJDZNLOH.js

@@ -1,6 +0,0 @@
-// src/overrides/types.ts
-var defineOverride = ({ name, config }) => [name, config];
-
-export { defineOverride };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-WJDZNLOH.js.map

package/dist/chunk-WJDZNLOH.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/overrides/types.ts"],"names":[],"mappings":";AAOO,IAAM,iBAAiB,CAAC,EAAE,MAAM,OAAO,MAC5C,CAAC,MAAM,MAAM","sourcesContent":["import type { Awaitable, TypedFlatConfigItem } from '@antfu/eslint-config';\n\nexport interface OverrideConfig {\n  name: NonNullable<TypedFlatConfigItem['name']>;\n  config: TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>);\n}\n\nexport const defineOverride = ({ name, config }: OverrideConfig) =>\n  [name, config] as const;\n"]}

package/dist/chunk-ZIJ5OQW5.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/overrides/sort-package-json.ts"],"names":[],"mappings":";AAAA,OAAO,YAAY;AACnB,SAAS,mBAAmB,4BAA4B;AAGjD,IAAM,kBAAkC;AAAA,EAC7C,MAAM;AAAA,EACN,MAAM,SAAS;AACb,UAAM,CAAC,UAAU,IAAI,MAAM,qBAAqB;AAChD,WAAO,OAAO,WAAW,SAAS,QAAQ;AAC1C,WAAO,OAAO,WAAW,UAAU,QAAQ;AAE3C,UAAM,WAAW,WAAW,MAAM,iBAAiB;AACnD,WAAO,OAAO,aAAa,QAAQ;AAEnC,UAAM,CAAC,EAAE,OAAO,IAAI;AACpB,WAAO,OAAO,YAAY,QAAQ;AAElC,YAAQ,QAAQ;AAAA;AAAA,MAEd;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MAEA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF","sourcesContent":["import assert from 'node:assert';\nimport { sortPackageJson as sortPackageJsonAntfu } from '@antfu/eslint-config';\nimport type { OverrideConfig } from './types';\n\nexport const sortPackageJson: OverrideConfig = {\n  name: 'antfu/sort/package-json',\n  async config() {\n    const [configItem] = await sortPackageJsonAntfu();\n    assert(typeof configItem.name === 'string');\n    assert(typeof configItem.rules === 'object');\n\n    const sortKeys = configItem.rules['jsonc/sort-keys'];\n    assert(typeof sortKeys === 'object');\n\n    const [, options] = sortKeys;\n    assert(typeof options === 'object');\n\n    options.order = [\n      //? Project\n      'publisher',\n      'name',\n      'displayName',\n      'version',\n      'description',\n      'private',\n      'publishConfig',\n\n      //? Repository\n      'repository',\n      'bugs',\n      'homepage',\n      'funding',\n\n      //? Author & license\n      'contributors',\n      'author',\n      'license',\n\n      //? https://code.visualstudio.com/api/references/extension-manifest\n      'keywords',\n      'categories',\n\n      //? CDN\n      'unpkg',\n      'jsdelivr',\n\n      //? Export\n      'type', // module or commonjs\n      'main',\n      'types',\n      'typings', // synonymous with types\n      'typesVersions',\n      'exports',\n      'bin',\n      'files',\n      'workspaces',\n\n      //? https://code.visualstudio.com/api/references/extension-manifest\n      'icon',\n      'activationEvents',\n      'contributes',\n\n      //? Scripts\n      'scripts',\n\n      //? Node & packageManager\n      'volta',\n      'engines',\n      'packageManager',\n\n      //? Dependencies\n      'dependencies',\n      'devDependencies',\n      'peerDependencies',\n      'peerDependenciesMeta',\n      'bundleDependencies',\n      'optionalDependencies',\n\n      'pnpm',\n      'overrides',\n      'resolutions',\n\n      //? Lib config\n      'husky',\n      'simple-git-hooks',\n      'lint-staged',\n      'eslintConfig',\n    ];\n\n    return configItem;\n  },\n};\n"]}

package/dist/overrides/types.cjs

@@ -1,12 +0,0 @@
-'use strict';
-
-var chunk4NIL3QOR_cjs = require('../chunk-4NIL3QOR.cjs');
-
-
-
-Object.defineProperty(exports, "defineOverride", {
-  enumerable: true,
-  get: function () { return chunk4NIL3QOR_cjs.defineOverride; }
-});
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=types.cjs.map

package/dist/overrides/types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/overrides/types.d.cts

@@ -1,9 +0,0 @@
-import { TypedFlatConfigItem, Awaitable } from '@antfu/eslint-config';
-
-interface OverrideConfig {
-    name: NonNullable<TypedFlatConfigItem['name']>;
-    config: TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>);
-}
-declare const defineOverride: ({ name, config }: OverrideConfig) => readonly [string, TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>)];
-
-export { type OverrideConfig, defineOverride };

package/dist/overrides/types.d.ts

@@ -1,9 +0,0 @@
-import { TypedFlatConfigItem, Awaitable } from '@antfu/eslint-config';
-
-interface OverrideConfig {
-    name: NonNullable<TypedFlatConfigItem['name']>;
-    config: TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>);
-}
-declare const defineOverride: ({ name, config }: OverrideConfig) => readonly [string, TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>)];
-
-export { type OverrideConfig, defineOverride };

package/dist/overrides/types.js

@@ -1,3 +0,0 @@
-export { defineOverride } from '../chunk-WJDZNLOH.js';
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=types.js.map

package/dist/overrides/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/rules/unicorn-filename-case.cjs

@@ -1,12 +0,0 @@
-'use strict';
-
-var chunkTZB7IM2G_cjs = require('../chunk-TZB7IM2G.cjs');
-
-
-
-Object.defineProperty(exports, "unicornFilenameCase", {
-  enumerable: true,
-  get: function () { return chunkTZB7IM2G_cjs.unicornFilenameCase; }
-});
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=unicorn-filename-case.cjs.map

package/dist/rules/unicorn-filename-case.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/rules/unicorn-filename-case.d.cts

@@ -1,5 +0,0 @@
-import { TypedFlatConfigItem } from '@antfu/eslint-config';
-
-declare const unicornFilenameCase: TypedFlatConfigItem;
-
-export { unicornFilenameCase };

package/dist/rules/unicorn-filename-case.d.ts

@@ -1,5 +0,0 @@
-import { TypedFlatConfigItem } from '@antfu/eslint-config';
-
-declare const unicornFilenameCase: TypedFlatConfigItem;
-
-export { unicornFilenameCase };

package/dist/rules/unicorn-filename-case.js

@@ -1,3 +0,0 @@
-export { unicornFilenameCase } from '../chunk-QYDW5TS2.js';
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=unicorn-filename-case.js.map

package/dist/rules/unicorn-filename-case.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":""}

package/src/overrides/types.ts

@@ -1,9 +0,0 @@
-import type { Awaitable, TypedFlatConfigItem } from '@antfu/eslint-config';
-
-export interface OverrideConfig {
-  name: NonNullable<TypedFlatConfigItem['name']>;
-  config: TypedFlatConfigItem | (() => Awaitable<TypedFlatConfigItem>);
-}
-
-export const defineOverride = ({ name, config }: OverrideConfig) =>
-  [name, config] as const;

package/src/rules/unicorn-filename-case.ts

@@ -1,14 +0,0 @@
-import type { TypedFlatConfigItem } from '@antfu/eslint-config';
-
-export const unicornFilenameCase: TypedFlatConfigItem = {
-  files: ['**/*.ts', '**/*.js'],
-  rules: {
-    'unicorn/filename-case': [
-      'error',
-      {
-        case: 'kebabCase',
-        ignore: ['README.md'],
-      },
-    ],
-  },
-};