Skip to content

Parser shouldn't allow consider slash names to be JSDoc tags #1116

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Expected behavior

Block comments that refer to org-scoped npm packages at the start of a line shouldn't be treated as JSDoc tags:

/**
 * @ember/debug etc. etc.
 */

...or at least, the default VS Code syntax highlighting doesn't treat them as tags.

Actual behavior

This package does consider them tags. You can see the failures in action in DefinitelyTyped/DefinitelyTyped#65660 -> https://github.com/DefinitelyTyped/DefinitelyTyped/actions/runs/5196271458/jobs/9369812259?pr=65660:

2023-06-07T05:26:07.4195485Z 1> /home/runner/work/DefinitelyTyped/DefinitelyTyped/types/ember/test/debug.ts
2023-06-07T05:26:07.4196193Z 1>   14:1  error  Invalid JSDoc tag name "ember/debug"  jsdoc/check-tag-names

ESLint Config

module.exports = {
    plugins: ['jsdoc'],
    rules: {
        'jsdoc/check-tag-names': ['error', { typed: true }]
    }
};

ESLint sample

/**
 * @ember/debug etc. etc.
 */

Environment

  • Node version: v20.0.0
  • ESLint version v8.38.0
  • eslint-plugin-jsdoc version: 44.2.7

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions