line-coverage

README

line-coverage

Scans and calculates code line-coverage for Golang projects
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Built With

• Go
• Docker

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

• Download binary

  • Release page

• Install binary

  go install github.com/Liu-Chunhui/line-coverage
  

Usage

Binary

1. coverage file is required for calculating line coverage. For example, when execute make test on line-coverage, ./gen/coverage.out as the coverage file will be generated
2. go.mod with path need to be provided
3. then execute $ line-coverage -c ./gen/coverage.out -m go.mod

Docker

// TODO

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/Liu-Chunhui/line-coverage

(back to top)