sindresorhus/eslint-plugin-unicorn

Create comment utility

Closed

#370 opened on Sep 16, 2019

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

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

Description

See discussion here: https://github.com/sindresorhus/eslint-plugin-unicorn/pull/225#discussion_r294262451

We need to make handling comments easier. The current suggestions are:

  1. Comments should be preserved (may be non-trivial)
  2. Comments should be moved above a suitable node
  3. Do not fix if comments are detected

At the very least, we should add some notes in our documentation around creating rules since this comes up frequently.

Contributor guide

Research direction
Review the discussion in PR #225 for background. Explore ESLint's comment attachment API (e.g., `getCommentsBefore`, `getCommentsAfter`). Determine the best approach: preserve comments, move them, or skip fixing. If implementing, focus on a utility function that can be reused across rules. Otherwise, add documentation notes to the rule creation guide explaining comment handling.
Tech stack
javascript
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.
Mostly clear
Prerequisites
ESLint plugin developmentJavaScript ASTComments handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25