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

Abierto
#151 3 comentarios 2 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
rust, shell

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Rust
Estrellas
925
Forks
59
Merge medio
53 min
PR fusionados (30 d)
10

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de blopker/codebook

Todos los issues de blopker/codebook

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.