saadq/lynt

Improve LyntResult example

Open

#7 aberto em 17 de mai. de 2018

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (6 forks)github user discovery
docsgood first issue

Métricas do repositório

Stars
 (383 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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.

Guia do colaborador

Direção de pesquisa
Localize a seção de documentação da API no README e substitua o exemplo apenas de tipo por um objeto JSON real contendo dados de exemplo para todos os campos.
Pilha de tecnologia
typescript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85