sindresorhus/eslint-plugin-unicorn

Rule proposal: Doc comment asterisk prefix style

Closed

#1,607 opened on Nov 11, 2021

View on GitHubContributor guide
 (3 comments) (2 reactions) (0 assignees)JavaScript (468 forks)user submission
help wantednew rule

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Description

I prefer not using asterisk prefix on doc comments as I find them noisy and they also make it much harder to edit comments.

I'm aware you can almost get this with the JSDoc ESLint plugin, but it's a bit heavy to add that just for this and doc comments do not necessarily need to be JSDoc, so this rule would be more general.

Fail

/**
 * Add two numbers.
 * @param {number} num1 The first number.
 * @param {number} num2 The second number.
 * @returns {number} The sum of the two numbers.
 */

Pass

/**
Add two numbers.
@param {number} num1 The first number.
@param {number} num2 The second number.
@returns {number} The sum of the two numbers.
*/

(Notice how */ moved too)

Contributor guide

Research direction
Investigate existing rules in eslint plugin unicorn that deal with comments (e.g., 'better regex', 'empty line after comment') to understand the pattern. Look at the ESLint rule structure and how to traverse AST for doc comments (BlockComment nodes). Check if there is any prior discussion in the issue comments (3 comments) for further clarification. The rule should be implemented as a new file in the 'rules' directory, with corresponding tests in 'test' directory.
Tech stack
javascriptnodejs
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLint plugin developmentAST knowledgeJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65