@ntnyq/eslint-config 3.6.0 → 3.7.1

package/README.md

@@ -124,6 +124,8 @@ export interface ConfigOptions extends ConfigOptionsInternal {
 
   javascript?: ConfigJavaScriptOptions
 
+  specials?: ConfigSpecialsOptions
+
   sort?: boolean | ConfigSortOptions
 
   gitignore?: boolean | ConfigGitIgnoreOptions

package/dist/index.cjs

@@ -61,6 +61,7 @@ __export(src_exports, {
   GLOB_TOML: () => GLOB_TOML,
   GLOB_TS: () => GLOB_TS,
   GLOB_TSX: () => GLOB_TSX,
+  GLOB_TYPES: () => GLOB_TYPES,
   GLOB_VUE: () => GLOB_VUE,
   GLOB_YAML: () => GLOB_YAML,
   antfu: () => antfu,
@@ -213,6 +214,7 @@ var GLOB_JSX = `${GLOB_JS}x`;
 var GLOB_TS = "**/*.?([cm])ts";
 var GLOB_TSX = `${GLOB_TS}x`;
 var GLOB_DTS = "**/*.d.?([cm])ts";
+var GLOB_TYPES = [GLOB_DTS, `**/types/${GLOB_TS}`, `**/types.ts`];
 var GLOB_TEST = [
   `**/*.test.${GLOB_SRC_EXT}`,
   `**/*.spec.${GLOB_SRC_EXT}`,
@@ -395,12 +397,12 @@ var unCategorizedRules = {
   "vue/no-multiple-objects-in-class": "error",
   "vue/prefer-separate-static-class": "error",
   "vue/no-ref-object-reactivity-loss": "error",
-  "vue/no-duplicate-attr-inheritance": "error",
   "vue/prefer-prop-type-boolean-first": "error",
   "vue/html-comment-indent": ["error", 2],
   "vue/next-tick-style": ["error", "promise"],
   "vue/v-for-delimiter-style": ["error", "in"],
   "vue/no-restricted-v-bind": ["error", "/^v-/"],
+  "vue/slot-name-casing": ["error", "camelCase"],
   "vue/custom-event-name-casing": ["error", "camelCase"],
   "vue/define-props-declaration": ["error", "type-based"],
   "vue/define-emits-declaration": ["error", "type-literal"],
@@ -415,6 +417,12 @@ var unCategorizedRules = {
       reset: true
     }
   ],
+  "vue/no-duplicate-attr-inheritance": [
+    "error",
+    {
+      checkMultiRootNodes: true
+    }
+  ],
   "vue/block-order": [
     "error",
     {
@@ -698,7 +706,13 @@ var node = (options = {}) => [
 // src/configs/sort.ts
 var sort = (options = {}) => {
   const configs2 = [];
-  if (options.tsconfig ?? true) {
+  const {
+    tsconfig: enableSortTsconfig = true,
+    packageJson: enableSortPackageJson = true,
+    i18nLocale: enableSortI18nLocale = true,
+    pnpmWorkspace: enableSortPnpmWorkspace = true
+  } = options;
+  if (enableSortTsconfig) {
     configs2.push({
       name: "ntnyq/sort/tsconfig",
       files: ["**/tsconfig.json", "**/tsconfig.*.json"],
@@ -814,7 +828,7 @@ var sort = (options = {}) => {
       }
     });
   }
-  if (options.packageJson ?? true) {
+  if (enableSortPackageJson) {
     configs2.push({
       name: "ntnyq/sort/package-json",
       files: ["**/package.json"],
@@ -982,7 +996,7 @@ var sort = (options = {}) => {
       }
     });
   }
-  if (options.i18nLocale ?? true) {
+  if (enableSortI18nLocale) {
     configs2.push(
       {
         name: "ntnyq/sort/i18n-locale/json",
@@ -1012,7 +1026,7 @@ var sort = (options = {}) => {
       }
     );
   }
-  if (options.pnpmWorkspace ?? true) {
+  if (enableSortPnpmWorkspace) {
     configs2.push({
       name: "ntnyq/sort/pnpm-workspace",
       files: ["**/pnpm-workspace.yaml"],
@@ -1438,51 +1452,51 @@ var unocss = (options = {}) => [
 
 // src/constants.ts
 var DEFAULT_PRETTIER_OPTIONS = {
+  // Include parentheses around a sole arrow function parameter
+  arrowParens: "avoid",
+  // Put the > of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being alone on the next line (does not apply to self closing elements)
+  bracketSameLine: false,
+  // Print spaces between brackets in object literals.
+  bracketSpacing: true,
+  // Control whether Prettier formats quoted code embedded in the file
+  embeddedLanguageFormatting: "auto",
+  // End of line
+  endOfLine: "lf",
+  // Specify the global whitespace sensitivity for HTML files
+  htmlWhitespaceSensitivity: "css",
+  // Prettier can insert a special @format marker at the top of files specifying that the file has been formatted with prettier.
+  insertPragma: false,
+  // Use single quotes instead of double quotes in JSX
+  jsxSingleQuote: true,
   // Maximum line length
   printWidth: 100,
-  // Specify the number of spaces per indentation-level
-  tabWidth: 2,
-  // Indent lines with tabs instead of spaces
-  useTabs: false,
-  // Use semicolons or not
-  semi: false,
-  // Use single quotes instead of double quotes
-  singleQuote: true,
+  // By default, Prettier will wrap markdown text as-is since some services use a line-break-sensitive renderer, e.g. GitHub comment and Bitbucket.
+  proseWrap: "preserve",
   // Change when properties in objects are quoted
   quoteProps: "as-needed",
-  // Use single quotes instead of double quotes in JSX
-  jsxSingleQuote: true,
-  // Print trailing commas wherever possible when multi-line
-  trailingComma: "all",
-  // Print spaces between brackets in object literals.
-  bracketSpacing: true,
-  // Put the > of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being alone on the next line (does not apply to self closing elements)
-  bracketSameLine: false,
-  // Include parentheses around a sole arrow function parameter
-  arrowParens: "avoid",
+  rangeEnd: Number.POSITIVE_INFINITY,
   // Format only a segment of a file.
   rangeStart: 0,
-  rangeEnd: Number.POSITIVE_INFINITY,
   // Specify which parser to use.
   // parser: undefined,
   // Specify the file name to use to infer which parser to use.
   // filepath: undefined,
   // Prettier can restrict itself to only format files that contain a special comment, called a pragma, at the top of the file.
   requirePragma: false,
-  // Prettier can insert a special @format marker at the top of files specifying that the file has been formatted with prettier.
-  insertPragma: false,
-  // By default, Prettier will wrap markdown text as-is since some services use a line-break-sensitive renderer, e.g. GitHub comment and Bitbucket.
-  proseWrap: "preserve",
-  // Specify the global whitespace sensitivity for HTML files
-  htmlWhitespaceSensitivity: "css",
-  // Whether or not to indent the code inside <script> and <style> tags in Vue files
-  vueIndentScriptAndStyle: false,
-  // End of line
-  endOfLine: "lf",
-  // Control whether Prettier formats quoted code embedded in the file
-  embeddedLanguageFormatting: "auto",
+  // Use semicolons or not
+  semi: false,
   // Enforce single attribute per line in HTML, Vue and JSX
-  singleAttributePerLine: true
+  singleAttributePerLine: true,
+  // Use single quotes instead of double quotes
+  singleQuote: true,
+  // Specify the number of spaces per indentation-level
+  tabWidth: 2,
+  // Print trailing commas wherever possible when multi-line
+  trailingComma: "all",
+  // Indent lines with tabs instead of spaces
+  useTabs: false,
+  // Whether or not to indent the code inside <script> and <style> tags in Vue files
+  vueIndentScriptAndStyle: false
 };
 
 // src/utils/env.ts
@@ -1817,6 +1831,27 @@ var specials = (options = {}) => [
       ...options.overridesUserScriptsRules
     }
   },
+  {
+    name: "ntnyq/specials/config-file",
+    files: [`**/*.config*.${GLOB_SRC_EXT}`],
+    plugins: {
+      import: import_eslint_plugin_import_x.default,
+      perfectionist: import_eslint_plugin_perfectionist.default
+    },
+    rules: {
+      "no-console": "off",
+      "import/no-default-export": "off",
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "perfectionist/sort-objects": [
+        "error",
+        {
+          type: "alphabetical",
+          order: "asc"
+        }
+      ],
+      ...options.overridesConfigFileRules
+    }
+  },
   // More special case configs
   // So don't need to append configs to composer
   ...options.specialCaseConfigs ? options.specialCaseConfigs : []
@@ -2426,7 +2461,7 @@ var typescript = (options = {}) => {
     ] : [],
     {
       name: "ntnyq/ts/types",
-      files: [GLOB_DTS, "**/types/**/*.ts"],
+      files: [...GLOB_TYPES],
       rules: {
         "no-use-before-define": "off",
         "no-restricted-syntax": "off",
@@ -2455,90 +2490,238 @@ var githubAction = (options = {}) => [
 ];
 
 // src/configs/perfectionist.ts
-var perfectionist = (options = {}) => [
-  {
-    name: "ntnyq/perfectionist",
-    plugins: {
-      perfectionist: import_eslint_plugin_perfectionist.default
-    },
-    rules: {
-      "perfectionist/sort-imports": [
-        "error",
-        {
-          groups: [
-            // Side effect style imports (e.g. 'normalize.css')
-            "side-effect-style",
-            // Styles (e.g. *.{css,scss,less})
-            "style",
-            // Node.js built-in modules. (e.g. fs, path)
-            "builtin",
-            // External modules installed in the project (e.g. vue, lodash)
-            "external",
-            // Internal modules (e.g. @/utils, @/components)
-            "internal",
-            // Modules from parent directory (e.g. ../utils)
-            "parent",
-            // Modules from the same directory (e.g. ./utils)
-            "sibling",
-            // Main file from the current directory (e.g. ./index)
-            "index",
-            // TypeScript object-imports (e.g. import log = console.log)
-            "object",
-            // Side effect imports (e.g. import 'babel-polyfill')
-            "side-effect",
-            /**
-             * Type import at the end
-             */
-            "builtin-type",
-            "external-type",
-            "internal-type",
-            "parent-type",
-            "sibling-type",
-            "index-type",
-            "type",
-            /**
-             * Imports that don’t fit into any other group
-             */
-            "unknown"
-          ],
-          order: options.imports?.order || "asc",
-          type: options.imports?.type || "natural",
-          ignoreCase: true,
-          internalPattern: ["^~/.+", "^@/.+", "^#.+"],
-          newlinesBetween: "ignore"
-        }
-      ],
-      "perfectionist/sort-exports": [
-        "error",
-        {
-          order: options.exports?.order || "asc",
-          type: options.exports?.type || "line-length"
-        }
-      ],
-      "perfectionist/sort-named-exports": [
-        "error",
-        {
-          type: options.namedExports?.type || "alphabetical",
-          order: options.namedExports?.order || "asc",
-          ignoreCase: true,
-          groupKind: "values-first"
-        }
-      ],
-      "perfectionist/sort-named-imports": [
-        "error",
-        {
-          type: options.namedImports?.type || "alphabetical",
-          order: options.namedImports?.order || "asc",
-          ignoreCase: true,
-          ignoreAlias: false,
-          groupKind: "values-first"
-        }
-      ],
-      // Overrides rules
-      ...options.overrides
+var perfectionist = (options = {}) => {
+  const {
+    sortEnums: enableSortEnums = true,
+    sortTypes: enableSortTypes = true,
+    sortConstants: enableSortConstants = true
+  } = options;
+  const configs2 = [
+    {
+      name: "ntnyq/perfectionist/common",
+      plugins: {
+        perfectionist: import_eslint_plugin_perfectionist.default
+      },
+      rules: {
+        "perfectionist/sort-imports": [
+          "error",
+          {
+            groups: [
+              // Side effect style imports (e.g. 'normalize.css')
+              "side-effect-style",
+              // Styles (e.g. *.{css,scss,less})
+              "style",
+              // Node.js built-in modules. (e.g. fs, path)
+              "builtin",
+              // External modules installed in the project (e.g. vue, lodash)
+              "external",
+              // Internal modules (e.g. @/utils, @/components)
+              "internal",
+              // Modules from parent directory (e.g. ../utils)
+              "parent",
+              // Modules from the same directory (e.g. ./utils)
+              "sibling",
+              // Main file from the current directory (e.g. ./index)
+              "index",
+              // TypeScript object-imports (e.g. import log = console.log)
+              "object",
+              // Side effect imports (e.g. import 'babel-polyfill')
+              "side-effect",
+              /**
+               * Type import at the end
+               */
+              "builtin-type",
+              "external-type",
+              "internal-type",
+              "parent-type",
+              "sibling-type",
+              "index-type",
+              "type",
+              /**
+               * Imports that don’t fit into any other group
+               */
+              "unknown"
+            ],
+            order: "asc",
+            type: "natural",
+            ignoreCase: true,
+            internalPattern: ["^~/.+", "^@/.+", "^#.+"],
+            newlinesBetween: "ignore"
+          }
+        ],
+        "perfectionist/sort-exports": [
+          "error",
+          {
+            order: "asc",
+            type: "line-length"
+          }
+        ],
+        "perfectionist/sort-named-exports": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            ignoreCase: true,
+            groupKind: "values-first"
+          }
+        ],
+        "perfectionist/sort-named-imports": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            ignoreCase: true,
+            ignoreAlias: false,
+            groupKind: "values-first"
+          }
+        ],
+        // Overrides rules
+        ...options.overrides
+      }
     }
+  ];
+  if (enableSortEnums) {
+    configs2.push({
+      name: "ntnyq/perfectionist/enums",
+      files: [`**/enums/${GLOB_SRC}`, `**/enums.${GLOB_SRC_EXT}`],
+      plugins: {
+        perfectionist: import_eslint_plugin_perfectionist.default
+      },
+      rules: {
+        "perfectionist/sort-enums": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        "perfectionist/sort-modules": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            partitionByComment: true
+          }
+        ],
+        // Overrides rules
+        ...options.overridesEnumsRules
+      }
+    });
   }
-];
+  if (enableSortTypes) {
+    configs2.push({
+      name: "ntnyq/perfectionist/types",
+      files: [...GLOB_TYPES],
+      plugins: {
+        perfectionist: import_eslint_plugin_perfectionist.default
+      },
+      rules: {
+        "perfectionist/sort-heritage-clauses": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        // 'perfectionist/sort-interfaces': [
+        //   'error',
+        //   {
+        //     type: 'alphabetical',
+        //     order: 'asc',
+        //   },
+        // ],
+        "perfectionist/sort-intersection-types": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            groups: [
+              "intersection",
+              "named",
+              "conditional",
+              "function",
+              "import",
+              "keyword",
+              "literal",
+              "object",
+              "operator",
+              "tuple",
+              "union",
+              "nullish"
+            ]
+          }
+        ],
+        "perfectionist/sort-modules": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            partitionByComment: true
+          }
+        ],
+        "perfectionist/sort-object-types": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        "perfectionist/sort-union-types": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        // Overrides rules
+        ...options.overridesTypesRules
+      }
+    });
+  }
+  if (enableSortConstants) {
+    configs2.push({
+      name: "ntnyq/perfectionist/constants",
+      files: [`**/constants/${GLOB_SRC}`, `**/constants.${GLOB_SRC_EXT}`],
+      plugins: {
+        perfectionist: import_eslint_plugin_perfectionist.default
+      },
+      rules: {
+        "perfectionist/sort-maps": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        "perfectionist/sort-objects": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        "perfectionist/sort-sets": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc"
+          }
+        ],
+        "perfectionist/sort-modules": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            partitionByComment: true
+          }
+        ],
+        // Overrides rules
+        ...options.overridesConstantsRules
+      }
+    });
+  }
+  return configs2;
+};
 
 // src/configs/unusedImports.ts
 var unusedImports = (options = {}) => [
@@ -2798,6 +2981,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   GLOB_TOML,
   GLOB_TS,
   GLOB_TSX,
+  GLOB_TYPES,
   GLOB_VUE,
   GLOB_YAML,
   antfu,