Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mysticatea/template-eslint-plugin
A repository template for ESLint plugins.
https://github.com/mysticatea/template-eslint-plugin
Last synced: about 2 months ago
JSON representation
A repository template for ESLint plugins.
- Host: GitHub
- URL: https://github.com/mysticatea/template-eslint-plugin
- Owner: mysticatea
- License: mit
- Created: 2019-06-06T20:05:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-06-10T05:49:59.000Z (over 5 years ago)
- Last Synced: 2024-05-02T06:14:42.948Z (8 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 16
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This is a trial of [GitHub Repository Template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/).
Please update `package.json` after you created new repository with this template.
**File Structure**:
- `docs/rules/` is the directory to put documentation.
- `lib/rules/` is the directory to put rule definitions.
- `scripts/` is the directory to put development scripts.
- `tests/lib/` is the directory to put tests for `lib/`.
- `.eslintignore` and `.eslintrc.js` are the configuration to lint this repository.
**Dependencies**:
This template uses [mocha](https://www.npmjs.com/package/mocha), [nyc](https://www.npmjs.com/package/nyc), and [Travis CI](https://travis-ci.com/) 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 version` command updates the following stuff by the `meta` property of rules:
- the header of `docs/rules/*.md`.
- `lib/configs/recommended.js` file.
- `lib/index.js` 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](https://www.npmjs.com/) or a compatibility tool to install.
```
$ npm install --save-dev eslint eslint-plugin-xxxx
```
### Requirements
- Node.js v8.10.0 or newer versions.
- ESLint v5.16.0 or newer versions.
## Usage
Write your config file such as `.eslintrc.yml`.
```yml
plugins:
- xxxx
rules:
xxxx/example-rule: error
```
See also [Configuring ESLint](https://eslint.org/docs/user-guide/configuring).
## Configs
- `xxxx/recommended` ... enables the recommended rules.
## Rules
### Stylistic Issues
| Rule ID | Description | |
|:--------|:------------|:--:|
| [xxxx/example-rule](./docs/rules/example-rule.md) | An example rule. | ⭐️ |
## Semantic Versioning Policy
This plugin follows [Semantic Versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
## Changelog
- [GitHub Releases]()
## Contributing
Welcome your contribution!
See also [ESLint Contribution Guide](https://eslint.org/docs/developer-guide/contributing/).
### Development Tools
- `npm test` runs tests and measures coverage.
- `npm version ` updates the package version. And it updates `lib/configs/recommended.js`, `lib/index.js`, and `README.md`'s rule table. See also [npm version CLI command](https://docs.npmjs.com/cli/version).
- `npm run add-rule ` creates three files to add a new rule.