eslint-plugin-perfectionist 2.10.0 → 3.0.0

package/dist/index.d.ts

@@ -0,0 +1,365 @@
+import { ClassicConfig } from '@typescript-eslint/utils/ts-eslint'
+import { FlatConfig } from '@typescript-eslint/utils/ts-eslint'
+import { ObjectExpression } from 'node_modules/@typescript-eslint/types/dist/generated/ast-spec'
+import { ObjectPattern } from 'node_modules/@typescript-eslint/types/dist/generated/ast-spec'
+import { RuleListener } from '@typescript-eslint/utils/ts-eslint'
+import { RuleModule } from '@typescript-eslint/utils/ts-eslint'
+
+declare const _default: {
+  configs: {
+    'recommended-alphabetical-legacy': ClassicConfig.Config
+    'recommended-line-length-legacy': ClassicConfig.Config
+    'recommended-natural-legacy': ClassicConfig.Config
+    'recommended-alphabetical': FlatConfig.Config
+    'recommended-line-length': FlatConfig.Config
+    'recommended-natural': FlatConfig.Config
+  }
+  rules: {
+    'sort-variable-declarations': RuleModule<
+      'unexpectedVariableDeclarationsOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-intersection-types': RuleModule<
+      'unexpectedIntersectionTypesOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (
+            | (
+                | 'object'
+                | 'function'
+                | 'operator'
+                | 'unknown'
+                | 'intersection'
+                | 'conditional'
+                | 'keyword'
+                | 'literal'
+                | 'nullish'
+                | 'import'
+                | 'named'
+                | 'tuple'
+                | 'union'
+              )[]
+            | (
+                | 'object'
+                | 'function'
+                | 'operator'
+                | 'unknown'
+                | 'intersection'
+                | 'conditional'
+                | 'keyword'
+                | 'literal'
+                | 'nullish'
+                | 'import'
+                | 'named'
+                | 'tuple'
+                | 'union'
+              )
+          )[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-svelte-attributes': RuleModule<
+      'unexpectedSvelteAttributesOrder',
+      [
+        Partial<{
+          customGroups: {
+            [x: string]: string | string[]
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (string | string[])[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-astro-attributes': RuleModule<
+      'unexpectedAstroAttributesOrder',
+      [
+        Partial<{
+          customGroups: {
+            [x: string]: string | string[]
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (string | string[])[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-vue-attributes': RuleModule<
+      'unexpectedVueAttributesOrder',
+      [
+        Partial<{
+          customGroups: {
+            [x: string]: string | string[]
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (string | string[])[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-array-includes': RuleModule<
+      'unexpectedArrayIncludesOrder',
+      [
+        Partial<{
+          groupKind: 'literals-first' | 'spreads-first' | 'mixed'
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-named-imports': RuleModule<
+      'unexpectedNamedImportsOrder',
+      [
+        Partial<{
+          groupKind: 'values-first' | 'types-first' | 'mixed'
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreAlias: boolean
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-named-exports': RuleModule<
+      'unexpectedNamedExportsOrder',
+      [
+        Partial<{
+          groupKind: 'values-first' | 'types-first' | 'mixed'
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-object-types': RuleModule<
+      'unexpectedObjectTypesOrder',
+      [
+        Partial<{
+          groupKind: 'required-first' | 'optional-first' | 'mixed'
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (string | string[])[]
+          partitionByNewLine: boolean
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+          customGroups: {}
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-union-types': RuleModule<
+      'unexpectedUnionTypesOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (
+            | (
+                | 'object'
+                | 'function'
+                | 'operator'
+                | 'unknown'
+                | 'intersection'
+                | 'conditional'
+                | 'keyword'
+                | 'literal'
+                | 'nullish'
+                | 'import'
+                | 'named'
+                | 'tuple'
+                | 'union'
+              )[]
+            | (
+                | 'object'
+                | 'function'
+                | 'operator'
+                | 'unknown'
+                | 'intersection'
+                | 'conditional'
+                | 'keyword'
+                | 'literal'
+                | 'nullish'
+                | 'import'
+                | 'named'
+                | 'tuple'
+                | 'union'
+              )
+          )[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-switch-case': RuleModule<
+      'unexpectedSwitchCaseOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-interfaces': RuleModule<
+      'unexpectedInterfacePropertiesOrder',
+      [
+        Partial<{
+          groupKind: 'optional-first' | 'required-first' | 'mixed'
+          customGroups: {
+            [key: string]: string[] | string
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (string | string[])[]
+          partitionByNewLine: boolean
+          ignorePattern: string[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-jsx-props': RuleModule<
+      'unexpectedJSXPropsOrder',
+      [
+        Partial<{
+          customGroups: {
+            [x: string]: string | string[]
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          groups: (string | string[])[]
+          ignorePattern: string[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-classes': RuleModule<
+      'unexpectedClassesOrder',
+      [
+        Partial<{
+          customGroups: {
+            [key: string]: string[] | string
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          groups: (string[] | string)[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-imports': RuleModule<
+      | 'missedSpacingBetweenImports'
+      | 'extraSpacingBetweenImports'
+      | 'unexpectedImportsOrder',
+      [
+        Partial<{
+          customGroups: {
+            value?:
+              | {
+                  [x: string]: string | string[]
+                }
+              | undefined
+            type?:
+              | {
+                  [x: string]: string | string[]
+                }
+              | undefined
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          newlinesBetween: 'ignore' | 'always' | 'never'
+          groups: (string | string[])[]
+          environment: 'node' | 'bun'
+          internalPattern: string[]
+          maxLineLength?: number
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-exports': RuleModule<
+      'unexpectedExportsOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-objects': RuleModule<
+      'unexpectedObjectsOrder',
+      [
+        Partial<{
+          customIgnore: ((
+            object: ObjectExpression | ObjectPattern,
+            filename: string,
+          ) => boolean)[]
+          customGroups: {
+            [key: string]: string[] | string
+          }
+          type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          groups: (string[] | string)[]
+          partitionByNewLine: boolean
+          styledComponents: boolean
+          ignorePattern: string[]
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-enums': RuleModule<
+      'unexpectedEnumsOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          partitionByComment: string[] | boolean | string
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+    'sort-maps': RuleModule<
+      'unexpectedMapElementsOrder',
+      [
+        Partial<{
+          type: 'alphabetical' | 'line-length' | 'natural'
+          order: 'desc' | 'asc'
+          ignoreCase: boolean
+        }>,
+      ],
+      RuleListener
+    >
+  }
+  name: string
+}
+export default _default
+
+export {}

package/dist/index.js

@@ -1,135 +1,92 @@
-"use strict";
-const sortIntersectionTypes = require("./rules/sort-intersection-types.js");
-const sortSvelteAttributes = require("./rules/sort-svelte-attributes.js");
-const sortAstroAttributes = require("./rules/sort-astro-attributes.js");
-const sortArrayIncludes = require("./rules/sort-array-includes.js");
-const sortVueAttributes = require("./rules/sort-vue-attributes.js");
-const sortNamedExports = require("./rules/sort-named-exports.js");
-const sortNamedImports = require("./rules/sort-named-imports.js");
-const sortObjectTypes = require("./rules/sort-object-types.js");
-const sortUnionTypes = require("./rules/sort-union-types.js");
-const sortInterfaces = require("./rules/sort-interfaces.js");
-const sortJsxProps = require("./rules/sort-jsx-props.js");
-const sortExports = require("./rules/sort-exports.js");
-const sortImports = require("./rules/sort-imports.js");
-const sortObjects = require("./rules/sort-objects.js");
-const sortClasses = require("./rules/sort-classes.js");
-const sortEnums = require("./rules/sort-enums.js");
-const sortMaps = require("./rules/sort-maps.js");
-const index = require("./typings/index.js");
-const _package = require("./package.json.js");
-let createConfigWithOptions = (options) => {
-  let recommendedRules = {
-    [sortImports.RULE_NAME]: [
-      "error",
-      {
-        groups: [
-          "type",
-          ["builtin", "external"],
-          "internal-type",
-          "internal",
-          ["parent-type", "sibling-type", "index-type"],
-          ["parent", "sibling", "index"],
-          "object",
-          "unknown"
-        ],
-        "custom-groups": {
-          value: {},
-          type: {}
-        },
-        "newlines-between": "always",
-        "internal-pattern": ["~/**"]
-      }
-    ],
-    [sortClasses.RULE_NAME]: [
-      "error",
-      {
-        groups: [
-          "index-signature",
-          "static-property",
-          "private-property",
-          "property",
-          "constructor",
-          "static-method",
-          "private-method",
-          "method",
-          ["get-method", "set-method"],
-          "unknown"
-        ]
-      }
-    ],
-    [sortObjects.RULE_NAME]: [
-      "error",
-      {
-        "partition-by-comment": false
-      }
-    ],
-    [sortArrayIncludes.RULE_NAME]: [
-      "error",
-      {
-        "spread-last": true
-      }
-    ],
-    [sortIntersectionTypes.RULE_NAME]: ["error"],
-    [sortSvelteAttributes.RULE_NAME]: ["error"],
-    [sortAstroAttributes.RULE_NAME]: ["error"],
-    [sortVueAttributes.RULE_NAME]: ["error"],
-    [sortNamedExports.RULE_NAME]: ["error"],
-    [sortNamedImports.RULE_NAME]: ["error"],
-    [sortObjectTypes.RULE_NAME]: ["error"],
-    [sortUnionTypes.RULE_NAME]: ["error"],
-    [sortInterfaces.RULE_NAME]: ["error"],
-    [sortJsxProps.RULE_NAME]: ["error"],
-    [sortExports.RULE_NAME]: ["error"],
-    [sortEnums.RULE_NAME]: ["error"],
-    [sortMaps.RULE_NAME]: ["error"]
-  };
-  return {
-    rules: Object.fromEntries(
-      Object.entries(recommendedRules).map(([key, [message, baseOptions = {}]]) => [
-        `perfectionist/${key}`,
-        [message, Object.assign(baseOptions, options)]
-      ])
-    ),
-    plugins: ["perfectionist"]
-  };
-};
-const mod = {
+'use strict'
+const sortVariableDeclarations = require('./rules/sort-variable-declarations.js')
+const sortIntersectionTypes = require('./rules/sort-intersection-types.js')
+const sortSvelteAttributes = require('./rules/sort-svelte-attributes.js')
+const sortAstroAttributes = require('./rules/sort-astro-attributes.js')
+const sortArrayIncludes = require('./rules/sort-array-includes.js')
+const sortVueAttributes = require('./rules/sort-vue-attributes.js')
+const sortNamedImports = require('./rules/sort-named-imports.js')
+const sortNamedExports = require('./rules/sort-named-exports.js')
+const sortObjectTypes = require('./rules/sort-object-types.js')
+const sortSwitchCase = require('./rules/sort-switch-case.js')
+const sortUnionTypes = require('./rules/sort-union-types.js')
+const sortInterfaces = require('./rules/sort-interfaces.js')
+const sortJsxProps = require('./rules/sort-jsx-props.js')
+const sortClasses = require('./rules/sort-classes.js')
+const sortImports = require('./rules/sort-imports.js')
+const sortExports = require('./rules/sort-exports.js')
+const sortObjects = require('./rules/sort-objects.js')
+const sortEnums = require('./rules/sort-enums.js')
+const sortMaps = require('./rules/sort-maps.js')
+let name = 'perfectionist'
+let plugin = {
   rules: {
-    [sortArrayIncludes.RULE_NAME]: sortArrayIncludes.default,
-    [sortAstroAttributes.RULE_NAME]: sortAstroAttributes.default,
-    [sortClasses.RULE_NAME]: sortClasses.default,
-    [sortEnums.RULE_NAME]: sortEnums.default,
-    [sortExports.RULE_NAME]: sortExports.default,
-    [sortImports.RULE_NAME]: sortImports.default,
-    [sortInterfaces.RULE_NAME]: sortInterfaces.default,
-    [sortJsxProps.RULE_NAME]: sortJsxProps.default,
-    [sortMaps.RULE_NAME]: sortMaps.default,
-    [sortNamedExports.RULE_NAME]: sortNamedExports.default,
-    [sortNamedImports.RULE_NAME]: sortNamedImports.default,
-    [sortObjectTypes.RULE_NAME]: sortObjectTypes.default,
-    [sortObjects.RULE_NAME]: sortObjects.default,
-    [sortSvelteAttributes.RULE_NAME]: sortSvelteAttributes.default,
-    [sortIntersectionTypes.RULE_NAME]: sortIntersectionTypes.default,
-    [sortUnionTypes.RULE_NAME]: sortUnionTypes.default,
-    [sortVueAttributes.RULE_NAME]: sortVueAttributes.default
+    'sort-variable-declarations': sortVariableDeclarations,
+    'sort-intersection-types': sortIntersectionTypes,
+    'sort-svelte-attributes': sortSvelteAttributes,
+    'sort-astro-attributes': sortAstroAttributes,
+    'sort-vue-attributes': sortVueAttributes,
+    'sort-array-includes': sortArrayIncludes,
+    'sort-named-imports': sortNamedImports,
+    'sort-named-exports': sortNamedExports,
+    'sort-object-types': sortObjectTypes,
+    'sort-union-types': sortUnionTypes,
+    'sort-switch-case': sortSwitchCase,
+    'sort-interfaces': sortInterfaces,
+    'sort-jsx-props': sortJsxProps,
+    'sort-classes': sortClasses,
+    'sort-imports': sortImports,
+    'sort-exports': sortExports,
+    'sort-objects': sortObjects,
+    'sort-enums': sortEnums,
+    'sort-maps': sortMaps,
   },
+  name,
+}
+let getRules = options =>
+  Object.fromEntries(
+    Object.keys(plugin.rules).map(rule => [
+      `${name}/${rule}`,
+      ['error', options],
+    ]),
+  )
+let createConfig = options => ({
+  plugins: {
+    [name]: plugin,
+  },
+  rules: getRules(options),
+})
+let createLegacyConfig = options => ({
+  rules: getRules(options),
+  plugins: [name],
+})
+const index = {
+  ...plugin,
   configs: {
-    "recommended-alphabetical": createConfigWithOptions({
-      type: index.SortType.alphabetical,
-      order: index.SortOrder.asc,
-      "ignore-case": false
+    'recommended-alphabetical-legacy': createLegacyConfig({
+      type: 'alphabetical',
+      order: 'asc',
+    }),
+    'recommended-line-length-legacy': createLegacyConfig({
+      type: 'line-length',
+      order: 'desc',
+    }),
+    'recommended-natural-legacy': createLegacyConfig({
+      type: 'natural',
+      order: 'asc',
+    }),
+    'recommended-alphabetical': createConfig({
+      type: 'alphabetical',
+      order: 'asc',
+    }),
+    'recommended-line-length': createConfig({
+      type: 'line-length',
+      order: 'desc',
     }),
-    "recommended-natural": createConfigWithOptions({
-      type: index.SortType.natural,
-      order: index.SortOrder.asc,
-      "ignore-case": false
+    'recommended-natural': createConfig({
+      type: 'natural',
+      order: 'asc',
     }),
-    "recommended-line-length": createConfigWithOptions({
-      type: index.SortType["line-length"],
-      order: index.SortOrder.desc
-    })
   },
-  name: _package.name
-};
-module.exports = mod;
+}
+module.exports = index