Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javanile/lcov.sh
🔮 LCOV framework for Shell projects
https://github.com/javanile/lcov.sh
bash bash-coverage bash-testing continuous-integration coverage coverage-testing lcov testing
Last synced: 18 days ago
JSON representation
🔮 LCOV framework for Shell projects
- Host: GitHub
- URL: https://github.com/javanile/lcov.sh
- Owner: javanile
- License: mit
- Created: 2019-12-09T15:12:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T11:58:35.000Z (about 1 year ago)
- Last Synced: 2024-03-03T02:03:06.756Z (8 months ago)
- Topics: bash, bash-coverage, bash-testing, continuous-integration, coverage, coverage-testing, lcov, testing
- Language: Shell
- Homepage: https://lcov.sh
- Size: 235 KB
- Stars: 18
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# LCOV.SH
> LCOV framework for Shell projects
[](https://travis-ci.org/javanile/lcov.sh)
[](https://codecov.io/gh/javanile/lcov.sh)
[](https://www.codacy.com/manual/francescobianco/lcov.sh?utm_source=github.com&utm_medium=referral&utm_content=javanile/lcov.sh&utm_campaign=Badge_Grade)
## Requirements
- BASH 4.* or greater
- LCOV package ([Ubuntu](http://manpages.ubuntu.com/manpages/focal/man1/lcov.1.html))
## Installation
Download `lcov.sh` file into your local machine
```bash
curl -sL https://git.io/lcov.sh
```
Install `lcov` package into your system
```bash
apt install lcov
```
Check if it working
```bash
bash lcov.sh -v
```
### Usage
Add the following code `[[ -z "${LCOV_DEBUG}" ]] || set -x`
on top of source file you want in a coverage report, see below example:
```bash
#!/bin/bash
[[ -z "${LCOV_DEBUG}" ]] || set -x
welcome () {
echo "Hi $1, I'm testable code"
}
welcome "John"
```
Now, run from command line the following command:
```bash
lcov.sh FILE...
```
### Suggestion
Use this link to post any soggestion
### Testing
> Work in progress
### Short url
```bash
curl -i "https://git.io" \
-d "url=https://raw.githubusercontent.com/javanile/lcov.sh/master/lcov.sh" \
-d "code=lcov.sh"
```
### Install `lcov` package
Debian/Ubuntu
```bash
apt install lcov
```
Mac OSX
```bash
brew install lcov
```
### See Also
-
### Changelog
Please see [CHANGELOG](docs/CHANGELOG.md) for more information on what has changed recently.
### Testing
```bash
make install && make test
```
### Contributing
Please see [CONTRIBUTING](docs/CONTRIBUTING.md) for details.
### Campaigns
We highly appreciate if you create a social post on facebook or twitter with following hashtag:
- [#Javanile](#javanile)
- [#LCOVSH](#lcovsh)
- [#LCOV](#lcovsh)
- [#DEVCommunity](#DEVCommunity)
### Credits
- [Francesco Bianco](https://github.com/francescobianco)
- [All Contributors](../../contributors)
### Support us
Javanile is a community project agency based in Sicily, Italy.
You'll find an overview of all our projects [on our website](https://www.javanile.org).
Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/javanile).
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
### License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.