textlint-rule-soracom-product-name

[!IMPORTANT] This rule is not an official rule of SORACOM.
Please read about the trademark guideline of SORACOM.

textlint rule for SORACOM product names.

This rule inspired by textlint-rule-azure-service-name.

Features

• Check SORACOM product names
  • For examples:
    • SORACOM air -> SORACOM Air
    • soracom Func -> SORACOM Funk
    • plan-01s -> plan01s

Install

Install with npm:

npm install textlint-rule-soracom-product-name

Usage

Via .textlintrc.json(Recommended)

{
    "rules": {
        "soracom-product-name": true
    }
}

Via CLI

textlint --rule soracom-product-name README.md

Build

Builds source codes for publish to the lib folder. You can write ES2015+ source codes in src/ folder.

npm run build

Tests

Run test code in test folder. Test textlint rule by textlint-tester.

npm test

You can also test each test file by running the following.

# run only test files under test/.
npm run test:lint
# or npm run testLint

License

MIT © kenichiro-kimura