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

Offen
#151 3 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
rust, shell

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Rust
Sterne
925
Forks
59
Ø Merge
53 Min.
Gemergte PRs (30 T.)
10

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus blopker/codebook

Alle Issues in blopker/codebook

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.