saadq/lynt

Improve LyntResult example

Open

#7 opened on 2018年5月17日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)TypeScript (6 forks)github user discovery
docsgood first issue

Repository metrics

Stars
 (383 stars)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド