Skip to content

publicOnly throws Missing JSDoc on private constructors or methods #713

@lublak

Description

@lublak

Expected behavior

Should not grumble at private methods.

Actual behavior

Currently, the publicOnly is completely ignored for methods in a class.
error Missing JSDoc comment jsdoc/require-jsdoc

ESLint Config

{
    "env": {
        "browser": true,
        "es2021": true
    },
    "extends": [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended"
    ],
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "ecmaVersion": 12,
        "sourceType": "module",
        "project": "./tsconfig.json"
    },
    "plugins": [
        "@typescript-eslint",
        "jsdoc"
    ],
    "rules": {
        "jsdoc/require-jsdoc": [
            "error",
            {
                "publicOnly": true,
                "require": {
                    "ArrowFunctionExpression": true,
                    "ClassDeclaration": true,
                    "ClassExpression": true,
                    "FunctionDeclaration": true,
                    "FunctionExpression": true,
                    "MethodDefinition": true
                }
            }
        ]
    }
}

ESLint sample

export class Test {
    private constructor() {
    }
    private test():void {

    }
}

Environment

  • Node version: v14.15.0.
  • ESLint version v7.25.0
  • eslint-plugin-jsdoc version: 32.3.1

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions