eslint-plugin-jsdoc 63.3.2 → 64.0.0

package/src/index-esm.js

@@ -1,196 +0,0 @@
-/* eslint-disable perfectionist/sort-imports -- For auto-generate; Do not remove */
-import {
-  merge,
-} from 'object-deep-merge';
-
-// BEGIN REPLACE
-import index from './index-cjs.js';
-import {
-  buildForbidRuleDefinition,
-} from './buildForbidRuleDefinition.js';
-import {
-  buildRejectOrPreferRuleDefinition,
-} from './buildRejectOrPreferRuleDefinition.js';
-
-// eslint-disable-next-line unicorn/prefer-export-from --- Reusing `index`
-export default index;
-// END REPLACE
-
-/**
- * @type {((
- *   cfg?: import('eslint').Linter.Config & {
- *     config?: `flat/${import('./index-cjs.js').ConfigGroups}${import('./index-cjs.js').ConfigVariants}${import('./index-cjs.js').ErrorLevelVariants}`,
- *     mergeSettings?: boolean,
- *     settings?: Partial<import('./iterateJsdoc.js').Settings>,
- *     rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>},
- *     extraRuleDefinitions?: {
- *       forbid?: {
- *         [contextName: string]: {
- *           description?: string,
- *           url?: string,
- *           contexts: (string|{
- *             message: string,
- *             context: string,
- *             comment: string
- *           })[]
- *         }
- *       },
- *       preferTypes?: {
- *         [typeName: string]: {
- *           description: string,
- *           overrideSettings: {
- *             [typeNodeName: string]: {
- *               message: string,
- *               replacement?: false|string,
- *               unifyParentAndChildTypeChecks?: boolean,
- *             }
- *           },
- *           url: string,
- *         }
- *       }
- *     }
- *   }
- * ) => import('eslint').Linter.Config)}
- */
-export const jsdoc = function (cfg) {
-  /** @type {import('eslint').Linter.Config} */
-  let outputConfig = {
-    plugins: {
-      jsdoc: index,
-    },
-  };
-
-  if (cfg) {
-    if (cfg.config) {
-      // @ts-expect-error Security check
-      if (cfg.config === '__proto__') {
-        throw new TypeError('Disallowed config value');
-      }
-
-      outputConfig = /** @type {import('eslint').Linter.Config} */ (index.configs[cfg.config]);
-    }
-
-    if (cfg.rules) {
-      outputConfig.rules = {
-        ...outputConfig.rules,
-        ...cfg.rules,
-      };
-    }
-
-    if (cfg.plugins) {
-      outputConfig.plugins = {
-        ...outputConfig.plugins,
-        ...cfg.plugins,
-      };
-    }
-
-    if (cfg.name) {
-      outputConfig.name = cfg.name;
-    }
-
-    if (cfg.basePath) {
-      outputConfig.basePath = cfg.basePath;
-    }
-
-    if (cfg.files) {
-      outputConfig.files = cfg.files;
-    }
-
-    if (cfg.ignores) {
-      outputConfig.ignores = cfg.ignores;
-    }
-
-    if (cfg.language) {
-      outputConfig.language = cfg.language;
-    }
-
-    if (cfg.languageOptions) {
-      outputConfig.languageOptions = cfg.languageOptions;
-    }
-
-    if (cfg.linterOptions) {
-      outputConfig.linterOptions = cfg.linterOptions;
-    }
-
-    if (cfg.processor) {
-      outputConfig.processor = cfg.processor;
-    }
-
-    if (cfg.extraRuleDefinitions) {
-      if (!outputConfig.plugins?.jsdoc?.rules) {
-        throw new Error('JSDoc plugin required for `extraRuleDefinitions`');
-      }
-
-      if (cfg.extraRuleDefinitions.forbid) {
-        for (const [
-          contextName,
-          {
-            contexts,
-            description,
-            url,
-          },
-        ] of Object.entries(cfg.extraRuleDefinitions.forbid)) {
-          outputConfig.plugins.jsdoc.rules[`forbid-${contextName}`] =
-            buildForbidRuleDefinition({
-              contextName,
-              contexts,
-              description,
-              url,
-            });
-        }
-      }
-
-      if (cfg.extraRuleDefinitions.preferTypes) {
-        for (const [
-          typeName,
-          {
-            description,
-            overrideSettings,
-            url,
-          },
-        ] of Object.entries(cfg.extraRuleDefinitions.preferTypes)) {
-          outputConfig.plugins.jsdoc.rules[`prefer-type-${typeName}`] =
-            buildRejectOrPreferRuleDefinition({
-              description,
-              overrideSettings,
-              typeName,
-              url,
-            });
-        }
-      }
-    }
-  }
-
-  outputConfig.settings = {
-    jsdoc: cfg?.mergeSettings === false ?
-      cfg.settings :
-      merge(
-        {},
-        cfg?.settings ?? {},
-        cfg?.config?.includes('recommended') ?
-          {
-            // We may need to drop these for "typescript" (non-"flavor") configs,
-            //   if support is later added: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
-            structuredTags: {
-              next: {
-                required: [
-                  'type',
-                ],
-              },
-              rejects: {
-                required: [
-                  'type',
-                ],
-              },
-            },
-          } :
-          {},
-      ),
-  };
-
-  return outputConfig;
-};
-
-export {
-  getJsdocProcessorPlugin,
-} from './getJsdocProcessorPlugin.js';

package/src/index.cjs.cts

@@ -1,3 +0,0 @@
-import items from './index-cjs.js';
-
-export = items;

package/src/iterateJsdoc.cts

@@ -1,7 +0,0 @@
-import iterateJsdoc, {getSettings, parseComment} from './iterateJsdoc.js';
-
-export = {
-  default: iterateJsdoc as typeof iterateJsdoc,
-  getSettings: getSettings as typeof getSettings,
-  parseComment: parseComment as typeof parseComment
-};