Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seantrane/nyc-config
:chart_with_upwards_trend: A monorepo for extendable istanbuljs/nyc configurations
https://github.com/seantrane/nyc-config
coverage extendable-istanbuljs nyc-configurations
Last synced: 5 days ago
JSON representation
:chart_with_upwards_trend: A monorepo for extendable istanbuljs/nyc configurations
- Host: GitHub
- URL: https://github.com/seantrane/nyc-config
- Owner: seantrane
- License: isc
- Created: 2018-11-17T13:29:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-26T13:21:08.000Z (over 3 years ago)
- Last Synced: 2024-11-07T08:44:40.402Z (8 days ago)
- Topics: coverage, extendable-istanbuljs, nyc-configurations
- Language: JavaScript
- Homepage:
- Size: 1.48 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# `@seantrane/nyc-config-...`
> A monorepo for [extendable istanbuljs/nyc configurations](https://github.com/istanbuljs/nyc#publish-and-reuse-your-nyc-configuration).
---
[](https://travis-ci.com/seantrane/nyc-config) [](http://commitizen.github.io/cz-cli/) [](https://lernajs.io/) [](https://github.com/semantic-release/semantic-release)
## Table of Contents
- [About the Repository](#about)
- [Install](#install)
- [Usage](#usage)
- [Support](#support)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
---
This repo was created to manage shared and extendable `nyc` configurations. [`nyc`](https://github.com/istanbuljs/nyc) allows you to [inherit other configurations](https://github.com/istanbuljs/nyc#publish-and-reuse-your-nyc-configuration) using the key `extends`, where the packages managed in this repo can be used.
All default configurations require at least 85% code coverage, with watermarks at 80% and 90%. Select a configuration based on your requirements. The installation and configuration process is the same, just change the name of the configuration. _[Learn more about `nyc` configuration](https://github.com/istanbuljs/nyc#configuring-nyc)._
### Packages:
- [`@seantrane/nyc-config-typescript`](https://github.com/seantrane/nyc-config/tree/master/packages/nyc-config-typescript#readme) _(85% coverage)_
- [`@seantrane/nyc-config-typescript-90`](https://github.com/seantrane/nyc-config/tree/master/packages/nyc-config-typescript-90#readme) _(90% coverage)_
- [`@seantrane/nyc-config-typescript-80`](https://github.com/seantrane/nyc-config/tree/master/packages/nyc-config-typescript-80#readme) _(80% coverage)_
- [`@seantrane/nyc-config-typescript-70`](https://github.com/seantrane/nyc-config/tree/master/packages/nyc-config-typescript-70#readme) _(70% coverage)_
- [`@seantrane/nyc-config-typescript-60`](https://github.com/seantrane/nyc-config/tree/master/packages/nyc-config-typescript-60#readme) _(60% coverage)_
```sh
npm install -D @seantrane/nyc-config-typescript
```
Use the `"extends": "@seantrane/nyc-config-typescript"` property in your `nyc` config, then add any additional configuration as required.
### Using `package.json` file:
```json
{
"nyc": {
"extends": "@seantrane/nyc-config-typescript"
}
}
```
### Using `.nycrc` file:
```json
{
"extends": "@seantrane/nyc-config-typescript"
}
```
---
Submit an [issue](https://github.com/seantrane/nyc-config/issues/new), in which you should provide as much detail as necessary for your issue.
Contributions are always appreciated. Read [CONTRIBUTING.md](https://github.com/seantrane/nyc-config/blob/master/CONTRIBUTING.md) documentation to learn more.
Release details are documented in the CHANGELOG.md file of each package, and on the [GitHub Releases page](https://github.com/seantrane/nyc-config/releases).
---
[ISC License](https://github.com/seantrane/nyc-config/blob/master/LICENSE)
Copyright (c) 2018 [Sean Trane Sciarrone](https://github.com/seantrane)