saadq/lynt

Improve LyntResult example

Open

#7 opened on May 17, 2018

View on 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)

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.

Contributor guide

Research direction
Locate the API documentation section in the README, and replace the type only example with a concrete JSON object containing sample data for all fields.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85