@ygkn/textlint-rule-preset-ygkn

@ygkn's textlint preset rule.

Install

Install with npm:

npm install @ygkn/textlint-rule-preset-ygkn

Rules

This preset based on some presets and rules as follows.

See src/rules.ts for more details.

Presets

• textlint-rule-preset-ja-technical-writing
• textlint-rule-preset-ja-spacing

Rules

• @proofdict/textlint-rule-proofdict

Usage

rc file (Recommended)

JavaScript (with type checking)

/** @type {import("@textlint/config-loader").TextlintRcConfig}*/
module.exports = {
  rules: {
    "@ygkn/preset-ygkn": true,
  },
};

JSON

{
  "rules": {
    "@ygkn/preset-ygkn": true
  }
}

Via CLI

textlint --rule @ygkn/preset-ygkn 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

License

MIT © ygkn