cnp-template-typescript-eslint-plugin


> A bolierplate for create eslint plugin with typescript;
>
> A bolierplate for that can be used by create-npm-package

Usage

``bash
npx create-npm-packages --template hsuehic/cnp-template-typescript-eslint-plugin
`

File Structure:

- docs/rules/ is the directory to put documentation.
- src/rules/ is the directory to put rule definitions.
- scripts/ is the directory to put development scripts.
- tests/ is the directory to put tests for src/.
- .eslintignore and .eslintrc.js are the configuration to lint this repository.

Dependencies:

This template uses Jest and GitHub Actions for tests, as same as ESLint itself. If you want to use other tools, customize it.

Development Tools:

- npm run add-rule foo command adds a rule definition.
- npm update command updates the following stuff by the meta property of rules:
- the header of docs/rules/*.md.
- lib/configs/recommended.ts file.
- lib/index.ts file.
- the rule table in README.md file.

Below is an example of README.

---

eslint-plugin-xxxx (template)

A template for ESLint plugins.

Installation

Use npm or a compatibility tool to install.

`
npm install --save-dev eslint eslint-plugin-xxxx
`

$3

- Node.js v8.10.0 or newer versions.
- ESLint v5.16.0 or newer versions.

Usage

Write your config file such as .eslintrc.yaml.

`yml
plugins:
- xxxx
rules:
xxxx/example-rule: error
`

See also Configuring ESLint.

Configs

- xxxx/recommended ... enables the recommended rules.

Rules

$3

| Rule ID | Description | |
| :------------------------------------------------ | :--------------- | :-: |
| xxxx/example-rule | An example rule. | ⭐️ |

Semantic Versioning Policy

This plugin follows Semantic Versioning and ESLint's Semantic Versioning Policy.

Changelog

- [GitHub Releases]()

Contributing

Welcome your contribution!

See also ESLint Contribution Guide.

$3

- npm test runs tests.
- npm run update updates the package version. And it updates src/configs/recommended.ts, lib/index.ts, and README.md's rule table. See also npm version CLI command.
- npm run add-rule ` creates three files to add a new rule.