Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[RFC]: add JSDoc lint rule to enforce whitespace before and after dash

Aperta
  • Qualcosa non va?
#13,662 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
javascript
Ambito
tooling

Direzione di ricerca

Inizia esaminando le regole di lint JSDoc esistenti e il comportamento discusso in stdlib-js/stdlib#13654. Chiarisci se questo RFC riguarda solo gli spazi prima e dopo il trattino oppure anche le altre regole proposte, quindi individua i test delle regole corrispondenti e fai in modo che verifichino gli esempi accettati e rifiutati nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Accepted Help Wanted RFC Tools

Currently, we do not catch when the dash separating a parameter name from a parameter description is bordered by more than one whitespace character. We should enforce only one whitespace character on either side of the dash. So the following is good:

/**
* ...
*
* @param {number} x - input value
* @returns {number} output value
*/

and the following should be disallowed

/**
*
* @param {number} x    -     input value
* @returns {number} output value
*/

In principle, we could have up to three different lint rules:

  1. enforce number of whitespace characters before dash
  2. enforce number of whitespace characters after dash
  3. enforce a specific character (e.g., -) to be used to separate a parameter name from a description

We could also have another lint rule for enforcing that a dash should not separate a @returns annotation from its description. This should likely be its own RFC.

Notes

Ref: https://github.com/stdlib-js/stdlib/pull/13654

Lingua principale
JavaScript
Stelle
6k
Fork
1.3k
Merge medio
1g 9h
PR unite (30g)
579

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stdlib-js/stdlib

Tutte le issue di stdlib-js/stdlib

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.