@markuplint/create-rule-helper

@markuplint/rule-textlint

The rule textlint for HTML, Vue and so on markup languages.

Install

$ npm install @markuplint/rule-textlint

$ yarn add @markuplint/rule-textlint

Usage

Example

$ yarn add -D textlint-rule-prh

Load .textlintrc.* config automatically

// `.markuplintrc`
{
	"rules": {
		"textlint": true
	}
}

// `.textlintrc`
{
	// `html` plugin will be used automatically by `markuplint`
	// but make sure to enable it manually
	// if you are using `textlint` as cli at the same time
	// "plugins": ["html"],
	"rules": {
		"prh": {
			"rulePaths": ["../prh.yml"]
		}
	}
}

Use independent textlint config

// `markuplint.config.js`
const path = require('path');

module.exports = {
	rules: {
		textlint: {
			option: {
				rules: [
					{
						ruleId: 'prh',
						rule: require('textlint-rule-prh'),
						options: {
							rulePaths: [path.resolve(__dirname, '../', 'prh.yml')],
						},
					},
				],
			},
		},
	},
};

Contributing

$ git clone [e-mail]:markuplint/markuplint.git -b main
$ yarn
$ yarn build
$ yarn test

---

Copyright © 2021 markuplint. Under the MIT License.