textlint-rule-prh

textlint rule for prh/prh: proofreading helper.

This rule check the spell by used with prh.yml.

Installation

npm install textlint-rule-prh

Usage

1. It require Rule Options!

1{
2    "rules": {
3        "prh": {
4            "rulePaths" :["path/to/prh.yml"]
5        }
6    }
7}

Options

• rulePaths(required) : array of path to YAML file from .textlintrc file

1{
2    "rules": {
3        "prh": {
4            "rulePaths" :["./prh-rules/rule1.yml", "./prh-rules/rule2.yml"]
5        }
6    }
7}

You can use ~ as Home directory abbreviation.

1{
2    "rules": {
3        "prh": {
4            "rulePaths" :["~/global-rule/rule1.yml"]
5        }
6    }
7}

• checkLink(optional) : Check Link node type (default: false)
• checkBlockQuote(optional) : Check BlockQuote node type (default: false)
• checkEmphasis(optional) : Check Emphasis node type (default: false)
• checkHeader(optional) : Check Header node type (default: true)
• checkCodeComment(optional) : Check CodeBlock node's comment for lang (default: [])
  • Set lang array like ["<codeblock-lang>"] for checking CodeBlock
  • Example: If you want to check JavaScript CodeBlock, set { "checkCodeComment": ["js", "javascript"] } Options
  • Note: Currently only support JavaScript CodeBlock
    • It use @babel/parser

Examples:

1{
2    "rules": {
3        "prh": {
4            "checkEmphasis": true,
5            "checkHeader": false,
6            "rulePaths" :["./prh.yml"]
7        }
8    }
9}

Check CodeBlock's comment in JavaScript Code.

1{
2    "rules": {
3        "prh": {
4            "checkCodeComment": ["js", "javascript"],
5            "rulePaths" :["./prh.yml"]
6        }
7    }
8}

Fixable

textlint-rule-prh support --fix feature of textlint.

1textlint --fix README.md

What is prh.yml?

Please See prh/prh: proofreading helper.

prh format

prh.yml can define RegExp as a dictionary.

1# prh version
2version: 1
3rules:
4
5  # format case-sensitive
6  - expected: Cookie
7  # the above is equal to following
8  # - expected: Cookie
9  #   pattern: "/[CcＣｃ][OoＯｏ][OoＯｏ][KkＫｋ][IiＩｉ][EeＥｅ]/g"
10  #   options:
11  #     wordBoundary: false
12  #   specs: []
13
14  # Write test to `expect`
15  - expected: jQuery
16    specs:
17      - from: jquery
18        to:   jQuery
19      - from: ＪＱＵＥＲＹ
20        to:   jQuery
21
22# If the `specs` is failed、fail to load prh.yml
23# - expected: JavaScript
24#   specs:
25#     - from: JAVASCRIPT
26#       to:   JavaScprit
27# Error: JavaScript spec failed. "JAVASCRIPT", expected "JavaScprit", but got "JavaScript", /[JjＪｊ][AaＡａ][VvＶｖ][AaＡａ][SsＳｓ][CcＣｃ][RrＲｒ][IiＩｉ][PpＰｐ][TtＴｔ]/g
28
29# pattern => expected
30  - expected: default
31    pattern:  deflaut
32
33# Allow to write multiple `pattern`
34  - expected: hardware
35    patterns:
36      - hadware
37      - harrdware
38      - harddware
39
40# Allow to write `pattern` as RegExp
41# Can use $1...$9
42# Should wrap `/` and `/`
43  # ECMAScript
44  - expected: ECMAScript $1
45    patterns:
46      - /ECMAScript([0-9]+)/
47      - /ECMA Script([0-9]+)/
48    specs:
49      - from: ECMAScript2015
50        to:   ECMAScript 2015
51
52# expected contain pattern
53# https://github.com/textlint-rule/textlint-rule-prh/pull/8
54  - expected: ベンダー
55    pattern: /ベンダ(?!ー)/
56    specs:
57      - from: ベンダ
58        to: ベンダー
59      - from: ベンダー
60        to: ベンダー
61  # wordBoundary option
62  - expected: js
63  # === pattern: "/\b[JjＪｊ][SsＳｓ]\b/g"
64    options:
65      wordBoundary: true
66    specs:
67      - from: foo JS bar
68        to:   foo js bar
69      - from: foo altJS bar
70        to:   foo altJS bar

imports

prh.yml can import other yaml file

1version: 1
2
3imports:
4  - imports-a.yml
5  - imports-b.yml

Example

See example-prh.yml.

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