[RFC]: add JSDoc lint rule to enforce whitespace before and after dash
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 48/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Calme
- Stack technique
- javascript
- Domaine
- tooling
Piste de recherche
Commencez par examiner les règles de lint JSDoc existantes et le comportement abordé dans stdlib-js/stdlib#13654. Déterminez si ce RFC couvre uniquement les espaces avant et après le tiret ou également les autres règles proposées, puis identifiez les tests de règles correspondants et faites-les vérifier les exemples acceptés et rejetés dans l’issue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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:
- enforce number of whitespace characters before dash
- enforce number of whitespace characters after dash
- 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
- Langage dominant
- JavaScript
- Étoiles
- 6k
- Forks
- 1.3k
- Merge moyen
- 1 j 3 h
- PR mergées (30 j)
- 585
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de stdlib-js/stdlib
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Les mainteneurs répondent en général sous 1 jour
-
Bug
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
stdlib-js/stdlib#15456 · 3 commentaires · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
stdlib-js/stdlib#15193 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Fix JavaScript lint errorsOuverteGood First Issue
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
stdlib-js/stdlib#14759 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Fix C lint errorsOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de stdlib-js/stdlib
Issues similaires
-
bug good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
amponce/archive-movie-browser#354 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
saayam-for-all/webapp#1870 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Imageomics/OpenCite#66 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
chr15m/twiiit.com#20 ·
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
antropos17/Aegis#629 ·
Les mainteneurs répondent en général sous 4 jours