@perfective/eslint-config 0.29.2 → 0.30.0

package/rules/jsdoc/index.js

@@ -1,347 +1,161 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
+import eslintPluginJsdoc from 'eslint-plugin-jsdoc';
+export const jsdocConfig = {
+  plugins: {
+    jsdoc: {
+      rules: eslintPluginJsdoc.configs['flat/recommended'].plugins['jsdoc'].rules
     }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsdocConfig = void 0;
-const eslintPluginJsdoc = __importStar(require("eslint-plugin-jsdoc"));
-exports.jsdocConfig = {
-    plugins: {
-        jsdoc: {
-            rules: eslintPluginJsdoc.default.configs['flat/recommended'].plugins['jsdoc'].rules,
+  },
+  settings: {
+    jsdoc: {
+      tagNamePreference: {
+        augments: {
+          message: '@extends is to be used over @augments as it is more evocative of classes than @augments',
+          replacement: 'extends'
         },
-    },
-    settings: {
-        jsdoc: {
-            tagNamePreference: {
-                augments: {
-                    message: '@extends is to be used over @augments as it is more evocative of classes than @augments',
-                    replacement: 'extends',
-                },
-                todo: {
-                    message: 'Use TODO for comments',
-                },
-                fires: {
-                    replacement: 'emits',
-                },
-            },
-            ignoreReplacesDocs: true,
-            overrideReplacesDocs: true,
-            augmentsExtendsReplacesDocs: false,
-            implementsReplacesDoc: false,
+        todo: {
+          message: 'Use TODO for comments'
         },
-    },
-    rules: {
-        'jsdoc/check-access': 'off',
-        'jsdoc/check-alignment': 'error',
-        'jsdoc/check-examples': 'off',
-        'jsdoc/check-indentation': 'off',
-        'jsdoc/check-line-alignment': ['off', 'never'],
-        'jsdoc/check-param-names': ['error', {
-                allowExtraTrailingParamDocs: false,
-                checkDestructured: true,
-                checkRestProperty: false,
-                disableExtraPropertyReporting: false,
-                disableMissingParamChecks: false,
-                enableFixer: true,
-                useDefaultObjectProperties: false,
-            }],
-        'jsdoc/check-property-names': ['error', {
-                enableFixer: true,
-            }],
-        'jsdoc/check-syntax': 'error',
-        'jsdoc/check-tag-names': ['error', {
-                definedTags: ['final', 'flags', 'sealed', 'workaround'],
-                jsxTags: true,
-            }],
-        'jsdoc/check-template-names': 'error',
-        'jsdoc/check-types': ['error', {
-                noDefaults: false,
-            }],
-        'jsdoc/check-values': 'error',
-        'jsdoc/convert-to-jsdoc-comments': 'off',
-        'jsdoc/empty-tags': ['error', {
-                tags: ['final', 'flags', 'sealed'],
-            }],
-        'jsdoc/implements-on-classes': 'error',
-        'jsdoc/imports-as-dependencies': 'error',
-        'jsdoc/lines-before-block': 'off',
-        'jsdoc/match-description': 'error',
-        'jsdoc/match-name': 'off',
-        'jsdoc/multiline-blocks': ['error', {
-                noZeroLineText: true,
-                noFinalLineText: true,
-                noSingleLineBlocks: true,
-                singleLineTags: ['lends', 'type', 'deprecated'],
-                noMultilineBlocks: false,
-                multilineTags: ['*'],
-                allowMultipleTags: true,
-            }],
-        'jsdoc/no-bad-blocks': ['error', {
-                ignore: ['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck', 'typescript-eslint'],
-                preventAllMultiAsteriskBlocks: false,
-            }],
-        'jsdoc/no-blank-blocks': 'warn',
-        'jsdoc/no-blank-block-descriptions': 'off',
-        'jsdoc/no-defaults': 'error',
-        'jsdoc/no-missing-syntax': 'off',
-        'jsdoc/no-multi-asterisks': ['error', {
-                allowWhitespace: false,
-                preventAtMiddleLines: true,
-                preventAtEnd: true,
-            }],
-        'jsdoc/no-restricted-syntax': 'off',
-        'jsdoc/no-types': 'error',
-        'jsdoc/no-undefined-types': 'error',
-        'jsdoc/require-asterisk-prefix': ['error', 'always'],
-        'jsdoc/require-description': ['error', {
-                exemptedBy: ['inheritdoc', 'package', 'private', 'see', 'deprecated'],
-            }],
-        'jsdoc/require-description-complete-sentence': 'error',
-        'jsdoc/require-example': 'off',
-        'jsdoc/require-file-overview': 'off',
-        'jsdoc/require-hyphen-before-param-description': ['warn', 'always'],
-        'jsdoc/require-jsdoc': 'off',
-        'jsdoc/require-param': 'off',
-        'jsdoc/require-param-description': 'error',
-        'jsdoc/require-param-name': 'error',
-        'jsdoc/require-param-type': 'off',
-        'jsdoc/require-property': 'error',
-        'jsdoc/require-property-description': 'error',
-        'jsdoc/require-property-name': 'error',
-        'jsdoc/require-property-type': 'error',
-        'jsdoc/require-returns': 'off',
-        'jsdoc/require-returns-check': 'error',
-        'jsdoc/require-returns-description': 'error',
-        'jsdoc/require-returns-type': 'off',
-        'jsdoc/require-template': ['off', {
-                requireSeparateTemplates: false,
-            }],
-        'jsdoc/require-throws': 'error',
-        'jsdoc/require-yields': 'error',
-        'jsdoc/require-yields-check': 'error',
-        'jsdoc/sort-tags': ['warn', {
-                tagSequence: [
-                    {
-                        tags: [
-                            'summary',
-                            'typeSummary',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'module',
-                            'exports',
-                            'file',
-                            'fileoverview',
-                            'overview',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'typedef',
-                            'interface',
-                            'record',
-                            'template',
-                            'name',
-                            'kind',
-                            'type',
-                            'alias',
-                            'external',
-                            'host',
-                            'callback',
-                            'func',
-                            'function',
-                            'method',
-                            'class',
-                            'constructor',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'modifies',
-                            'mixes',
-                            'mixin',
-                            'mixinClass',
-                            'mixinFunction',
-                            'namespace',
-                            'borrows',
-                            'constructs',
-                            'lends',
-                            'implements',
-                            'requires',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'desc',
-                            'description',
-                            'classdesc',
-                            'tutorial',
-                            'copyright',
-                            'license',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'const',
-                            'constant',
-                            'final',
-                            'global',
-                            'readonly',
-                            'abstract',
-                            'virtual',
-                            'var',
-                            'member',
-                            'memberof',
-                            'memberof!',
-                            'inner',
-                            'instance',
-                            'inheritdoc',
-                            'inheritDoc',
-                            'override',
-                            'hideconstructor',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'param',
-                            'arg',
-                            'argument',
-                            'prop',
-                            'property',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'async',
-                            'generator',
-                            'default',
-                            'defaultvalue',
-                            'enum',
-                            'augments',
-                            'extends',
-                            'return',
-                            'returns',
-                            'throws',
-                            'exception',
-                            'yield',
-                            'yields',
-                            'event',
-                            'fires',
-                            'emits',
-                            'listens',
-                            'this',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'static',
-                            'private',
-                            'protected',
-                            'public',
-                            'access',
-                            'package',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'see',
-                            'example',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'closurePrimitive',
-                            'customElement',
-                            'expose',
-                            'hidden',
-                            'idGenerator',
-                            'meaning',
-                            'ngInject',
-                            'owner',
-                            'wizaction',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'define',
-                            'dict',
-                            'export',
-                            'externs',
-                            'implicitCast',
-                            'noalias',
-                            'nocollapse',
-                            'nocompile',
-                            'noinline',
-                            'nosideeffects',
-                            'polymer',
-                            'polymerBehavior',
-                            'preserve',
-                            'struct',
-                            'suppress',
-                            'unrestricted',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'category',
-                        ],
-                    },
-                    {
-                        tags: [
-                            'ignore',
-                            'author',
-                            'version',
-                            'variation',
-                            'since',
-                            'deprecated',
-                            'todo',
-                        ],
-                    },
-                ],
-                alphabetizeExtras: false,
-                linesBetween: 1,
-                reportTagGroupSpacing: true,
-                reportIntraTagGroupSpacing: true,
-            }],
-        'jsdoc/tag-lines': ['warn', 'always', {
-                count: 0,
-                startLines: 1,
-                endLines: 0,
-                applyToEndTag: false,
-                tags: {},
-            }],
-        'jsdoc/valid-types': 'error',
-    },
-};
+        fires: {
+          replacement: 'emits'
+        }
+      },
+      ignoreReplacesDocs: true,
+      overrideReplacesDocs: true,
+      augmentsExtendsReplacesDocs: false,
+      implementsReplacesDoc: false
+    }
+  },
+  rules: {
+    'jsdoc/check-access': 'off',
+    'jsdoc/check-alignment': 'error',
+    'jsdoc/check-examples': 'off',
+    'jsdoc/check-indentation': 'off',
+    'jsdoc/check-line-alignment': ['off', 'never'],
+    'jsdoc/check-param-names': ['error', {
+      allowExtraTrailingParamDocs: false,
+      checkDestructured: true,
+      checkRestProperty: false,
+      disableExtraPropertyReporting: false,
+      disableMissingParamChecks: false,
+      enableFixer: true,
+      useDefaultObjectProperties: false
+    }],
+    'jsdoc/check-property-names': ['error', {
+      enableFixer: true
+    }],
+    'jsdoc/check-syntax': 'error',
+    'jsdoc/check-tag-names': ['error', {
+      definedTags: ['final', 'flags', 'sealed', 'workaround'],
+      jsxTags: true
+    }],
+    'jsdoc/check-template-names': 'error',
+    'jsdoc/check-types': ['error', {
+      noDefaults: false
+    }],
+    'jsdoc/check-values': 'error',
+    'jsdoc/convert-to-jsdoc-comments': 'off',
+    'jsdoc/empty-tags': ['error', {
+      tags: ['final', 'flags', 'sealed']
+    }],
+    'jsdoc/implements-on-classes': 'error',
+    'jsdoc/imports-as-dependencies': 'error',
+    'jsdoc/lines-before-block': 'off',
+    'jsdoc/match-description': 'error',
+    'jsdoc/match-name': 'off',
+    'jsdoc/multiline-blocks': ['warn', {
+      noZeroLineText: true,
+      noFinalLineText: true,
+      noSingleLineBlocks: true,
+      singleLineTags: ['lends', 'type', 'deprecated'],
+      noMultilineBlocks: false,
+      multilineTags: ['*'],
+      allowMultipleTags: true
+    }],
+    'jsdoc/no-bad-blocks': ['error', {
+      ignore: ['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck', 'typescript-eslint'],
+      preventAllMultiAsteriskBlocks: false
+    }],
+    'jsdoc/no-blank-blocks': 'warn',
+    'jsdoc/no-blank-block-descriptions': 'off',
+    'jsdoc/no-defaults': 'error',
+    'jsdoc/no-missing-syntax': 'off',
+    'jsdoc/no-multi-asterisks': ['error', {
+      allowWhitespace: false,
+      preventAtMiddleLines: true,
+      preventAtEnd: true
+    }],
+    'jsdoc/no-restricted-syntax': 'off',
+    'jsdoc/no-types': 'error',
+    'jsdoc/no-undefined-types': 'error',
+    'jsdoc/require-asterisk-prefix': ['error', 'always'],
+    'jsdoc/require-description': ['error', {
+      exemptedBy: ['inheritdoc', 'package', 'private', 'see', 'deprecated']
+    }],
+    'jsdoc/require-description-complete-sentence': 'warn',
+    'jsdoc/require-example': 'off',
+    'jsdoc/require-file-overview': 'off',
+    'jsdoc/require-hyphen-before-param-description': ['warn', 'always'],
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-param': 'off',
+    'jsdoc/require-param-description': 'error',
+    'jsdoc/require-param-name': 'error',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-property': 'error',
+    'jsdoc/require-property-description': 'error',
+    'jsdoc/require-property-name': 'error',
+    'jsdoc/require-property-type': 'error',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/require-returns-check': 'error',
+    'jsdoc/require-returns-description': 'error',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/require-template': ['off', {
+      requireSeparateTemplates: false
+    }],
+    'jsdoc/require-throws': 'error',
+    'jsdoc/require-yields': 'error',
+    'jsdoc/require-yields-check': 'error',
+    'jsdoc/sort-tags': ['warn', {
+      tagSequence: [{
+        tags: ['summary', 'typeSummary']
+      }, {
+        tags: ['module', 'exports', 'file', 'fileoverview', 'overview']
+      }, {
+        tags: ['typedef', 'interface', 'record', 'template', 'name', 'kind', 'type', 'alias', 'external', 'host', 'callback', 'func', 'function', 'method', 'class', 'constructor']
+      }, {
+        tags: ['modifies', 'mixes', 'mixin', 'mixinClass', 'mixinFunction', 'namespace', 'borrows', 'constructs', 'lends', 'implements', 'requires']
+      }, {
+        tags: ['desc', 'description', 'classdesc', 'tutorial', 'copyright', 'license']
+      }, {
+        tags: ['const', 'constant', 'final', 'global', 'readonly', 'abstract', 'virtual', 'var', 'member', 'memberof', 'memberof!', 'inner', 'instance', 'inheritdoc', 'inheritDoc', 'override', 'hideconstructor']
+      }, {
+        tags: ['param', 'arg', 'argument', 'prop', 'property']
+      }, {
+        tags: ['async', 'generator', 'default', 'defaultvalue', 'enum', 'augments', 'extends', 'return', 'returns', 'throws', 'exception', 'yield', 'yields', 'event', 'fires', 'emits', 'listens', 'this']
+      }, {
+        tags: ['static', 'private', 'protected', 'public', 'access', 'package']
+      }, {
+        tags: ['see', 'example']
+      }, {
+        tags: ['closurePrimitive', 'customElement', 'expose', 'hidden', 'idGenerator', 'meaning', 'ngInject', 'owner', 'wizaction']
+      }, {
+        tags: ['define', 'dict', 'export', 'externs', 'implicitCast', 'noalias', 'nocollapse', 'nocompile', 'noinline', 'nosideeffects', 'polymer', 'polymerBehavior', 'preserve', 'struct', 'suppress', 'unrestricted']
+      }, {
+        tags: ['category']
+      }, {
+        tags: ['ignore', 'author', 'version', 'variation', 'since', 'deprecated', 'todo']
+      }],
+      alphabetizeExtras: false,
+      linesBetween: 1,
+      reportTagGroupSpacing: true,
+      reportIntraTagGroupSpacing: true
+    }],
+    'jsdoc/tag-lines': ['warn', 'always', {
+      count: 0,
+      startLines: 1,
+      endLines: 0,
+      applyToEndTag: false,
+      tags: {}
+    }],
+    'jsdoc/valid-types': 'error'
+  }
+};

package/rules/n/index.d.ts

@@ -1,4 +1,4 @@
-import * as eslintPluginN from 'eslint-plugin-n';
+import eslintPluginN from 'eslint-plugin-n';
 export declare const nConfig: {
     plugins: {
         n: import("eslint").ESLint.Plugin & {