saadq/lynt

Improve LyntResult example

Open

#7 创建于 2018年5月17日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)TypeScript (6 fork)github user discovery
docsgood first issue

仓库指标

Star
 (383 star)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南