open-index/open-npm huggingface dataset:
npm package: @rianbotha/coverage-summary
Description: Summarizes istanbul coverage report for specified folders.
Author: Rian Botha
Latest version: 2.0.0

# Coverage Summary
Summarize istanbul coverage report for specific folders


## Installation

```
npm install @rianbotha/coverage-summary -g
```

## Usage

```
coverage-report <filename> [options]
```

#### Example
```
coverage-report ./clover.xml --config ./.coverage-summary.js
```

#### Example output
```
Summary for report generated on 19/11/2019, 08:02:31
┌───────────┬─────────┬───────┬────────────┐
│ Section   │ Covered │ Lines │ Coverage % │
├───────────┼─────────┼───────┼────────────┤
│ All Files │    8087 │ 10215 │     79.17% │
│ Account   │     148 │   174 │     85.06% │
│ Checkout  │     465 │   869 │     53.51% │
└───────────┴─────────┴───────┴────────────┘
```

### Filename

Path to a clover.xml report generated by Istanbul

### Options

#### Config
Path to a config file. If no config file is supplied, you will only get a summary for All Files.

It should be in the following format:

```
module.exports = {
  bundles: [
    {
      path: ['src/bundles/account', 'src/bundles/other],
      name: 'Account',
    },
    {
      path: ['src/bundles/checkout'],
      name: 'Checkout',
    },
  ],
  threshold: [50, 75],
};
```

Each bundle should contain a `path`. This is an array of starting paths for parts of the report to summarize together.
`src/sample` will combine coverage numbers for `src/sample` and any sub-directories eg. `src/sample/component`

`name` is optional and will be used in the summary table. The first entry in `path` will be used if name is not defined.

`threshold` is used to colour code percentage values.
Anything below the first number will be red.
Below the second number will be yellow.
And above the second number will be green.
The default value is `[50, 75]`.

### Limitations

Coverage can only be tracked at folder level. You can't summarize based on individual files.
npm package: @rianbotha/js-doc-md
Description: A markdown readme generator for Javascript.
Author: Rian Botha
Latest version: 2.0.1

# js-doc-md

[![npm version](https://img.shields.io/npm/v/%40rianbotha%2Fjs-doc-md.svg?style=flat)](https://www.npmjs.com/package/%40rianbotha%2Fjs-doc-md)
[![Known Vulnerabilities](https://snyk.io/test/github/rianbotha/js-doc-md/badge.svg?targetFile=package.json)](https://snyk.io/test/github/rianbotha/js-doc-md?targetFile=package.json)

Generate readme.md files for Javascript using [jsdoc-to-markdown][].

[jsdoc-to-markdown]: https://github.com/jsdoc2md/jsdoc-to-markdown

## Installation
```
npm i -g @rianbotha/js-doc-md
```

## Usage
Run the following command in the terminal to replace or create a `readme.md` in the same directory.
```
js-doc-md path/to/index.js path
```
The first argument is the path to the file containing your Javascript or a glob. It can be a comma separated list.

> Note: Globs needs to be wrapped in quotes.

The second argument is the base path from which the import path will be calculated.

If the file is named index.js the readme.md will be name readme.md. Otherwise the readme will be name filename.md to match your file.

Existing documentation needs to be wrapped between `<!-- js-doc-md-start -->` and `<!-- js-doc-md-end -->` for the replacement to work. Only content between these comments will be replaced. This allows you to manually extend readmes without worrying about it being overwritten in future.

### Options

* `--ignore` A filename or glob to exclude. You can comma separate a list. Make sure to wrap globs in quotes.
* `--to-console` will write the props table to the terminal instead of the file.
* `--force` Overwrite the current readme if it exists and start and end comments are missing.
* `--help` or `-h` display usage options
* `--version` or `-v` display version information
npm package: @rianbotha/react-doc-md
Description: A markdown readme generator for React components.
Author: Rian Botha
Latest version: 1.4.0

# react-doc-md

[![npm version](https://img.shields.io/npm/v/%40rianbotha%2Freact-doc-md.svg?style=flat)](https://www.npmjs.com/package/%40rianbotha%2Freact-doc-md)
[![Known Vulnerabilities](https://snyk.io/test/github/rianbotha/react-doc-md/badge.svg?targetFile=package.json)](https://snyk.io/test/github/rianbotha/react-doc-md?targetFile=package.json)

Generate readme.md files for React components using [react-docgen][].

[react-docgen]: https://github.com/reactjs/react-docgen

## Installation
```
npm i -g @rianbotha/react-doc-md
```

## Usage
Run the following command in the terminal to replace or create a `readme.md` in the same directory.
```
doc-md path/to/index.js path
```
The first argument is the path to the file containing your React component(s) or a glob. It can be a comma separated list.

> Note: Globs needs to be wrapped in quotes.

The second argument is the base path from which the import path will be calculated.

If the file is named index.js the readme.md will be name readme.md. Otherwise the readme will be name filename.md to match your file.

The documentation needs to be wrapped between `<!-- doc-md-start -->` and `<!-- doc-md-end -->` for the replacement to work.

### Options

* `--ignore` A filename or glob to exclude. You can comma separate a list. Make sure to wrap globs in quotes.
* `--to-console` will write the props table to the terminal instead of the file.
* `--force` Overwrite the current readme if it exists and start and end comments are missing.
* `--help` or `-h` display usage options
* `--version` or `-v` display version information
npm package: @rianbotha/react-props-md-table
Description: A markdown table generator for React component props.
Author: Rian Botha
Latest version: 3.0.5
Deprecated: Replaced by @rianbotha/react-doc-md, which generates a full readme instead of just the props-table

# react-props-md-table
This tiny tool uses [react-docgen][] to generate markdown tables of the props of a React component.

[react-docgen]: https://github.com/reactjs/react-docgen

## Installation
```
npm i -g @rianbotha/react-props-md-table
```

## Usage
Run the following command in the terminal to replace the props table in `readme.md` in the same directory.
```
props-table path/to/SomeComponent.js
```

The props table in the file needs to be wrapped between `<!-- props-table-start -->` and `<!-- props-table-end -->` for the replacement to work.

### Options

* `--to-console` will write the props table to the terminal instead of the file.
* `--force` will write the props table at the end of the readme if no table wrapped by comments is found. The readme.md will be created if it doesn't exist.
* `--help` or `-h` display usage options
* `--version` or `-v` display version information