@prowise/eslint-config-linting-rules 0.0.1

package/src/rules/plugin-import-rules.js

@@ -0,0 +1,315 @@
+module.exports = {
+    rules: {
+        /**
+         * Ensure default import coupled with default export
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/default.md.
+         */
+        "import/default": "off",
+
+        /**
+         * Dynamic imports require a leading comment with a webpackChunkName
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/dynamic-import-chunkname.md.
+         */
+        "import/dynamic-import-chunkname": ["off", { importFunctions: [], webpackChunknameFormat: "[0-9a-zA-Z-_/.]+" }],
+
+        /**
+         * Disallow invalid exports, e.g. Multiple defaults
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/export.md.
+         */
+        "import/export": "error",
+
+        /**
+         * This rule enforces that all exports are declared at the bottom of the file.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md.
+         */
+        "import/exports-last": "off",
+
+        /**
+         * Ensure consistent use of file extension within the import path
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md.
+         */
+        "import/extensions": ["error", "ignorePackages", { js: "never", mjs: "never", jsx: "never" }],
+
+        /**
+         * Disallow non-import statements appearing before import statements
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md.
+         */
+        "import/first": "error",
+
+        /**
+         * Reports when named exports are not grouped together in a single export declaration
+         * or when multiple assignments to CommonJS module.exports or exports object are present
+         * in a single file.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md.
+         */
+        "import/group-exports": "off",
+
+        /**
+         * Forbid modules to have too many dependencies
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md.
+         */
+        "import/max-dependencies": ["off", { max: 10 }],
+
+        /**
+         * Ensure named imports coupled with named exports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/named.md#.
+         */
+        "import/named": "error",
+
+        /**
+         * Enforces names exist at the time they are dereferenced, when imported as a full namespace
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/namespace.md.
+         */
+        "import/namespace": "off",
+
+        /**
+         * Require a newline after the last import/require in a group
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md.
+         */
+        "import/newline-after-import": "error",
+
+        /**
+         * Forbid import of modules using absolute paths
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md.
+         */
+        "import/no-absolute-path": "error",
+
+        /**
+         * Disallow AMD require/define
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-amd.md.
+         */
+        "import/no-amd": "error",
+
+        /**
+         * Reports if a module"s default export is unnamed
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-anonymous-default-export.md.
+         */
+        "import/no-anonymous-default-export": [
+            "off",
+            {
+                allowArray: false,
+                allowArrowFunction: false,
+                allowAnonymousClass: false,
+                allowAnonymousFunction: false,
+                allowLiteral: false,
+                allowObject: false,
+            },
+        ],
+
+        /**
+         * Disallow require()
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-commonjs.md.
+         */
+        "import/no-commonjs": "off",
+
+        /**
+         * Forbid cyclical dependencies between modules
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md.
+         */
+        "import/no-cycle": ["error", { maxDepth: "∞" }],
+
+        /**
+         * Forbid default exports. This is a terrible rule, do not use it.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md.
+         */
+        "import/no-default-export": "off",
+
+        /**
+         * Disallow use of jsdoc-marked-deprecated imports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-deprecated.md.
+         */
+        "import/no-deprecated": "off",
+
+        /**
+         * Disallow duplicate imports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md.
+         */
+        "import/no-duplicates": "error",
+
+        /**
+         * Forbid require() calls with expressions
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-dynamic-require.md.
+         */
+        "import/no-dynamic-require": "error",
+
+        /**
+         * Forbid the use of extraneous packages
+         * paths are treated both as absolute paths, and relative to process.cwd()
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md.
+         */
+        "import/no-extraneous-dependencies": [
+            "off",
+            {
+                devDependencies: [
+                    "test/**", // tape, common npm pattern
+                    "tests/**", // also common npm pattern
+                    "spec/**", // mocha, rspec-like pattern
+                    "**/__tests__/**", // jest pattern
+                    "**/__mocks__/**", // jest pattern
+                    "test.{js,jsx}", // repos with a single test file
+                    "test-*.{js,jsx}", // repos with multiple top-level test files
+                    "**/*{.,_}{test,spec}.{js,jsx}", // tests where the extension or filename suffix denotes that it is a test
+                    "**/jest.config.js", // jest config
+                    "**/jest.setup.js", // jest setup
+                    "**/vue.config.js", // vue-cli config
+                    "**/webpack.config.js", // webpack config
+                    "**/webpack.config.*.js", // webpack config
+                    "**/rollup.config.js", // rollup config
+                    "**/rollup.config.*.js", // rollup config
+                    "**/gulpfile.js", // gulp config
+                    "**/gulpfile.*.js", // gulp config
+                    "**/Gruntfile{,.js}", // grunt config
+                    "**/protractor.conf.js", // protractor config
+                    "**/protractor.conf.*.js", // protractor config
+                    "**/karma.conf.js", // karma config
+                    "**/.eslintrc.js", // eslint config
+                ],
+                optionalDependencies: false,
+            },
+        ],
+
+        /**
+         * Reports the use of import declarations with CommonJS exports in any module except for the main module.
+         * Https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-import-module-exports.md.
+         */
+        "import/no-import-module-exports": ["error", { exceptions: [] }],
+
+        /**
+         * Prevent importing the submodules of other modules
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-internal-modules.md.
+         */
+        "import/no-internal-modules": ["off", { allow: [] }],
+
+        /**
+         * Forbid mutable exports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md.
+         */
+        "import/no-mutable-exports": "error",
+
+        /**
+         * Do not allow a default import name to match a named export
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default.md.
+         */
+        "import/no-named-as-default": "error",
+
+        /**
+         * Warn on accessing default export property names that are also named exports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default-member.md.
+         */
+        "import/no-named-as-default-member": "error",
+
+        /**
+         * Prevent importing the default as if it were named
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-default.md.
+         */
+        "import/no-named-default": "error",
+
+        /**
+         * Prohibit named exports. This is a terrible rule, do not use it.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-export.md.
+         */
+        "import/no-named-export": "off",
+
+        /**
+         * Disallow namespace imports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-namespace.md.
+         */
+        "import/no-namespace": "off",
+
+        /**
+         * No Node.js builtin modules
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-nodejs-modules.md.
+         */
+        "import/no-nodejs-modules": "off",
+
+        /**
+         * Use this rule to prevent importing packages through relative paths.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md.
+         */
+        "import/no-relative-packages": "error",
+
+        /**
+         * Use this rule to prevent imports to folders in relative parent paths.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-parent-imports.md.
+         */
+        "import/no-relative-parent-imports": "off",
+
+        /**
+         * Restrict which files can be imported in a given folder
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-restricted-paths.md.
+         */
+        "import/no-restricted-paths": "off",
+
+        /**
+         * Forbid a module from importing itself
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md.
+         */
+        "import/no-self-import": "error",
+
+        /**
+         * Prevent unassigned imports
+         * importing for side effects is perfectly acceptable, if you need side effects.
+         * Https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unassigned-import.md.
+         */
+        "import/no-unassigned-import": "off",
+
+        /**
+         * Ensure imports point to files/modules that can be resolved
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unresolved.md.
+         */
+        "import/no-unresolved": ["error", { commonjs: true, caseSensitive: true }],
+
+        /**
+         * Reports modules without any exports, or with unused exports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md
+         * TODO: enable once it supports CJS.
+         */
+        "import/no-unused-modules": [
+            "off",
+            {
+                ignoreExports: [],
+                missingExports: true,
+                unusedExports: true,
+            },
+        ],
+
+        /**
+         * Ensures that there are no useless path segments
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md.
+         */
+        "import/no-useless-path-segments": ["error", { commonjs: true }],
+
+        /**
+         * Forbid Webpack loader syntax in imports
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-webpack-loader-syntax.md.
+         */
+        "import/no-webpack-loader-syntax": "error",
+
+        /**
+         * Ensure absolute imports are above relative imports and that unassigned imports are ignored
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md.
+         */
+        "import/order": [
+            "error",
+            {
+                groups: [["builtin", "external", "internal"]],
+                alphabetize: { order: "asc", caseInsensitive: true },
+            },
+        ],
+
+        /**
+         * Require modules with a single export to use a default export
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md.
+         */
+        "import/prefer-default-export": "error",
+
+        /**
+         * Warn if a module could be mistakenly parsed as a script by a consumer
+         * leveraging Unambiguous JavaScript Grammar
+         * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/unambiguous.md
+         * this should not be enabled until this proposal has at least been *presented* to TC39.
+         * At the moment, it"s not a thing.
+         */
+        "import/unambiguous": "off",
+    },
+};

package/src/rules/plugin-jsdoc-rules.js

@@ -0,0 +1,321 @@
+module.exports = {
+    /*
+     * ✅ recommended
+     * 🔧 fixable
+     * 💡 has suggestion
+     */
+
+    plugin: ["jsdoc"],
+
+    rules: {
+        /**
+         * Checks that `@access` tags have a valid value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access.
+         */
+        "jsdoc/check-access": "warn",
+
+        /**
+         * Reports invalid alignment of JSDoc block asterisks ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment.
+         */
+        "jsdoc/check-alignment": "warn",
+
+        /**
+         * Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples.
+         */
+        "jsdoc/check-examples": "off",
+
+        /**
+         * Reports invalid padding inside JSDoc blocks
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation.
+         */
+        "jsdoc/check-indentation": "warn",
+
+        /**
+         * Reports invalid alignment of JSDoc block lines
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment.
+         */
+        "jsdoc/check-line-alignment": "warn",
+
+        /**
+         * Ensures that parameter names in JSDoc match those in the function declaration ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names.
+         */
+        "jsdoc/check-param-names": "warn",
+
+        /**
+         * Ensures that property names in JSDoc are not duplicated on the same block and that nested
+         * properties have defined roots ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names.
+         */
+        "jsdoc/check-property-names": "warn",
+
+        /**
+         * Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode)
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax.
+         */
+        "jsdoc/check-syntax": "warn",
+
+        /**
+         * Reports invalid block tag names ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names.
+         */
+        "jsdoc/check-tag-names": "warn",
+
+        /**
+         * Reports invalid types ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types.
+         */
+        "jsdoc/check-types": "warn",
+
+        /**
+         * This rule checks the values for a handful of tags: `@version`, `@since`, `@license` and `@author` ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values.
+         */
+        "jsdoc/check-values": "warn",
+
+        /**
+         * Expects specific tags to be empty of any content ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-empty-tags.
+         */
+        "jsdoc/empty-tags": "warn",
+
+        /**
+         * Reports an issue with any non-constructor function using `@implements ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-implements-on-classes.
+         */
+        "jsdoc/implements-on-classes": "warn",
+
+        /**
+         * Enforces a regular expression pattern on descriptions
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description.
+         */
+        "jsdoc/match-description": "warn",
+
+        /**
+         * Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-multiline-blocks.
+         */
+        "jsdoc/multiline-blocks": "warn",
+
+        /**
+         * Enforces a consistent padding of the block description ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-newline-after-description.
+         */
+        "jsdoc/newline-after-description": "warn",
+
+        /**
+         * This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-bad-blocks.
+         */
+        "jsdoc/no-bad-blocks": "warn",
+
+        /**
+         * His rule reports defaults being used on the relevant portion of `@param` or `@default`
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-defaults.
+         */
+        "jsdoc/no-defaults": "warn",
+
+        /**
+         * Reports when certain comment structures are always expected
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-missing-syntax.
+         */
+        "jsdoc/no-missing-syntax": "off",
+
+        /**
+         * ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-multi-asterisks.
+         */
+        "jsdoc/no-multi-asterisks": "warn",
+
+        /**
+         * Reports when certain comment structures are present
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-restricted-syntax.
+         */
+        "jsdoc/no-restricted-syntax": "off",
+
+        /**
+         * This rule reports types being used on `@param` or `@returns`
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types.
+         */
+        "jsdoc/no-types": "warn",
+
+        /**
+         * Checks that types in jsdoc comments are defined ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-undefined-types.
+         */
+        "jsdoc/no-undefined-types": "warn",
+
+        /**
+         * Checks that types in jsdoc comments are defined
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-undefined-types.
+         */
+        "jsdoc/require-asterisk-prefix": "warn",
+
+        /**
+         * Requires that all functions have a description
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description.
+         */
+        "jsdoc/require-description": "warn",
+
+        /**
+         * Requires that block description, explicit `@description`, and `@param`/`@returns`
+         * tag descriptions are written in complete sentences
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description-complete-sentence.
+         */
+        "jsdoc/require-description-complete-sentence": "warn",
+
+        /**
+         * Requires that all functions have examples
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-example.
+         */
+        "jsdoc/require-example": "off",
+
+        /**
+         * Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-file-overview.
+         */
+        "jsdoc/require-file-overview": "off",
+
+        /**
+         * Requires a hyphen before the `@param` description
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-hyphen-before-param-description.
+         */
+        "jsdoc/require-hyphen-before-param-description": "off",
+
+        /**
+         * Require JSDoc comments ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc.
+         */
+        "jsdoc/require-jsdoc": [
+            "error",
+            {
+                publicOnly: false,
+                exemptEmptyConstructors: false,
+                checkGetters: true,
+                checkSetters: true,
+                require: {
+                    ClassDeclaration: true,
+                    ClassExpression: true,
+                    FunctionDeclaration: true,
+                    FunctionExpression: true,
+                    MethodDefinition: true,
+                },
+                contexts: [
+                    // @see https://ts-ast-viewer.com/#
+                    "ClassProperty",
+                    "FunctionDeclaration",
+                    "TSTypeAliasDeclaration",
+                    "VariableStatement",
+                    "TSInterfaceDeclaration",
+                    "TSTypeAliasDeclaration TSPropertySignature",
+                    "TSInterfaceDeclaration TSPropertySignature",
+                ],
+            },
+        ],
+
+        /**
+         * Requires that all function parameters are documented ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param.
+         */
+        "jsdoc/require-param": "warn",
+
+        /**
+         * Requires that each `@param` tag has a `description` value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-description.
+         */
+        "jsdoc/require-param-description": "warn",
+
+        /**
+         * Requires that all function parameters have names ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-name.
+         */
+        "jsdoc/require-param-name": "warn",
+
+        /**
+         * Requires that each `@param` tag has a `type` value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type.
+         */
+        "jsdoc/require-param-type": "off",
+
+        /**
+         * Requires that all `@typedef` and `@namespace` tags have `@property` when their type ✅
+         * is a plain `object`, `Object`, or `PlainObject
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property.
+         */
+        "jsdoc/require-property": "warn",
+
+        /**
+         * Requires that each `@property` tag has a `description` value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-description.
+         */
+        "jsdoc/require-property-description": "warn",
+
+        /**
+         * Requires that all function `@property` tags have names ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-name.
+         */
+        "jsdoc/require-property-name": "warn",
+
+        /**
+         * Requires that each `@property` tag has a `type` value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-type.
+         */
+        "jsdoc/require-property-type": "warn",
+
+        /**
+         * Requires that returns are documented ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns.
+         */
+        "jsdoc/require-returns": "warn",
+
+        /**
+         * Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-check.
+         */
+        "jsdoc/require-returns-check": "warn",
+
+        /**
+         * Requires that the `@returns` tag has a `description` value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-description.
+         */
+        "jsdoc/require-returns-description": "warn",
+
+        /**
+         * Requires that `@returns` tag has `type` value ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type.
+         */
+        "jsdoc/require-returns-type": "off",
+
+        /**
+         * Requires that throw statements are documented
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-throws.
+         */
+        "jsdoc/require-throws": "warn",
+
+        /**
+         * Requires yields are documented ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields.
+         */
+        "jsdoc/require-yields": "warn",
+
+        /**
+         * Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields-check.
+         */
+        "jsdoc/require-yields-check": "warn",
+
+        /**
+         * Enforces lines (or no lines) between tags ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-tag-lines.
+         */
+        "jsdoc/tag-lines": "warn",
+
+        /**
+         * Requires all types to be valid JSDoc or Closure compiler types without syntax errors ✅
+         * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-valid-types.
+         */
+        "jsdoc/valid-types": "warn",
+    },
+};