https://github.com/privatenumber/lintroll
🤖 privatenumber's code linter
https://github.com/privatenumber/lintroll
config eslint flat-config javascript minimal react typescript vue
Last synced: 7 months ago
JSON representation
🤖 privatenumber's code linter
- Host: GitHub
- URL: https://github.com/privatenumber/lintroll
- Owner: privatenumber
- License: mit
- Created: 2020-12-26T08:01:19.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-02-08T04:34:34.000Z (8 months ago)
- Last Synced: 2025-03-10T21:39:21.601Z (7 months ago)
- Topics: config, eslint, flat-config, javascript, minimal, react, typescript, vue
- Language: TypeScript
- Homepage:
- Size: 4 MB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
lintroll
An opinionated JavaScript, TypeScript, Vue.js, React, etc. linter.
Powered by ESLint that's enhanced with 12 plugins, covering a wide scope including TypeScript, React, Vue.js, JSON & YAML, and even Markdown code blocks.
### Features
- **Streamlined syntax**: Single quotes, semicolons, tabs, and [arrow functions](./src/custom-rules/prefer-arrow-functions/) for a clear & intentional coding style.
- **Versatile language support**: Lints TypeScript, Vue.js, React, JSON & YAML, and even Markdown code blocks ensuring a wide scope of code.
- **CLI command** Comes with a quick and easy-to-use CLI command, which even supports `eslint.config.ts`.
- **ESLint config**: Also exports an ESLint config so you can itegrate it into your own config!
### What does the linted code look like?
Checkout the code fixtures from the passing tests [here](https://github.com/search?q=repo%3Aprivatenumber%2Feslint-config+path%3Atests%2F**%2Ffixtures%2Fpass*&type=code).
## Install
```sh
npm i -D lintroll
```
## Using as a CLI command
The `lintroll` command can be used as drop-in replacement for `eslint`, allowing you to lint your code with this config without any extra configuration.
#### Lint files in the current directory
```sh
lintroll .
```
#### Apply auto fix
```sh
lintroll . --fix
```
#### Lint with caching enabled
```sh
lintroll --cache .
```
#### Lint only staged files
```sh
lintroll --staged .
```
#### Specify Node.js files
```sh
lintroll --node=./build .
```
### Optional `package.json` script
Adding it to `package.json#scripts` allows you to simply run `npm run lint` (or `pnpm lint`) without needing to pass in the current directory (`.`) every time.
This also follows the best practice of documenting available commands in a central place.
```diff
"scripts": {
+ "lint": "lintroll .",
"build": "..."
"dev": "..."
}
```
### Configuration
If you'd like to customize the linting rules further, you can add one of these ESLint config files to your project root and `lint` will detect them automatically:
- `eslint.config.ts`: The typed version of the configuration file, ideal if you are working with TypeScript.
- `eslint.config.js`: A standard JavaScript file for ESLint configuration, suitable for projects not using TypeScript.
> [!NOTE]
> When creating your own ESLint config file, you must manually add the `pvtnbr` config. Read the section below to learn how.
### `--help`
```plaintext
lintroll
by @privatenumber (Hiroki Osame)
Usage:
lintroll [flags...]
Flags:
--cache Only check changed files
--cache-location Path to the cache file or directory
--fix Automatically fix problems
-h, --help Show help
--ignore-pattern Pattern of files to ignore
--node Enable Node.js rules. Pass in a glob to specify files
--quiet Report errors only
--staged Only lint staged files within the files passed in
```
## Using as an ESLint config
To use the `eslint` command, create a [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new) file `eslint.config.js` at your project root.
> [!TIP]
> If you'd like to use TypeScript for your config file (`eslint.config.ts`), use the `lint` command from the previous section. The `eslint` command only supports `eslint.config.js`.
### Simple config
If you want a simple setup with no customization, create the following `eslint.config.js`:
Module:
```js
export { default } from 'lintroll'
```
CommonJS:
```js
module.exports = require('lintroll')
```
### Extended config
In `eslint.config.js`:
Module:
```js
// @ts-check
import { defineConfig, pvtnbr } from 'lintroll'
export default defineConfig([
{
// Don't lint these files
ignores: [
'tests/fixtures/**/*'
]
},
// Configure the pvtnbr config
...pvtnbr({
// Indicate Node.js project
node: true,
// Indicate Vue.js project (auto-detected by default)
vue: true
})
// Other configs...
])
```
CommonJS:
```js
// @ts-check
const { defineConfig, pvtnbr } = require('lintroll')
module.exports = defineConfig([
{
// Don't lint these files
ignores: [
'tests/fixtures/**/*'
]
},
// Configure the pvtnbr config
...pvtnbr({
// Indicate Node.js project or pass in file paths
node: true
})
// Other configs...
])
```
> [!TIP]
> If you'd like to type check your `eslint.config.js` file, you can add [`// @ts-check`](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check) to the top.
## Linting coverage
This ESLint config comprehensively supports a variety of languages and file types, ensuring coding standards and best practices across your project.
| Language/File Type | Extensions |
| ------------------ | -------------------- |
| JavaScript | `.js`, `.cjs`, `.mjs` |
| Node.js | `.cjs`, `.mjs` |
| Service Workers | `.sw.js`, `.sw.ts` |
| TypeScript | `.ts`, `.cts`, `.mts`, `.d.ts` |
| Vue.js | `.vue` |
| React | `.jsx`, `.tsx` |
| JSON | `.json`, `.json5`, `.jsonc` |
| YML | `.yml`, `.yaml` |
| Markdown | `.md` |
### Integrated plugins
Each plugin in this ESLint configuration targets specific aspects of your code, ensuring quality and consistency.
| Plugin | Focus area |
| ------ | ---------- |
| [eslint-comments](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments) | ESLint directive comments |
| [node](https://www.npmjs.com/package/eslint-plugin-node) | Node.js coding practices |
| [@typescript-eslint](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) | TypeScript coding Practices |
| [@stylistic](https://www.npmjs.com/package/@stylistic/eslint-plugin) | JavaScript & TypeScript code style |
| [promise](https://www.npmjs.com/package/eslint-plugin-promise) | Promises best practices |
| [regexp](https://www.npmjs.com/package/eslint-plugin-regexp) | Regular Expressions best practices |
| [import](https://www.npmjs.com/package/eslint-plugin-import) | ES6+ Import/Export |
| [jsonc](https://www.npmjs.com/package/eslint-plugin-jsonc) | JSON, JSON5, and JSONC style |
| [yml](https://www.npmjs.com/package/eslint-plugin-yml) | YAML style |
| [vue](https://www.npmjs.com/package/eslint-plugin-vue) | Vue.js Templates & Scripts |
| [react](https://www.npmjs.com/package/eslint-plugin-react) | React best practices |
| [markdown](https://www.npmjs.com/package/eslint-plugin-markdown) | Markdown embedded code blocks |
| [no-use-extend-native](https://www.npmjs.com/package/eslint-plugin-no-use-extend-native) | Native prototype extensions |
| [unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) | Miscellaneous code quality rules |
| [Custom](https://github.com/privatenumber/eslint-config/tree/develop/src/custom-rules) | Custom rules made for this config |
## API
### pvtbr(options)
The main config factory. It takes an object of options and returns a config object.
#### options.node
Type: `boolean | string[]`
Default: `false`
Whether to lint Node.js code. When `true`, it will treat all files as Node.js files. You can also pass in an array of glob patterns to specify which files are Node.js files.
### defineConfig(configs)
An identity function to enforce type checking on the config.
#### configs
Type: `FlatConfig | FlatConfig[]`
## Awesome ESLint configs
Make sure you also check out these awesome ESLint configs. They are a constant source of inspiration for me, and are great alternatives to consider.
- [antfu/eslint-config](https://github.com/antfu/eslint-config) by [@antfu](https://github.com/antfu)
- [sxzz/eslint-config](https://github.com/sxzz/eslint-config) by [@sxzz](https://github.com/sxzz)
- [@ota-meshi/eslint-plugin](https://github.com/ota-meshi/eslint-plugin) by [@ota-meshi](https://github.com/ota-meshi)
- [standard config](https://github.com/standard/eslint-config-standard) by [@feross](https://github.com/feross)