textlint formatter for codecov json.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
src
test
.babelrc
.gitignore
.textlintrc
.travis.yml
LICENSE
README.md
package.json

README.md

textlint-formatter-codecov Build Status

textlint formatter for Codecov.

What is Codecov format?

See Codecov JSON.

{
  "coverage": {
    "path/to/file.py": [null, 1, 0, null, true, 0, 0, 1, 1],
    "path/to/other.py": [null, 0, 1, 1, "1/3", null]
  },
  "messages": {
    "path/to/other.py": {
      "1": "custom message for line 1"
    }
  }
}

Installation

npm install textlint-formatter-codecov

Usage

# In Travis CI | Circle CI...
npm install codecov.io textlint textlint-formatter-codecov -D
textlint -f codecov | codecov.io

See Example and Result.

  • codecov.io
1: # Example [![codecov.io](https://codecov.io/github/azu/textlint-formatter-codecov/coverage.svg?branch=master)](https://codecov.io/github/azu/textlint-formatter-codecov?branch=master)
2: 
3(✔textlint error): - [ ] TODO 
4:
5(✔textlint error): jQuerl is not jQuery.
6: 
7: Here.
  • 5 Hit(line)
  • 2 Missed(line)

=> 1 - (2/7) = 71.42% = Text Coverage!

Similar formatter

FAQ

Which formatter is better for Code Coverage(Text Coverage)?

We recommended that use Codecov with textlint-formatter-codecov. Because, Codecov JSON support messages.

messsage

Tests

npm test

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT