# @textlint-rule/textlint-rule-gramma

> textlint rule for gramma/langulagetools.

Latest version **1.0.2** (published 2021-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @textlint-rule/textlint-rule-gramma
pnpm add @textlint-rule/textlint-rule-gramma
yarn add @textlint-rule/textlint-rule-gramma
bun add @textlint-rule/textlint-rule-gramma
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-10-24 |
| First published | 2021-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | azu |
| Maintainers | azu, nodaguti, 0x6b, hata6502, textlint-user |
| Keywords | textlintrule |

## Links

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

## Dependencies (2)

- [gramma](https://npm.io/package/gramma.md) ^1.5.0
- [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
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-10-24
- 1.0.1 — 2021-10-24

## README

# @textlint-rule/textlint-rule-gramma

textlint rule for [gramma](https://github.com/caderek/gramma)/[LanguageTool](https://languagetool.org/)/[GrammarBot](https://www.grammarbot.io/).

This rule is frontend of [gramma](https://github.com/caderek/gramma).

## Install

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

    npm install @textlint-rule/textlint-rule-gramma

## Usage

Via `.textlintrc`(Recommended)

```json
{
  "rules": {
    "@textlint-rule/gramma": true
  }
}
```

Via CLI

```
textlint --rule @textlint-rule/gramma README.md
```

## Options

Same to [gramma's options](https://github.com/caderek/gramma#check-method).
It means that send your text to remote server like grammarbot.io or languagetool.org by default.

- `api_url` - url to a non-default API server
- `api_key` - server API key
- `dictionary` - an array of words that should be whitelisted
- `language` - language code to specify the text language
- `rules` - object defining which rules should be disabled

Example, use local server.

```json
{
  "rules": {
    "@textlint-rule/gramma": {
      "api_url": "http://localhost:8081/v2/check"
    }
  }
}
```

:memo: You need to start local API server by following before linting text.

```bash
npm install gramma --global
npx gramma server install
npx gramma servert start
# stop server
# npx gramma servert stop
```


## Changelog

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

## Running tests

    yarn install
    yarn bootstrap
    yarn test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/textlint-rule/textlint-rule-gramma/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](https://twitter.com/azu_re)

## License

MIT © azu

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