https://github.com/istanbuljs/eslint-plugin-istanbul

ESLint plugin for istanbul code coverage
https://github.com/istanbuljs/eslint-plugin-istanbul

Last synced: about 2 months ago
JSON representation

ESLint plugin for istanbul code coverage

• Host: GitHub
• URL: https://github.com/istanbuljs/eslint-plugin-istanbul
• Owner: istanbuljs
• Created: 2020-04-30T11:00:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-05T04:18:04.000Z (11 months ago)
• Last Synced: 2024-10-28T22:50:28.538Z (2 months ago)
• Language: JavaScript
• Size: 1.57 MB
• Stars: 12
• Watchers: 5
• Forks: 9
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# eslint-plugin-istanbul

[![npm version](https://badge.fury.io/js/eslint-plugin-istanbul.svg)](https://badge.fury.io/js/eslint-plugin-istanbul)

[![CI](https://github.com/istanbuljs/eslint-plugin-istanbul/workflows/CI/badge.svg)](https://github.com/istanbuljs/eslint-plugin-istanbul/actions)

A set of rules to enforce good practices for istanbuljs.

## Install

```console

$ npm install --save-dev eslint eslint-plugin-istanbul

```

## Usage

Configure it in `package.json`.

```json

{

  "name": "my-awesome-project",

  "eslintConfig": {

    "plugins": ["istanbul"],

    "rules": {

      "istanbul/no-ignore-file": "error",

      "istanbul/prefer-ignore-reason": "error"

    }

  }

}

```

## Rules

- [no-ignore-file](docs/rules/no-ignore-file.md) - Bans istanbul ignore file comment.

- [prefer-ignore-reason](docs/rules/prefer-ignore-reason.md) - Enforce specifying a reason to ignore comments.

See the [ESLint docs](https://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information about extending config files.