eslint-config-un 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,6 @@
 # eslint-config-un
 
-[![npm](https://img.shields.io/npm/v/esling-config-un)](https://www.npmjs.com/package/esling-config-un)
+[![npm](https://img.shields.io/npm/v/eslint-config-un)](https://www.npmjs.com/package/eslint-config-un)
 
 Grown out of the personal collection of rules, an ESLint config aspiring to cover as many rules as possible, be reasonably strict and easily configurable. Only supports ESLint 9 and the flat config format.
 
@@ -14,7 +14,7 @@ yarn add -D eslint-config-un
 
 ## List of configs
 
-Includes the following rules, configs & plugins:
+Includes the rules from the following configs & plugins:
 - [Vanilla ESLint rules](https://eslint.org/docs/latest/rules/)
 - [typescript-eslint](https://typescript-eslint.io/rules/)
 - [vue](https://eslint.vuejs.org/rules/) (+ [vuejs-accessibility](https://www.npmjs.com/package/eslint-plugin-vuejs-accessibility) and [pinia](https://www.npmjs.com/package/eslint-plugin-pinia))
@@ -33,6 +33,7 @@ Includes the following rules, configs & plugins:
 - Automatically detects the presence of `typescript`, `vue`, `nuxt` and `pinia` packages and enables corresponding configurations (which can also be enabled or disabled explicitly).
 - Every block of rules supports `overrides` for rules.
 - Designed to be used separately from Prettier: *almost* all the rules potentially conflicting with Prettier are disabled *by default*.
+- Written in TypeScript so all the options are typed.
 
 ## Usage
 
@@ -47,11 +48,22 @@ export default eslintConfig({
 });
 ```
 
-## Limitations & Caveats
+## Notes
 
+- You don't need to install any of the mentioned configs/plugins as they are all the dependencies of this package.
 - This package has a peer dependency of `eslint>=9`. Please ensure you have installed the correct version. Some package managers are installing non-optional peer dependencies automatically.
 - Packages lookup (such as `typescript` or `vue`) is performed using [`local-pkg`](https://www.npmjs.com/package/local-pkg).
 - Type-checked, or type-aware TypeScript rules are *enabled* by default which are known to be performance-demanding. It's just a little heads-up and you should make your own decision whether to keep them enabled. [More about type-aware linting](https://typescript-eslint.io/getting-started/typed-linting).
-- By default, TypeScript rules will only be enabled in `.vue` files if `enforceTypescriptInScriptSection` is set to true in vue's config options which in turn is *automatically* set to true if `typescript` package found installed. This is because right now it is not possible to apply different rules based on `lang` attribute of `<script>` SFC sections and the only reasonable solution would be to completely disable TypeScript rules to avoid great number of false positives.
+- By default, TypeScript rules will be enabled in `.vue` files if `enforceTypescriptInScriptSection` is set to true in vue's config options which in turn is *automatically* set to true if `typescript` package found installed. If you have `.vue` files authored in both TypeScript and JavaScript, use `enforceTypescriptInScriptSection.{files,ignores}` to manually specify TS & JS Vue components respectively. It is not currently possible to apply different ESLint rules depending on the value of `lang` attribute of `<script>` SFC section.
 - All plugins listed above are enabled by default or enabled automatically under certain conditions, but there is one that is *disabled* by default: `security`.
-- Some rules are set to warn by default. You can change some or even all such rule's reporting level using `errorsInsteadOfWarnings` option. You can find all such rules by inspecting this plugin's source code.
+- Some rules are set to warn by default. You can change some or even all such rule's reporting level using `errorsInsteadOfWarnings` option. You can find all such rules by inspecting the source code of this package.
+
+## Troubleshooting
+
+### TypeError: Key `rules`: Key `disable-autofix/<rule name>`: Could not find `<rule name>` in plugin `disable-autofix`
+
+We disable autofix for some rules in this package via `eslint-plugin-disable-autofix`. However, it requires all the configs/plugins packages to be hoisted (installed to the top level of `node_modules`). You might need to reinstall this package, re-create `node_modules` directory (do not delete your lock file!) or set `shamefully-hoist=true` in your `.npmrc` if you're using pnpm. Sometimes you'll need to manually install some packages refused to be hoisted (happens with `@typescript-eslint/eslint-plugin`: `npm i @typescript-eslint/eslint-plugin -D --legacy-peer-deps`);
+
+### TypeError: Key `languageOptions`: Key `globals`: Global `AudioWorkletGlobalScope ` has leading or trailing whitespace.
+
+Install `globals` package as a dev dependency.

package/dist/index.cjs

@@ -33,16 +33,16 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// node_modules/.pnpm/tsup@8.1.0_postcss@8.4.39_typescript@5.5.3/node_modules/tsup/assets/cjs_shims.js
+// node_modules/.pnpm/tsup@8.2.2_jiti@1.21.6_postcss@8.4.39_tsx@4.16.2_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/cjs_shims.js
 var init_cjs_shims = __esm({
-  "node_modules/.pnpm/tsup@8.1.0_postcss@8.4.39_typescript@5.5.3/node_modules/tsup/assets/cjs_shims.js"() {
+  "node_modules/.pnpm/tsup@8.2.2_jiti@1.21.6_postcss@8.4.39_tsx@4.16.2_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/cjs_shims.js"() {
     "use strict";
   }
 });
 
-// node_modules/.pnpm/@eslint+js@9.6.0/node_modules/@eslint/js/src/configs/eslint-all.js
+// node_modules/.pnpm/@eslint+js@9.7.0/node_modules/@eslint/js/src/configs/eslint-all.js
 var require_eslint_all = __commonJS({
-  "node_modules/.pnpm/@eslint+js@9.6.0/node_modules/@eslint/js/src/configs/eslint-all.js"(exports2, module2) {
+  "node_modules/.pnpm/@eslint+js@9.7.0/node_modules/@eslint/js/src/configs/eslint-all.js"(exports2, module2) {
     "use strict";
     init_cjs_shims();
     module2.exports = Object.freeze({
@@ -249,9 +249,9 @@ var require_eslint_all = __commonJS({
   }
 });
 
-// node_modules/.pnpm/@eslint+js@9.6.0/node_modules/@eslint/js/src/configs/eslint-recommended.js
+// node_modules/.pnpm/@eslint+js@9.7.0/node_modules/@eslint/js/src/configs/eslint-recommended.js
 var require_eslint_recommended = __commonJS({
-  "node_modules/.pnpm/@eslint+js@9.6.0/node_modules/@eslint/js/src/configs/eslint-recommended.js"(exports2, module2) {
+  "node_modules/.pnpm/@eslint+js@9.7.0/node_modules/@eslint/js/src/configs/eslint-recommended.js"(exports2, module2) {
     "use strict";
     init_cjs_shims();
     module2.exports = Object.freeze({
@@ -322,9 +322,9 @@ var require_eslint_recommended = __commonJS({
   }
 });
 
-// node_modules/.pnpm/@eslint+js@9.6.0/node_modules/@eslint/js/src/index.js
+// node_modules/.pnpm/@eslint+js@9.7.0/node_modules/@eslint/js/src/index.js
 var require_src = __commonJS({
-  "node_modules/.pnpm/@eslint+js@9.6.0/node_modules/@eslint/js/src/index.js"(exports2, module2) {
+  "node_modules/.pnpm/@eslint+js@9.7.0/node_modules/@eslint/js/src/index.js"(exports2, module2) {
     "use strict";
     init_cjs_shims();
     module2.exports = {
@@ -343,7 +343,9 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 init_cjs_shims();
+var import_node_fs = __toESM(require("fs"), 1);
 var import_eslint_plugin = __toESM(require("@stylistic/eslint-plugin"), 1);
+var import_eslint_config_flat_gitignore = __toESM(require("eslint-config-flat-gitignore"), 1);
 var import_eslint_config_prettier = __toESM(require("eslint-config-prettier"), 1);
 var import_eslint_plugin_disable_autofix = __toESM(require("eslint-plugin-disable-autofix"), 1);
 var import_eslint_plugin_unicorn2 = __toESM(require("eslint-plugin-unicorn"), 1);
@@ -451,7 +453,9 @@ var importEslintConfig = (options = {}, internalOptions = {}) => {
     "import/no-unresolved": [
       ERROR,
       {
-        ...noUnresolvedIgnores.length > 0 && { ignore: noUnresolvedIgnores }
+        ...noUnresolvedIgnores.length > 0 && {
+          ignore: noUnresolvedIgnores
+        }
       }
     ],
     // 'import/no-unused-modules': OFF,
@@ -609,13 +613,11 @@ var jsEslintConfig = (options = {}, internalOptions = {}) => {
     "no-unreachable-loop": ERROR,
     "no-use-before-define": [ERROR, RULE_NO_USE_BEFORE_DEFINE_OPTIONS],
     "no-useless-assignment": ERROR,
-    // @ts-expect-error no options typings
     "require-atomic-updates": [ERROR, { allowProperties: true }],
     // 🔵 Not in recommended - Suggestions
     "accessor-pairs": ERROR,
     // 'arrow-body-style': OFF,
     "block-scoped-var": ERROR,
-    // @ts-expect-error incorrect typings
     camelcase: [ERROR, RULE_CAMELCASE_OPTIONS],
     // 'capitalized-comments': OFF,
     "class-methods-use-this": ERROR,
@@ -642,7 +644,6 @@ var jsEslintConfig = (options = {}, internalOptions = {}) => {
     // 'id-match': OFF,
     // 'init-declarations': OFF,
     "logical-assignment-operators": [ERROR, "always", { enforceForIfStatements: true }],
-    // @ts-expect-error incorrect typings
     "max-classes-per-file": [ERROR, { ignoreExpressions: true, max: 2 }],
     // 'max-depth': OFF,
     // 'max-lines': OFF,
@@ -727,7 +728,6 @@ var jsEslintConfig = (options = {}, internalOptions = {}) => {
     "no-useless-rename": ERROR,
     "no-useless-return": ERROR,
     "no-var": ERROR,
-    // @ts-expect-error incorrect typings
     "no-void": [ERROR, { allowAsStatement: true }],
     // 'no-warning-comments': OFF,
     "object-shorthand": ERROR,
@@ -740,7 +740,7 @@ var jsEslintConfig = (options = {}, internalOptions = {}) => {
         allowUnboundThis: true
       }
     ],
-    "prefer-const": [ERROR, { ignoreReadBeforeAssign: true }],
+    "prefer-const": [ERROR, { destructuring: "all", ignoreReadBeforeAssign: true }],
     "prefer-destructuring": [ERROR, RULE_PREFER_DESTRUCTURING_OPTIONS],
     "prefer-exponentiation-operator": ERROR,
     // 'prefer-named-capture-group': OFF,
@@ -1181,10 +1181,26 @@ var import_typescript_eslint = require("typescript-eslint");
 var overrideBaseRule2 = genRuleOverrideFn("@typescript-eslint");
 var tsEslintConfig = (options = {}, internalOptions = {}) => {
   const onlyTsFiles = [GLOB_TS, GLOB_TSX];
-  const allExtraFiles = (options.extraFileExtensions || []).map((ext) => `**/*.${ext}`);
-  const extraFiles = internalOptions.vueOptions?.enforceTypescriptInScriptSection ? allExtraFiles.filter((pattern) => pattern.endsWith(".vue")) : [];
-  const filesNonTypeAware = options.files || [...onlyTsFiles, ...extraFiles];
-  const filesTypeAware = options.filesTypeAware === true || options.filesTypeAware == null ? [...onlyTsFiles, ...extraFiles] : options.filesTypeAware || [];
+  const extraFiles = [];
+  const extraFilesToIgnore = [];
+  const { vueOptions } = internalOptions;
+  if (vueOptions) {
+    const { enforceTypescriptInScriptSection } = vueOptions;
+    const vueFilesWithTs = typeof enforceTypescriptInScriptSection === "object" ? enforceTypescriptInScriptSection.files || [] : enforceTypescriptInScriptSection ? vueOptions.files || [GLOB_VUE] : [];
+    const vueFilesWithoutTs = typeof enforceTypescriptInScriptSection === "object" ? enforceTypescriptInScriptSection.ignores || [] : [];
+    extraFiles.push(...vueFilesWithTs);
+    extraFilesToIgnore.push(...vueFilesWithoutTs);
+  }
+  const filesNonTypeAware = [...options.files || onlyTsFiles, ...extraFiles];
+  const ignoresNonTypeAware = [...options.ignores || [], ...extraFilesToIgnore];
+  const filesTypeAware = [
+    ...options.filesTypeAware === true || options.filesTypeAware == null ? onlyTsFiles : options.filesTypeAware || [],
+    ...extraFiles
+  ];
+  const ignoresTypeAware = [
+    ...options.ignoresTypeAware === true ? options.ignores || [] : options.ignoresTypeAware || [],
+    ...extraFilesToIgnore
+  ];
   const filesAll = [...onlyTsFiles, ...filesTypeAware];
   const tsVersion = options.typescriptVersion ? Number.parseFloat(options.typescriptVersion) : void 0;
   const generateBaseOptions = (isTypeAware) => ({
@@ -1411,16 +1427,14 @@ var tsEslintConfig = (options = {}, internalOptions = {}) => {
     {
       ...generateBaseOptions(false),
       files: filesNonTypeAware,
-      ...options.ignores && { ignores: options.ignores },
+      ...ignoresNonTypeAware.length > 0 && { ignores: ignoresNonTypeAware },
       rules: typescriptRulesRegular,
       name: genFlatConfigEntryName("ts/regular-rules")
     },
     filesTypeAware.length > 0 && {
       ...generateBaseOptions(true),
       files: filesTypeAware,
-      ...options.ignoresTypeAware && {
-        ignores: options.ignoresTypeAware === true ? options.ignores || [] : options.ignoresTypeAware
-      },
+      ...ignoresTypeAware.length > 0 && { ignores: ignoresTypeAware },
       rules: typescriptRulesTypeAware,
       name: genFlatConfigEntryName("ts/type-aware-rules")
     },
@@ -1687,6 +1701,7 @@ var vueEslintConfig = (options, internalOptions = {}) => {
   const isLess2_5 = isVue2 && vueMajorAndMinorVersion < 2.5;
   const isLess2_6 = isVue2 && vueMajorAndMinorVersion < 2.6;
   const isLess3_1 = vueMajorAndMinorVersion < 3.1;
+  const isNuxtEnabled = Boolean(options.nuxtMajorVersion);
   const recommendedRules = (
     // TODO report to Prettier?
     // prettier-ignore
@@ -1845,7 +1860,7 @@ var vueEslintConfig = (options, internalOptions = {}) => {
       {
         script: {
           lang: "ts",
-          ...!enforceTypescriptInScriptSection && { allowNoLang: true }
+          ...enforceTypescriptInScriptSection !== true && { allowNoLang: true }
         }
       }
     ],
@@ -1915,8 +1930,7 @@ var vueEslintConfig = (options, internalOptions = {}) => {
     // 'vue/new-line-between-multi-line-property': OFF,
     // 'vue/next-tick-style': OFF,
     // 'vue/no-bare-strings-in-template': OFF,
-    // For explicitness (Vue uses `false` as default value automatically)
-    "vue/no-boolean-default": [ERROR, "default-false"],
+    // 'vue/no-boolean-default': OFF,
     ...isVue3 && { "vue/no-deprecated-model-definition": ERROR },
     "vue/no-duplicate-attr-inheritance": ERROR,
     "vue/no-empty-component-block": ERROR,
@@ -1943,10 +1957,15 @@ var vueEslintConfig = (options, internalOptions = {}) => {
     "vue/no-undef-components": [
       ERROR,
       {
-        ignorePatterns: [...options.knownComponentNames || []]
+        ignorePatterns: [
+          "router-link",
+          "router-view",
+          isNuxtEnabled && /^(lazy-)?(nuxt-|client-only$)/,
+          ...options.knownComponentNames || []
+        ].flat().filter((v) => v !== false)
       }
     ],
-    // TODO enable if script setup is enforced?
+    // TODO enable if script setup is enforced and only in JS?
     // 'vue/no-undef-properties': OFF,
     "vue/no-unsupported-features": [ERROR, { version: `^${options.fullVersion || majorVersion}` }],
     "vue/no-unused-emit-declarations": ERROR,
@@ -2052,7 +2071,6 @@ var vueEslintConfig = (options, internalOptions = {}) => {
     // False positives in script setup
     ...options.overrides
   };
-  const isNuxtEnabled = Boolean(options.nuxtMajorVersion);
   const nuxtLayoutsFiles = `${options.nuxtOrVueProjectDir}layouts/**/*.vue`;
   return [
     {
@@ -2166,7 +2184,8 @@ var vueEslintConfig = (options, internalOptions = {}) => {
         "pinia/prefer-use-store-naming-convention": [
           ERROR,
           {
-            checkStoreNameMismatch: true
+            checkStoreNameMismatch: true,
+            storeSuffix: typeof options.pinia === "object" ? options.pinia.storesNameSuffix : "Store"
           }
         ],
         // 'pinia/require-setup-store-properties-export': ERROR,
@@ -2184,6 +2203,7 @@ var eslintConfig = (options = {}) => {
   const isVueEnabled = configsOptions.vue !== false && (Boolean(configsOptions.vue) || (0, import_local_pkg.isPackageExists)("vue"));
   const typescriptPackageInfo = (0, import_local_pkg.getPackageInfoSync)("typescript");
   const isTypescriptEnabled = configsOptions.ts !== false && Boolean(configsOptions.ts || typescriptPackageInfo);
+  const gitignoreConfig = typeof options.gitignore === "object" ? (0, import_eslint_config_flat_gitignore.default)(options.gitignore) : import_node_fs.default.existsSync(".gitignore") ? (0, import_eslint_config_flat_gitignore.default)() : null;
   const jsOptions = {
     ...assignOptions(configsOptions, "js")
   };
@@ -2248,7 +2268,11 @@ var eslintConfig = (options = {}) => {
     // According to ESLint docs: "If `ignores` is used without any other keys in the configuration object, then the patterns act as global ignores <...> Patterns are added after the default patterns, which are ["**/node_modules/", ".git/"]." - https://eslint.org/docs/latest/use/configure/configuration-files#globally-ignoring-files-with-ignores
     {
       ignores: options.ignores || ["**/dist"],
-      name: genFlatConfigEntryName("global-ignores")
+      name: genFlatConfigEntryName("ignores-global")
+    },
+    {
+      ...gitignoreConfig,
+      name: genFlatConfigEntryName("ignores-gitignore")
     },
     {
       plugins: {