eslint-config-un 0.3.0 → 0.3.1

package/README.md

@@ -37,6 +37,7 @@ Includes the rules from the following configs & plugins:
 - [css](https://www.npmjs.com/package/eslint-plugin-css) (since v0.2.0)
 - [jest](https://www.npmjs.com/package/eslint-plugin-jest) (+ [jest-extended](https://www.npmjs.com/package/eslint-plugin-jest-extended)) (since v0.3.0)
 - [vitest](https://www.npmjs.com/package/@vitest/eslint-plugin) (since v0.3.0)
+- [jsdoc](https://www.npmjs.com/package/eslint-plugin-jsdoc) (since v0.3.1)
 
 ## Features
 

package/dist/index.cjs

@@ -453,6 +453,15 @@ var createPluginObjectRenamer = (from, to) => {
     ])
   );
 };
+var bulkChangeRuleSeverity = (rules, severity) => Object.fromEntries(
+  Object.entries(rules).map(
+    ([ruleName, ruleOptions]) => [
+      ruleName,
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      Array.isArray(ruleOptions) ? [severity, ...ruleOptions.slice(1)] : severity
+    ]
+  )
+);
 var ConfigEntryBuilder = class {
   constructor(options, internalOptions) {
     this.options = options;
@@ -878,6 +887,53 @@ var jsEslintConfig = (options = {}, internalOptions = {}) => {
   return builder.getAllConfigs();
 };
 
+// src/configs/jsdoc.ts
+init_cjs_shims();
+var import_eslint_plugin_jsdoc = __toESM(require("eslint-plugin-jsdoc"), 1);
+var jsdocEslintConfig = (options = {}, internalOptions = {}) => {
+  const {
+    settings: pluginSettings,
+    typescript: typescriptOnlyRules = internalOptions.isTypescriptEnabled
+  } = options;
+  const builder = new ConfigEntryBuilder(options, internalOptions);
+  builder.addConfig("jsdoc/setup", {
+    plugins: {
+      jsdoc: import_eslint_plugin_jsdoc.default
+    }
+  });
+  builder.addConfig(["jsdoc", { includeDefaultFilesAndIgnores: true }], {
+    ...pluginSettings && {
+      settings: {
+        jsdoc: pluginSettings
+      }
+    }
+  }).addBulkRules(import_eslint_plugin_jsdoc.default.configs["flat/recommended-error"].rules).addRule("jsdoc/check-indentation", ERROR).addRule("jsdoc/check-line-alignment", ERROR).addRule("jsdoc/check-syntax", ERROR).addRule("jsdoc/check-template-names", ERROR).addRule("jsdoc/lines-before-block", ERROR).addRule("jsdoc/no-bad-blocks", ERROR).addRule("jsdoc/no-blank-block-descriptions", ERROR).addRule("jsdoc/no-blank-blocks", ERROR).addRule("jsdoc/no-defaults", ERROR).addRule("jsdoc/no-multi-asterisks", ERROR, [{ allowWhitespace: true }]).addRule("jsdoc/require-asterisk-prefix", ERROR).addRule("jsdoc/require-jsdoc", OFF).addRule("jsdoc/require-param", ERROR, [{ ignoreWhenAllParamsMissing: true }]).addRule("jsdoc/require-param-description", WARNING).addRule("jsdoc/require-property-description", WARNING).addRule("jsdoc/require-returns", OFF).addRule("jsdoc/require-returns-description", WARNING).addRule("jsdoc/sort-tags", ERROR).addOverrides();
+  const tsBuilder = new ConfigEntryBuilder(
+    typeof typescriptOnlyRules === "object" ? typescriptOnlyRules : {},
+    internalOptions
+  );
+  if (typescriptOnlyRules) {
+    const pluginSettingsForTs = (typeof typescriptOnlyRules === "object" ? typescriptOnlyRules.settings : void 0) || pluginSettings;
+    builder.addConfig(
+      [
+        "jsdoc/ts",
+        {
+          includeDefaultFilesAndIgnores: true,
+          filesFallback: [GLOB_TS, GLOB_TSX]
+        }
+      ],
+      {
+        ...pluginSettingsForTs && {
+          settings: {
+            jsdoc: pluginSettingsForTs
+          }
+        }
+      }
+    ).addRule("jsdoc/no-types", ERROR).addRule("jsdoc/no-undefined-types", OFF).addRule("jsdoc/require-param-type", OFF).addRule("jsdoc/require-property-type", OFF).addRule("jsdoc/require-returns-type", OFF).addOverrides();
+  }
+  return [...builder.getAllConfigs(), ...tsBuilder.getAllConfigs()];
+};
+
 // src/configs/jsonc.ts
 init_cjs_shims();
 var import_eslint_plugin_jsonc = __toESM(require("eslint-plugin-jsonc"), 1);
@@ -1454,7 +1510,7 @@ var tsEslintConfig = (options = {}, internalOptions = {}) => {
   }).addAnyRule("constructor-super", OFF).addAnyRule("getter-return", OFF).addAnyRule("no-const-assign", OFF).addAnyRule("no-dupe-args", OFF).addAnyRule("no-dupe-class-members", OFF).addAnyRule("no-dupe-keys", OFF).addAnyRule("no-func-assign", OFF).addAnyRule("no-new-native-nonconstructor", OFF).addAnyRule("no-obj-calls", OFF).addAnyRule("no-setter-return", OFF).addAnyRule("no-this-before-super", OFF).addAnyRule("no-undef", OFF).addAnyRule("no-unsafe-negation", OFF).addAnyRule("no-duplicate-imports", OFF);
   builder.addConfig("ts/dts", {
     files: ["**/*.d.?([cm])ts"]
-  }).addRule("@typescript-eslint/consistent-indexed-object-style", OFF).addRule("@typescript-eslint/method-signature-style", OFF).addRule("@typescript-eslint/no-empty-object-type", OFF).addRule("@typescript-eslint/no-explicit-any", OFF).addRule("@typescript-eslint/no-shadow", OFF).addRule("@typescript-eslint/no-unnecessary-type-parameters", OFF).addRule("@typescript-eslint/no-unused-vars", OFF).addRule("@typescript-eslint/no-use-before-define", OFF).addAnyRule("import/newline-after-import", OFF).addAnyRule("import/no-default-export", OFF);
+  }).addRule("@typescript-eslint/consistent-indexed-object-style", OFF).addRule("@typescript-eslint/method-signature-style", OFF).addRule("@typescript-eslint/no-empty-object-type", OFF).addRule("@typescript-eslint/no-explicit-any", OFF).addRule("@typescript-eslint/no-shadow", OFF).addRule("@typescript-eslint/no-unnecessary-type-parameters", OFF).addRule("@typescript-eslint/no-unused-vars", OFF).addRule("@typescript-eslint/no-use-before-define", OFF).addAnyRule("import/newline-after-import", OFF).addAnyRule("import/no-default-export", OFF).addAnyRule("vars-on-top", OFF).addAnyRule("no-var", OFF);
   if (options.noTypeAssertion) {
     builder.addConfig("ts/no-type-assertion", {
       plugins: {
@@ -1620,7 +1676,8 @@ var vueEslintConfig = (options, internalOptions = {}) => {
   const isLess2_6 = isVue2 && vueMajorAndMinorVersion < 2.6;
   const isLess3_1 = vueMajorAndMinorVersion < 3.1;
   const isNuxtEnabled = Boolean(options.nuxtMajorVersion);
-  const recommendedRules = import_eslint_plugin_vue.default.configs[isVue3 ? "flat/recommended" : "flat/vue2-recommended"].reduce((result, config) => Object.assign(result, config.rules), {});
+  const recommendedRulesRaw = import_eslint_plugin_vue.default.configs[isVue3 ? "flat/recommended" : "flat/vue2-recommended"].reduce((result, config) => Object.assign(result, config.rules), {});
+  const recommendedRules = bulkChangeRuleSeverity(recommendedRulesRaw, ERROR);
   const inNuxtAppDir = joinPaths.bind(null, options.nuxtOrVueProjectDir);
   const nuxtLayoutsFilesGlob = inNuxtAppDir("layouts/**/*.vue");
   const builder = new ConfigEntryBuilder(options, internalOptions);
@@ -1967,6 +2024,10 @@ var eslintConfig = (options = {}) => {
   const vitestOptions = {
     ...assignOptions(configsOptions, "vitest")
   };
+  const isJsdocEnabled = Boolean(configsOptions.jsdoc ?? true);
+  const jsdocOptions = {
+    ...assignOptions(configsOptions, "jsdoc")
+  };
   const isSecurityEnabled = Boolean(configsOptions.security ?? false);
   const securityOptions = {
     ...assignOptions(configsOptions, "security")
@@ -2041,6 +2102,7 @@ var eslintConfig = (options = {}) => {
     isCssInJsEnabled && cssInJsEslintConfig(cssInJsOptions, internalOptions),
     isJestEnabled && jestEslintConfig(jestOptions, internalOptions),
     isVitestEnabled && vitestEslintConfig(vitestOptions, internalOptions),
+    isJsdocEnabled && jsdocEslintConfig(jsdocOptions, internalOptions),
     isSecurityEnabled && securityEslintConfig(securityOptions, internalOptions),
     isPreferArrowFunctionsEnabled && preferArrowFunctionsEslintConfig(preferArrowFunctionsOptions, internalOptions),
     isYamlEnabled && yamlEslintConfig(yamlOptions, internalOptions),
@@ -2057,11 +2119,24 @@ var eslintConfig = (options = {}) => {
       name: genFlatConfigEntryName("config-files"),
       files: GLOB_CONFIG_FILES,
       rules: {
-        "import/no-default-export": OFF,
         "import/no-extraneous-dependencies": OFF,
         "n/no-unpublished-require": OFF
       }
     },
+    {
+      name: genFlatConfigEntryName("allow-default-export"),
+      files: [
+        ...GLOB_CONFIG_FILES,
+        // Files starting with a dot
+        `**/.*.${GLOB_JS_TS_X_EXTENSION}`,
+        // Storybook
+        `**/*.stories.${GLOB_JS_TS_X_EXTENSION}`,
+        ".storybook/**/*"
+      ],
+      rules: {
+        "import/no-default-export": OFF
+      }
+    },
     ...options.extraConfigs || [],
     // MUST be last
     !options.disablePrettierIncompatibleRules && {