<commit_before># technical-word-rules [![Build Status](https://travis-ci.org/azu/technical-word-rules.svg?branch=master)](https://travis-ci.org/azu/technical-word-rules)

[WEB+DB PRESS用語統一ルール](https://gist.github.com/inao/f55e8232e150aee918b9 " WEB+DB PRESS用語統一ルール secret")をベースに、
JavaScript関係や[JSer.info](http://jser.info)で使用する技術用語などの表記揺れ補正辞書とコンパイル済みJSONです。

- [azu/codemirror-spellckecker](https://github.com/azu/codemirror-spellckecker "azu/codemirror-spellckecker")

などと一緒に使うことを目的にしています。

[textlint](https://github.com/azu/textlint)から使う場合は以下のルールを使うことで利用できます。

- [azu/textlint-rule-spellcheck-tech-word](https://github.com/azu/textlint-rule-spellcheck-tech-word "azu/textlint-rule-spellcheck-tech-word")

## 辞書の書式

[prh](https://github.com/vvakame/prh "vvakame/prh")のyml形式でルールを記述します。

```yml
rules:
# expectedのみだと 大文字小文字全角半角の統一 されてるかをチェックできる
  - expected: jQuery
    specs:
      - from: jquery
        to:   jQuery
      - from: ＪＱＵＥＲＹ
        to:   jQuery
# patternにマッチするものはexpecetedが本来の表現であるというルール
# ディフォルト => デフォルト
# 表現の統一を図る
  - expected: デフォルト
    pattern:  ディフォルト
# 正規表現も使える
# 正規表現リテラルはymlの拡張であるがJavaScriptの正規表現と同じ
  - expected: $1ソフトウェア
    pattern:  /([^経])ソフトウエア/
    specs:
      # 普通に変換
      - from: 広義のソフトウエア
        to:   広義のソフトウェア
      # 日経ソフトウエア(書名)は変換しない
      - from: 日経ソフトウエア
        to:   日経ソフトウエア
```

詳しくは以下を参照します。

- [prh/sample.yml at master · vvakame/prh](https://github.com/vvakame/prh/blob/master/misc/sample.yml "prh/sample.yml at master · vvakame/prh")

## API

以下のURLから全ての辞書を結合したJSONファイルを取得出来ます

- http://azu.github.io/technical-word-rules/all.json

## Installation

```
npm install technical-word-rules
```


```js
var json = require("technical-word-rules");
// -> all.jsonが取得できる
```

## Usage

以下の記事で解説しています。

- [textlintで日本語の文章をチェックする | Web Scratch](http://efcl.info/2015/09/10/introduce-textlint/ "textlintで日本語の文章をチェックする | Web Scratch")
- [textlint + prhで表記ゆれを検出する | Web Scratch](http://efcl.info/2015/09/14/textlint-rule-prh/ "textlint + prhで表記ゆれを検出する | Web Scratch")

## Testing


    npm test

既存のルールでパス済みのJSer.infoの記事に対してテストが実行されます。
記事がおかしい場合は[test/fixtures](test/fixtures)も併せて修正します。<commit_msg>Revert "chore(readme): recommend npm install"<commit_after># technical-word-rules [![Build Status](https://travis-ci.org/azu/technical-word-rules.svg?branch=master)](https://travis-ci.org/azu/technical-word-rules)

[WEB+DB PRESS用語統一ルール](https://gist.github.com/inao/f55e8232e150aee918b9 " WEB+DB PRESS用語統一ルール secret")をベースに、
JavaScript関係や[JSer.info](http://jser.info)で使用する技術用語などの表記揺れ補正辞書とコンパイル済みJSONです。

- [azu/codemirror-spellckecker](https://github.com/azu/codemirror-spellckecker "azu/codemirror-spellckecker")

などと一緒に使うことを目的にしています。

[textlint](https://github.com/azu/textlint)から使う場合は以下のルールを使うことで利用できます。

- [azu/textlint-rule-spellcheck-tech-word](https://github.com/azu/textlint-rule-spellcheck-tech-word "azu/textlint-rule-spellcheck-tech-word")

## 辞書の書式

[prh](https://github.com/vvakame/prh "vvakame/prh")のyml形式でルールを記述します。

```yml
rules:
# expectedのみだと 大文字小文字全角半角の統一 されてるかをチェックできる
  - expected: jQuery
    specs:
      - from: jquery
        to:   jQuery
      - from: ＪＱＵＥＲＹ
        to:   jQuery
# patternにマッチするものはexpecetedが本来の表現であるというルール
# ディフォルト => デフォルト
# 表現の統一を図る
  - expected: デフォルト
    pattern:  ディフォルト
# 正規表現も使える
# 正規表現リテラルはymlの拡張であるがJavaScriptの正規表現と同じ
  - expected: $1ソフトウェア
    pattern:  /([^経])ソフトウエア/
    specs:
      # 普通に変換
      - from: 広義のソフトウエア
        to:   広義のソフトウェア
      # 日経ソフトウエア(書名)は変換しない
      - from: 日経ソフトウエア
        to:   日経ソフトウエア
```

詳しくは以下を参照します。

- [prh/sample.yml at master · vvakame/prh](https://github.com/vvakame/prh/blob/master/misc/sample.yml "prh/sample.yml at master · vvakame/prh")

## API

以下のURLから全ての辞書を結合したJSONファイルを取得出来ます

- http://azu.github.io/technical-word-rules/all.json

## Installation

```
npm install azu/technical-word-rules
```


```js
var json = require("technical-word-rules");
// -> all.jsonが取得できる
```

## Usage

以下の記事で解説しています。

- [textlintで日本語の文章をチェックする | Web Scratch](http://efcl.info/2015/09/10/introduce-textlint/ "textlintで日本語の文章をチェックする | Web Scratch")
- [textlint + prhで表記ゆれを検出する | Web Scratch](http://efcl.info/2015/09/14/textlint-rule-prh/ "textlint + prhで表記ゆれを検出する | Web Scratch")

## Testing


    npm test

既存のルールでパス済みのJSer.infoの記事に対してテストが実行されます。
記事がおかしい場合は[test/fixtures](test/fixtures)も併せて修正します。
{'fraction_non_alphanumeric': 0.1443155452436195, 'fraction_numerical': 0.013921113689095127, 'mean_word_length': 4.206521739130435, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4566843', 'n_tokens_mistral': 2457, 'n_tokens_neox': 2300, 'n_words': 211}