saadq/lynt

Improve LyntResult example

Open

#7 aperta il 17 mag 2018

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (6 fork)github user discovery
docsgood first issue

Metriche repository

Star
 (383 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The "LyntResult example" in the API docs currently just shows this:

{
  filePath: string
  errors: Array<{
    ruleName: string
    message: string
    line: number
    column: number
    endLine?: number
    endColumn?: number
  }>
  errorCount: number
  fixCount: number
}

Instead of just having the type, it would be nice to show an actual example of what a LyntResult object might look like.

Guida contributor

Direzione di ricerca
Individua la sezione della documentazione API nel README e sostituisci l'esempio di solo tipo con un oggetto JSON concreto che contenga dati di esempio per tutti i campi.
Tech stack
typescript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85