Logo for jsDocs.io

eslint-plugin-jsdoc

  • Version 50.6.1
  • Published
  • 2.09 MB
  • 11 dependencies
  • BSD-3-Clause license

Install

npm i eslint-plugin-jsdoc
yarn add eslint-plugin-jsdoc
pnpm add eslint-plugin-jsdoc

Overview

JSDoc linting rules for ESLint.

Index

Variables

Type Aliases

Variables

variable index

const index: any;

  • {"recommended" | "stylistic" | "contents" | "logical"} ConfigGroups {"" | "-typescript" | "-typescript-flavor"} ConfigVariants {"" | "-error"} ErrorLevelVariants {import('eslint').ESLint.Plugin & { configs: Record<flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}, import('eslint').Linter.Config> }}

Type Aliases

type ConfigGroups

type ConfigGroups = 'recommended' | 'stylistic' | 'contents' | 'logical';

    type ConfigVariants

    type ConfigVariants = '' | '-typescript' | '-typescript-flavor';

      type ErrorLevelVariants

      type ErrorLevelVariants = '' | '-error';

        Package Files (1)

        Dependencies (11)

        Dev Dependencies (51)

        Peer Dependencies (1)

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/eslint-plugin-jsdoc.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/eslint-plugin-jsdoc)
        • HTML
          <a href="https://www.jsdocs.io/package/eslint-plugin-jsdoc"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>