https://github.com/dakdevs/eslint-plugin-dak
https://github.com/dakdevs/eslint-plugin-dak
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dakdevs/eslint-plugin-dak
- Owner: dakdevs
- License: mit
- Created: 2024-06-11T05:39:54.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-11T05:50:53.000Z (11 months ago)
- Last Synced: 2025-02-15T05:25:05.230Z (3 months ago)
- Language: TypeScript
- Size: 398 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**forked from [mysticatea/template-eslint-plugin](https://github.com/mysticatea/template-eslint-plugin)**
---
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.
- `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](https://jestjs.io/) and [GitHub Actions](https://github.co.jp/features/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](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.
- `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](https://docs.npmjs.com/cli/version).
- `npm run add-rule ` creates three files to add a new rule.