textlint-filter-rule-comments

KO | EN

gitlite — search

#python #hacktoberfest #ai #go #android #rust #docker #nodejs #windows #cli #kubernetes #vue #awesome-list #open-source

textlint-filter-rule-comments

(★ 36)

textlint filter rule that disables all rules between comments directive.

textlint-filter-rule-comments Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# textlint-filter-rule-comments [![Actions Status: test](https://github.com/textlint/textlint-filter-rule-comments/workflows/test/badge.svg)](https://github.com/textlint/textlint-filter-rule-comments/actions?query=workflow%3A"test")

textlint rule that ignore error using comments directive.

## Install

Install with [npm](https://www.npmjs.com/):

npm install textlint-filter-rule-comments

Dependencies:

- [textlint](http://textlint.github.io/ "textlint") >= 6.9

## Usage

### Ignore error messages using comments

Example case in Markdown.

```markdown
This is error text.

This is ignored text by rule.
Disables all rules between comments

This is error text.
```

Ignore specified rules:

```markdown

Ignore RuleA and RuleB

Still ignore RuleB
```

**Limitation(markdown)**:

Require new-line around of `` in Markdown.
This limitation com from [remark](https://github.com/wooorm/remark "remark").

NG:

```markdown

this is wrong

```

OK:

```markdown

this is ok

```

### Settings

Via `.textlintrc`(Recommended)

```json
{
    "filters": {
        "comments": true
    }
}
```

### Options

- `enablingComment`:
    - default: `"textlint-enable"` 
    - enable comment directive
    - e.g.) ``
- `disablingComment`:
    - default: `"textlint-disable"` 
    - disable comment directive
    - e.g.) ``

```js
{
    "filters": {
        "comments": {
            // enable comment directive
            // if comment has the value, then enable textlint rule
            "enablingComment": "textlint-enable",
            // disable comment directive
            // if comment has the value, then disable textlint rule
           "disablingComment": "textlint-disable"
        }
    }
}
```

## Changelog

See [Releases page](https://github.com/textlint/textlint-filter-rule-comments/releases).

## Acknowledgement

- [Documentation - ESLint - Pluggable JavaScript linter](http://eslint.org/docs/user-guide/configuring#disabling-rules-with-inline-comments "Documentation - ESLint - Pluggable JavaScript linter")

## Running tests

Install devDependencies and Run `npm test`:

npm i -d && npm test

## Contributing

Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/textlint/textlint-filter-rule-comments/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](http://twitter.com/azu_re)

## License

textlint-filter-rule-comments

textlint-filter-rule-comments Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

textlint-filter-rule-comments

textlint-filter-rule-comments Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README