Skip to content

Latest commit

 

History

History

textlint-rule-kana-english-fo-pho

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
test
test
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@textlint-ja/textlint-rule-kana-english-fo-pho

原語が「fo」または「pho」の場合は、カタカナでは「フォ」とするのを原則とするtextlintルール。

OK:

インフォ(info)
インフォメーション(information)
フォーム(form)
フォント(font)
ハイホン(hyphon)
フォロー(follow)
アイフォン(iPhone)
フォト(photo)
フォトグラファー(photology)
フォビア(phobia)
プラットホーム(platform)は例外で、プラットフォームでもいい
ホーム(homu)は例外、フォームと区別できない
テレホン(telephone)は例外
イヤホン(earphone)は例外
メガホン(megaphon)は例外

NG:

インホメーションは-fo-なのでフォを使う
パホーマンスは-fo-なのでフォを使う

Install

Install with npm:

npm install @textlint-ja/textlint-rule-kana-english-fo-pho

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "@textlint-ja/kana-english-fo-pho": true
    }
}

Via CLI

textlint --rule @textlint-ja/kana-english-fo-pho README.md

Options

{
    /**
     * 許可する単語を指定できます
     */
    allows?: string[];
    /**
     * 慣用的に例外とされる単語も不許可にするかどうか
     * デフォルト: false
     */
    disableBuiltinAllows: boolean;
}

Example:

{
    "rules": {
        "@textlint-ja/kana-english-fo-pho": {
            "allows": ["イヤフォン"],
            "disableDefaultAllows": true
        }
    }
}

References

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

yarn install && yarn test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  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

License

MIT © azu