# textlint-rule-rousseau

> textlint rule check english sentence using rousseau

Latest version **1.4.8** (published 2022-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install textlint-rule-rousseau
pnpm add textlint-rule-rousseau
yarn add textlint-rule-rousseau
bun add textlint-rule-rousseau
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.8 |
| Published | 2022-09-10 |
| First published | 2016-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 22 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | azu |
| Maintainers | azu |
| Keywords | textlint, english, proofreader, spellcheck |

## Links

- npm: https://www.npmjs.com/package/textlint-rule-rousseau
- Repository: https://github.com/textlint-rule/textlint-rule-rousseau
- Issues: https://github.com/textlint-rule/textlint-rule-rousseau/issues
- npm.io page: https://npm.io/package/textlint-rule-rousseau

## Dependencies (4)

- [unist-util-map](https://npm.io/package/unist-util-map.md) ^1.0.2
- [textlint-rule-helper](https://npm.io/package/textlint-rule-helper.md) ^2.2.1
- [@textlint-rule/rousseau](https://npm.io/package/@textlint-rule/rousseau.md) ^2.0.2
- [textlint-util-to-string](https://npm.io/package/textlint-util-to-string.md) ^3.1.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.4.8 (latest) — 2022-09-10
- 1.4.7 — 2022-05-03
- 1.4.6 — 2019-07-20
- 1.4.5 — 2016-06-18
- 1.4.4 — 2016-06-15
- 1.4.3 — 2016-06-15
- 1.4.2 — 2016-06-14
- 1.4.1 — 2016-03-19
- 1.4.0 — 2016-03-19
- 1.3.2 — 2016-02-14
- 1.3.1 — 2016-02-14
- 1.3.0 — 2016-02-14
- 1.2.0 — 2016-02-14
- 1.1.0 — 2016-02-14
- 1.0.1 — 2016-02-14

## README

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

A [textlint](https://github.com/textlint/textlint "textlint") rule check english sentence using [rousseau](https://github.com/GitbookIO/rousseau "rousseau").

## What does checked?

See [Checks](https://github.com/GitbookIO/rousseau#checks "Checks") of rousseau.

### Example

> So the cat was stolen.

Lint results:

```
$ textlint --rule textlint-rule-rousseau README.md

textlint-rule-rousseau: omit 'So' from the beginning of sentences
/Users/textlint-rule/.ghq/github.com/textlint-rule/textlint-rule-rousseau/README.md:11:1
        v
    10.
    11. So the cat was stolen.
    12.
        ^

textlint-rule-rousseau: "was stolen" may be passive voice
Suggestions:
=> stole
/Users/textlint-rule/.ghq/github.com/textlint-rule/textlint-rule-rousseau/README.md:11:12
                   v
    10.
    11. So the cat was stolen.
    12.
                   ^
```


## Installation

    npm install textlint-rule-rousseau

## Usage

Via `.textlintrc`(Recommended)


```json
{
    "rules": {
        "rousseau": {
            "showLevels": ["suggestion", "warning", "error"]
        }
    }
}
```

Via CLI

```
textlint --rule rousseau README.md
```

## Options

### showLevels

Level of importance

- "suggestion",
- "warning"
- "error"

```json
{
    "rules": {
        "rousseau": {
            "showLevels": ["suggestion", "warning", "error"]
        }
    }
}
```

### ignoreTypes

See https://github.com/GitbookIO/rousseau#checks

```json
{
    "rules": {
        "rousseau": {
            "ignoreTypes": ["sentence:uppercase"]
        }
    }
}
```

## Tests

    npm test

## Contributing

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

## License

MIT

---
_Source: https://npm.io/package/textlint-rule-rousseau · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._