[FEATURE]: Add directive comments to ignore a word on a per instance basis

オープン
#151 コメント 3 件 リアクション 2 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
rust, shell

調査の方向性

Start by reading the project's spell-checking entry points and tests to find how ignored words are currently configured; the issue does not name specific files. Then determine how directive comments could be associated with individual word occurrences and what syntax and scope they should support. Done means a documented directive can suppress one spelling occurrence while leaving other occurrences flagged, with tests covering both cases.

索引モデルが issue の本文から書いたものです。

説明

enhancement feedback needed
Feature Description

It would be nice to ignore a single instance of a spelling issue rather than project wide or globally. Similar to how shellcheck does it:

# shellcheck disable=SC2016
PS4='+$BASH_SOURCE:$LINENO:$FUNCNAME: '
Use Case

The use case here is sometimes you're calling code that you have no control over and a function name has a weird spelling (e.g. fzf's advanced configuration uses _fzf_comprun()). comprun is a word that generally I want to be flagged as a spelling error, but in that one case I'd like to ignore it

Proposed Solution

Probably something like how shellcheck does it:

# shellcheck disable=SC2016
PS4='+$BASH_SOURCE:$LINENO:$FUNCNAME: '
Alternative Solutions

No response

Examples

No response

Additional Context

No response

主要言語
Rust
スター
925
フォーク
59
平均マージ
53分
マージ済み PR(30日)
10

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

blopker/codebook のほかの issue

blopker/codebook の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。