Skip to content
This repository has been archived by the owner on May 17, 2020. It is now read-only.
/ coverage-markers Public archive

📦 Atom package to display JavaScript test coverage on gutter of editor.

License

Notifications You must be signed in to change notification settings

kentaro-m/coverage-markers

Repository files navigation

Coverage Markers

CircleCI apm apm Maintainability license

Atom package to display JavaScript test coverage on gutter of editor.

Features

  • 📺 Display the test coverage from lcov data
  • 🔍 Search for a lcov file on project directories
  • 📈 Monitor a lcov file and redisplay the test coverage everytime it changes
  • 👼 Support for the test coverage measurement tool such as istanbul and nyc

Demo

Installation

$ apm install coverage-markers

or go to settings > search for coverage-markers and install.

Note: You need to rebuild the package before using it, since this package uses a native module.

$ apm rebuild

or rebuild package from Incompatible Packages in the editor.

Usage

This package monitors lcov file (coverage/lcov.info) and displays the coverage in the editor every time the file is changed. The green marker covers the test, the red one does not cover the test.

You can select the coverage-markers:toggle command from the atom command palette and use it

or use the application menu Packages > Coverage Markers > Toggle Coverage.

Contributing

Issue

  • 🐛 Report a bug
  • 🎁 Request a feature

Please use the GitHub Issue to create a issue.

Pull Request

  1. Fork it (https://github.com/kentaro-m/coverage-markers/fork)
  2. Create your feature branch
  3. Run the test ($ npm test) and make sure it passed ✅
  4. Commit your changes 📝
  5. Push to the branch
  6. Create a new Pull Request ❤️

License

MIT