gajus/eslint-plugin-jsdoc

`jsdoc/check-param-names` should be fixable if order is wrong

Open

#47 geöffnet am 25. Okt. 2017

Auf GitHub ansehen
 (10 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (172 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (1.215 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

I saw that another eslint plugin detects merely incorrect parameter order. It would be nice if this could be automatically fixed. You would have to ensure object properties are kept with param, and it could also (if this is preferred) move the @returns to the end.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor Guide

Research-Richtung
Untersuche die Logik der Regel `jsdoc/check param names` und die AST Struktur, um eine automatische Korrektur zu entwerfen, die Parameter neu anordnet, Objekteigenschaften beibehält und optional `@returns` an das Ende verschiebt.
Tech Stack
javascript
Domain
toolingdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ESLintJSDoc
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50