@culur/config-eslint 1.8.0 → 1.9.0

package/src/overrides/vue-rules.test.ts

@@ -0,0 +1,19 @@
+import { assert, it } from 'vitest';
+import { defineOverride } from '~/types';
+import { vueRules } from './vue-rules';
+
+it('should be valid rule', async () => {
+  assert('partialConfig' in vueRules);
+  const [name, config] = defineOverride(vueRules);
+
+  assert(name === 'antfu/vue/rules');
+  assert(typeof config === 'object');
+  const configLocal = config;
+
+  assert(configLocal.rules);
+
+  assert.containsAllKeys(configLocal.rules, [
+    'vue/singleline-html-element-content-newline',
+    'vue/multiline-html-element-content-newline',
+  ]);
+});

package/src/rules/filename.test.ts

@@ -0,0 +1,7 @@
+import type { TypedFlatConfigItem } from '@antfu/eslint-config';
+import { expectTypeOf, it } from 'vitest';
+import { filenameRules } from './filename';
+
+it('should be valid rule', async () => {
+  expectTypeOf(filenameRules).toEqualTypeOf<TypedFlatConfigItem>();
+});

package/src/rules/filename.ts

@@ -22,6 +22,7 @@ export const filenameRules: TypedFlatConfigItem = {
           '^CHANGELOG\\.md',
           '^CONTRIBUTING\\.md',
           '^README\\.md',
+          '^__tests__',
         ],
       },
     ],

package/src/rules/index.ts

@@ -1,4 +1,9 @@
 export { filenameRules } from './filename';
+export {
+  pnpmWorkspaceSortKeys,
+  pnpmWorkspaceSortSequenceValues,
+  pnpmWorkspaceYamlRules,
+} from './pnpm-workspace-yaml';
 export { renovateJsonRules } from './renovate-json';
 export { yamlOrder } from './yaml-order';
-export { yarnrcYmlRules, yarnrcYmlSortKeys } from './yml-yarnrc';
+export { yarnrcYmlRules, yarnrcYmlSortKeys } from './yarnrc-yml';

package/src/rules/pnpm-workspace-yaml.test.ts

@@ -0,0 +1,7 @@
+import type { TypedFlatConfigItem } from '@antfu/eslint-config';
+import { expectTypeOf, it } from 'vitest';
+import { pnpmWorkspaceYamlRules } from './pnpm-workspace-yaml';
+
+it('should be valid rule', async () => {
+  expectTypeOf(pnpmWorkspaceYamlRules).toEqualTypeOf<TypedFlatConfigItem>();
+});

package/src/rules/pnpm-workspace-yaml.ts

@@ -0,0 +1,189 @@
+import type { TypedFlatConfigItem } from '@antfu/eslint-config';
+import type {
+  YamlSortKeysRecord,
+  YamlSortSequenceValuesRecord,
+} from './yaml-order';
+import { yamlOrder } from './yaml-order';
+
+export const pnpmWorkspaceSortKeys = {
+  root: {
+    pathPattern: /^$/.source,
+    order: [
+      //! Monorepo
+      'packages',
+      'catalog',
+
+      //! Dependency Resolution
+      'overrides',
+      'packageExtensions',
+      'allowedDeprecatedVersions',
+      'updateConfig',
+      'supportedArchitectures',
+      'ignoredOptionalDependencies',
+      'minimumReleaseAge',
+      'minimumReleaseAgeExclude',
+      'minimumReleaseAgeIgnoreMissingTime',
+      'minimumReleaseAgeStrict',
+      'trustPolicy',
+      'trustPolicyExclude',
+      'trustPolicyIgnoreAfter',
+      'trustLockfile',
+      'blockExoticSubdeps',
+      'registries',
+      'namedRegistries',
+
+      //! Dependency Hoisting Settings
+      'hoist',
+      'hoistWorkspacePackages',
+      'hoistPattern',
+      'publicHoistPattern',
+      'shamefullyHoist',
+
+      //! Node-Modules Settings
+      'modulesDir',
+      'nodeLinker',
+      'symlink',
+      'enableModulesDir',
+      'virtualStoreDir',
+      'virtualStoreDirMaxLength',
+      'virtualStoreOnly',
+      'packageImportMethod',
+      'modulesCacheMaxAge',
+      'dlxCacheMaxAge',
+      'enableGlobalVirtualStore',
+
+      //! Store Settings
+      'storeDir',
+      'verifyStoreIntegrity',
+      'useRunningStoreServer',
+      'strictStorePkgContentCheck',
+
+      //! Network Settings
+      'httpsProxy',
+      'httpProxy',
+      'noProxy',
+      'localAddress',
+      'maxsockets',
+      'strictSsl',
+
+      //! Lockfile Settings
+      'lockfile',
+      'preferFrozenLockfile',
+      'lockfileIncludeTarballUrl',
+      'gitBranchLockfile',
+      'mergeGitBranchLockfilesBranchPattern',
+      'peersSuffixMaxLength',
+
+      //! Request Settings
+      'gitShallowHosts',
+      'networkConcurrency',
+      'fetchRetries',
+      'fetchRetryFactor',
+      'fetchRetryMintimeout',
+      'fetchRetryMaxtimeout',
+      'fetchTimeout',
+      'fetchWarnTimeoutMs',
+      'fetchMinSpeedKiBps',
+
+      //! Peer Dependency Settings
+      'autoInstallPeers',
+      'dedupePeerDependents',
+      'dedupePeers',
+      'strictPeerDependencies',
+      'resolvePeersFromWorkspaceRoot',
+      'peerDependencyRules',
+
+      //! CLI Settings
+      '[no-]color',
+      'loglevel',
+      'useBetaCli',
+      'recursiveInstall',
+      'engineStrict',
+      'npmPath',
+      'pmOnFail',
+      'ignoreWorkspaceRootCheck',
+
+      //! Build Settings
+      'ignoreScripts',
+      'childConcurrency',
+      'sideEffectsCache',
+      'sideEffectsCacheReadonly',
+      'unsafePerm',
+      'nodeOptions',
+      'verifyDepsBeforeRun',
+      'strictDepBuilds',
+      'allowBuilds',
+      'dangerouslyAllowAllBuilds',
+
+      //! Node.js Settings
+      'nodeVersion',
+      'runtimeOnFail',
+      'nodeDownloadMirrors',
+
+      //! Other Settings
+      'savePrefix',
+      'tag',
+      'globalDir',
+      'globalBinDir',
+      'npmrcAuthFile',
+      'stateDir',
+      'cacheDir',
+      'useStderr',
+      'updateNotifier',
+      'preferSymlinkedExecutables',
+      'ignoreCompatibilityDb',
+      'resolutionMode',
+      'registrySupportsTimeField',
+      'extendNodePath',
+      'deployAllFiles',
+      'dedupeDirectDeps',
+      'optimisticRepeatInstall',
+      'requiredScripts',
+      'enablePrePostScripts',
+      'scriptShell',
+      'shellEmulator',
+      'catalogMode',
+      'ci',
+      'cleanupUnusedCatalogs',
+    ],
+  },
+  packages: {
+    pathPattern: `^(${[
+      'overrides',
+      'packageExtensions',
+      'allowedDeprecatedVersions',
+      'updateConfig',
+      'supportedArchitectures',
+      'registries',
+      'namedRegistries',
+    ].join('|')})$`,
+    order: yamlOrder,
+  },
+} satisfies Record<string, YamlSortKeysRecord>;
+
+export const pnpmWorkspaceSortSequenceValues = {
+  packages: {
+    pathPattern: `^(${[
+      'ignoredOptionalDependencies',
+      'minimumReleaseAgeExclude',
+      'trustPolicyExclude',
+    ].join('|')})$`,
+    order: yamlOrder,
+  },
+} satisfies Record<string, YamlSortSequenceValuesRecord>;
+
+export const pnpmWorkspaceYamlRules: TypedFlatConfigItem = {
+  name: 'culur/pnpm-workspace-yaml/rules',
+  files: ['pnpm-workspace.yaml'],
+  rules: {
+    'yaml/sort-keys': [
+      'error',
+      pnpmWorkspaceSortKeys.root,
+      pnpmWorkspaceSortKeys.packages,
+    ],
+    'yaml/sort-sequence-values': [
+      'error',
+      pnpmWorkspaceSortSequenceValues.packages,
+    ],
+  },
+};

package/src/rules/renovate-json/index.test.ts

@@ -0,0 +1,7 @@
+import type { TypedFlatConfigItem } from '@antfu/eslint-config';
+import { expectTypeOf, it } from 'vitest';
+import { renovateJsonRules } from '.';
+
+it('should be valid rule', async () => {
+  expectTypeOf(renovateJsonRules).toEqualTypeOf<TypedFlatConfigItem>();
+});

package/src/rules/renovate-json/index.ts

@@ -20,11 +20,11 @@ export const renovateJsonRules: TypedFlatConfigItem = {
     'jsonc/sort-keys': [
       'error',
       {
-        pathPattern: '^$',
+        pathPattern: /^$/.source,
         order: rootOrder,
       },
       {
-        pathPattern: '^packageRules\\[\\d+\\]$',
+        pathPattern: /^packageRules\[\d+\]$/.source,
         order: packageRuleOrder,
       },
     ],

package/src/rules/yaml-order.ts

@@ -1,5 +1,24 @@
+import type { Rules } from '@antfu/eslint-config';
+import type { Linter } from 'eslint';
+
 export const yamlOrder = {
   type: 'asc',
   caseSensitive: false,
   natural: true,
 } as const;
+
+export type YamlSortKeys =
+  NonNullable<Rules['yaml/sort-keys']> extends Linter.RuleEntry<infer F>
+    ? F
+    : never;
+
+export type YamlSortKeysRecord = YamlSortKeys[0];
+
+export type YamlSortSequenceValues =
+  NonNullable<Rules['yaml/sort-sequence-values']> extends Linter.RuleEntry<
+    infer F
+  >
+    ? F
+    : never;
+
+export type YamlSortSequenceValuesRecord = YamlSortSequenceValues[0];

package/src/rules/yarnrc-yml.test.ts

@@ -0,0 +1,7 @@
+import type { TypedFlatConfigItem } from '@antfu/eslint-config';
+import { expectTypeOf, it } from 'vitest';
+import { yarnrcYmlRules } from './yarnrc-yml';
+
+it('should be valid rule', async () => {
+  expectTypeOf(yarnrcYmlRules).toEqualTypeOf<TypedFlatConfigItem>();
+});

package/src/rules/{yml-yarnrc.ts → yarnrc-yml.ts}

@@ -1,14 +1,7 @@
-import type { Rules, TypedFlatConfigItem } from '@antfu/eslint-config';
-import type { Linter } from 'eslint';
+import type { TypedFlatConfigItem } from '@antfu/eslint-config';
+import type { YamlSortKeysRecord } from './yaml-order';
 import { yamlOrder } from './yaml-order';
 
-type YamlSortKeys =
-  NonNullable<Rules['yaml/sort-keys']> extends Linter.RuleEntry<infer F>
-    ? F
-    : never;
-
-type YamlSortKeysRecord = YamlSortKeys[0];
-
 export const yarnrcYmlSortKeys = {
   packageExtensions: {
     packages: {

package/src/types/index.test.ts

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

package/src/types/index.ts

@@ -28,7 +28,6 @@ export const defineOverride = (config: OverrideConfig) =>
   ];
 
 export type RuleEntry<T extends keyof Rules> = Rules[T] extends
-  | Linter.RuleEntry<infer F>
-  | undefined
+  Linter.RuleEntry<infer F> | undefined
   ? F
   : never;