Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ntnyq/eslint-plugin-ntnyq
:package: Do not use this plugin unless you know exactly every rule may change.
https://github.com/ntnyq/eslint-plugin-ntnyq
eslint eslint-plugin lint linting
Last synced: 8 days ago
JSON representation
:package: Do not use this plugin unless you know exactly every rule may change.
- Host: GitHub
- URL: https://github.com/ntnyq/eslint-plugin-ntnyq
- Owner: ntnyq
- License: mit
- Created: 2023-03-25T23:52:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-08T11:30:29.000Z (9 days ago)
- Last Synced: 2024-11-08T12:29:07.671Z (9 days ago)
- Topics: eslint, eslint-plugin, lint, linting
- Language: TypeScript
- Homepage: https://eslint-plugin.ntnyq.com
- Size: 1.03 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-ntnyq
[](https://github.com/ntnyq/eslint-plugin-ntnyq/actions)
[](https://www.npmjs.com/package/eslint-plugin-ntnyq)
[](https://www.npmjs.com/package/eslint-plugin-ntnyq)
[](https://coveralls.io/github/ntnyq/eslint-plugin-ntnyq?branch=main)
[](https://github.com/ntnyq/eslint-plugin-ntnyq/blob/main/LICENSE)
> Do not use this plugin unless you know exactly every rule may change.
## ⚠️ Caveat
Do check the output to ensure it's doing its job correctly and only run this on code that has been checked into source control.
## Install
**npm**:
```bash
npm i eslint-plugin-ntnyq -D
```
**yarn**
```bash
yarn add eslint-plugin-ntnyq -D
```
**pnpm**
```bash
pnpm add eslint-plugin-ntnyq -D
```
## Usage
Config in `eslint.config.mjs`
```js
import pluginNtnyq from 'eslint-plugin-ntnyq'
export default [
...pluginNtnyq.configs.recommended,
// Or
// ...pluginNtnyq.configs.all,
]
```
### The recommended preset
The `recommended` config enables a subset of [the rules](#rules) that should be most useful to most users.
_See [src/configs/recommended.ts](https://github.com/ntnyq/eslint-plugin-ntnyq/blob/main/src/configs/recommended.ts) for more details._
### The all preset
The `all` config enables all the [the rules](#rules).
_See [src/configs/all.ts](https://github.com/ntnyq/eslint-plugin-ntnyq/blob/main/src/configs/all.ts) for more details._
### Advanced Configuration
Override/add specific rules configurations.
_See also: [http://eslint.org/docs/user-guide/configuring](http://eslint.org/docs/user-guide/configuring)_.
```js
import pluginNtnyq from 'eslint-plugin-ntnyq'
export default [
{
files: ['**/*.ts'],
plugins: {
ntnyq: pluginNtnyq,
},
rules: {
'ntnyq/no-member-accessibility': 'error',
},
},
]
```
## Rules
💼 Configurations enabled in.\
🌐 Set in the `all` preset.\
✅ Set in the `recommended` preset.\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
| Name | Description | 💼 | 🔧 | 💡 |
| :-------------------------------------------------------------------------------------------- | :------------------------------------------------ | :-: | :-: | :-: |
| [no-member-accessibility](https://eslint-plugin.ntnyq.com/rules/no-member-accessibility.html) | disallow usage of typescript member accessibility | 🌐 | 🔧 | |
## License
[MIT](./LICENSE) License © 2023-PRESENT [ntnyq](https://github.com/ntnyq)