Skip to content
uglier

lints-jsdoc

See the source

Enforces JSDoc documentation standards across your codebase using eslint-plugin-jsdoc.

What it enforces

Section titled “What it enforces”
  • All public functions must have descriptions
  • @param tags with types and descriptions
  • @returns tags with types
  • Valid tag names and types
  • TypeScript-compatible JSDoc mode

Default file patterns

Section titled “Default file patterns”
["src/**/*.{js,mjs,cjs}"]

Options

Section titled “Options”
uglify({
  with: ["lints-jsdoc"],
  options: {
    "lints-jsdoc": {
      files: ["src/**/*.js"],
      ignores: ["src/tests/**"],
      overrides: {
        "jsdoc/require-description": "warn",
      },
    },
  },
})

files

Section titled “files”

Array of glob patterns for files this config applies to.

ignores

Section titled “ignores”

Array of glob patterns for files to exclude.

overrides

Section titled “overrides”

An object of JSDoc rule overrides merged on top of the defaults.