sindresorhus/eslint-plugin-unicorn

Create comment utility

クローズ

#370 opened on 2019/09/16

GitHub で見るコントリビューターガイド
 (3 件のコメント) (1 件のリアクション) (0 人の担当者)JavaScript (468 件のフォーク)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 個のスター)
PR merge metrics
 (平均マージ 4h 30m) (30d で 26 merged PRs)

説明

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.

コントリビューターガイド

調査方針
背景については PR #225 の議論を確認してください。ESLint のコメント添付 API（例: `getCommentsBefore`、`getCommentsAfter`）を調査します。最適なアプローチを決定します：コメントを保持する、移動する、または修正をスキップする。実装する場合は、複数のルールで再利用可能なユーティリティ関数に焦点を当ててください。そうでない場合は、ルール作成ガイドにコメント処理に関するドキュメントの注記を追加してください。
技術スタック
javascript
領域
toolingdeveloper experience
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
ESLint plugin developmentJavaScript ASTComments handling
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
25