A collection of prh.yml
JavaScript
Latest commit 0ba05ca Jan 8, 2017 @azu 2.1.2
Permalink
Failed to load latest commit information.
.meta
ja
.gitignore
.travis.yml
README.md
css.yml
index.js
javascript.yml
other.yml
package.json
software.yml

README.md

A collection of prh.yml Build Status

A collection of dictionary for prh.

Requirement

You should install prh or textlint-rule-prh.

textlint-rule-prh with textlint >= 7.1.2

Dictionary

Usage

Add to your project

git subtree add --prefix=prh https://github.com/azu/prh.yml.git master --squash

Update exist rules

git subtree pull --prefix=prh https://github.com/azu/prh.yml.git master --squash

Setting of prh.yml

You can import these prh dictionary files from main prh.yml.

version: 1
imports:
  - prh/ja/jser-info.yml
  - prh/ja/kanji-open.yml
  - prh/ja/spoken.yml
  - prh/ja/typo.yml
  - prh/javascript.yml
  - prh/css.yml
  - prh/software.yml
rules:
  # project configuration
  - expected: Almin
    patterns: /almin.js/i

Folder structure

The files in the root directory are for *.yml file that are project specific, such as programming language or framework specific templates. Natural language file should go into the <lang>/ directory.

e.g.) ja/typo.yml define typo for japanese.

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Edit some.yml file
  2. Add expected and patterns, also add specs.
  3. Send Pull Request!

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Author

License

MIT © azu