# morpheme-match-textlint

> morpheme-match for textlint rule.

Latest version **2.0.6** (published 2019-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install morpheme-match-textlint
pnpm add morpheme-match-textlint
yarn add morpheme-match-textlint
bun add morpheme-match-textlint
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.6 |
| Published | 2019-10-20 |
| First published | 2019-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 18.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | azu |
| Maintainers | azu |
| Keywords | japanese, morpheme, text, 形態素 |

## Links

- npm: https://www.npmjs.com/package/morpheme-match-textlint
- Repository: https://github.com/azu/morpheme-match
- Issues: https://github.com/azu/morpheme-match/issues
- npm.io page: https://npm.io/package/morpheme-match-textlint

## Dependencies (2)

- [morpheme-match](https://npm.io/package/morpheme-match.md) ^2.0.4
- [morpheme-match-all](https://npm.io/package/morpheme-match-all.md) ^2.0.5

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 2.0.6 (latest) — 2019-10-20
- 2.0.4 — 2019-10-20
- 2.0.3 — 2019-07-07
- 2.0.2 — 2019-07-07
- 2.0.1 — 2019-07-07
- 2.0.0 — 2019-06-14

## README

# morpheme-match-textlint

morpheme-match for textlint.

This library provide matcher function that return reportable object for textlint.

- 

## Install

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

    npm install morpheme-match-textlint

## Usage

- [ ] TBO

### Tips

### `_capture`

`_capture` is special key for replacing message and expected. 


```js
const matchToken = createTokenMatcher([
    {
        "surface_form": "かも",
        "pos": "助詞",
        "pos_detail_1": "副助詞",
        "pos_detail_2": "*",
        "pos_detail_3": "*",
        "conjugated_type": "*",
        "conjugated_form": "*",
        "basic_form": "かも",
        "reading": "カモ",
        "pronunciation": "カモ",
        "_cature": "$1"
    }
]);
```

### `_skippable`

If the token has `_skippable`, this token will be handled as optional token.


```js
const matchToken = createTokenMatcher([
    {
        "surface_form": "かも",
    },
    {
        "surface_form": "、",
        "_skippable": true,
    },
    {
        "surface_form": "しれ",
    },
]);
```


## 関連

- [azu/morpheme-match-all: A wrapper of morpheme-match API. Match all kuromoji's tokens.](https://github.com/azu/morpheme-match-all)
    - A wrapper for morpheme-match
- [textlint-ja/textlint-rule-morpheme-match: 形態素解析結果のTokenベースの辞書でマッチするtextlintルール](https://github.com/textlint-ja/textlint-rule-morpheme-match)

## Changelog

See [Releases page](https://github.com/azu/morpheme-match/releases).

## 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/azu/morpheme-match/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

MIT © azu

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