Documentation

ESLint Plugin Integration

Use jsdoc-scribe lint rules through ESLint flat config.

Install

Install the plugin package next to ESLint.

npm install --save-dev eslint eslint-plugin-jsdoc-scribe

Flat config

Add the plugin to eslint.config.js and enable the rules you want enforced.

const jsdocScribe = require('eslint-plugin-jsdoc-scribe');

module.exports = [
  {
    files: ['**/*.{js,ts,tsx}'],
    plugins: {
      'jsdoc-scribe': jsdocScribe
    },
    rules: {
      'jsdoc-scribe/require-jsdoc': 'warn',
      'jsdoc-scribe/require-param': 'error',
      'jsdoc-scribe/require-returns': 'error'
    }
  }
];