sindresorhus/eslint-plugin-unicorn

prevent-abbreviations: when multiple replacements are defined, suggest each through ESLint's suggest API

クローズ

#767 opened on 2020/06/03

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

Repository metrics

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

説明

Currently, the prevent-abbreviations autofixer only applies when there is only a single replacement defined. But when multiple replacements are there (if the abbreviation is ambiguous) the violation has to be fixed manually.

It would be nice if the replacements were all suggested to the user in the editor/IDE to pick from. ESLint has the suggest API for this: https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions

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

調査方針
eslint plugin unicorn の `prevent abbreviations` ルールの現在の実装を調べ、置換の処理方法を理解します。その後、ESLint の提案 API (https://eslint.org/docs/developer guide/working with rules#providing suggestions) を実装し、1つの略語に対して複数の置換が定義されている場合に、各可能な置換を提案として提供します。Issue の議論とルールのソースコードを参照してください。
技術スタック
javascript
領域
developer experiencetooling
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
familiarity with ESLint plugin developmentunderstanding of suggestion API
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40