Use a loose set of rules for consistent JSDoc comments
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- eslint, javascript
- Ambito
- tooling
Direzione di ricerca
Nell’issue non vengono indicati file né test. Inizia individuando la configurazione ESLint del repository e le linee guida JSDoc attuali, quindi confrontale con le opzioni valid-jsdoc proposte. Il lavoro è completato quando le regole di coerenza concordate sono applicate nella configurazione appropriata e verificate dai controlli di lint pertinenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
While using JSDoc should not be mandatory, I think that its users should aim for more consistency, which may be achieved by the following set of loose ESLint rules:
"valid-jsdoc": ["error", {
"prefer": {
"arg": "param",
"argument": "param",
"class": "constructor",
"return": "returns",
"virtual": "abstract"
},
"preferType": {
"Boolean": "boolean",
"Number": "number",
"object": "Object",
"String": "string"
},
"requireReturn": false
}]
- Lingua principale
- JavaScript
- Stelle
- 148k
- Fork
- 26.6k
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di airbnb/javascript
-
Severity: Unhandled promise rejection in `whitespace-async.js` when ESLint async path is usedForse già presa @bodapatisaikrishna l’ha presa 24 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
airbnb/javascript#3237 · 6 commenti ·
-
Inconsistent semicolon usage in examples (Arrays vs Functions)Forse già presa @Developer-shivamMishra l’ha presa 15 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
airbnb/javascript#3152 · 4 commenti ·
-
No error handling around execSync + JSON.parse in whitespace.js (ESLint 9 path)Forse già presa @dataCenter430 l’ha presa 220 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 48/100
airbnb/javascript#3238 · 8 commenti ·
-
Upgrading eslint-plugin-react-hooksForse già presa @weihongyu12 l’ha presa 365 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 38/100
airbnb/javascript#3186 · 3 commenti · 2 reazioni ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
airbnb/javascript#3173 · 9 commenti · 1 reazione ·
Tutte le issue di airbnb/javascript
Issue simili
-
bug MVP
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
saayam-for-all/webapp#1911 ·
I maintainer di solito rispondono entro 1 giorno
-
[Focus] Accessibility (a11y) [Package] Grid [Type] Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
Cancelled query leaves stale row index; next query on the connection returns leading empty slotsForse già presa @pislm l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
I maintainer di solito rispondono entro 7 giorni
-
Harden bayesian-waves-bg.js: add prefers-reduced-motion, pointer-events guard, and hidden-tab pauseAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
njitacm/njit-acm-website#109 ·