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.
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.
Explicit TypeScript return types must use named object types, such as (): Result rather than (): { value: string }. This also applies to objects inside promises, arrays, and unions. Inline parameter types and inferred return types are allowed.
Install
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
lintroll
Apply auto fix
lintroll --fix
Lint with caching enabled
lintroll --cache
Lint only staged files
lintroll --staged
Lint only git tracked files
lintroll --git
Specify Node.js files
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.
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
lintrollby @privatenumber (Hiroki Osame)Usage: lintroll [flags...] <files...>Flags: --cache Only check changed files --cache-location <string> Path to the cache file or directory --fix Automatically fix problems --git Only lint git tracked files within the files passed in -h, --help Show help --ignore-pattern <string> Pattern of files to ignore --node <string> 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 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:
export { default } from 'lintroll'
CommonJS:
module.exports = require('lintroll')
Extended config
In eslint.config.js:
Module:
// @ts-checkimport { 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:
// @ts-checkconst { 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 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.
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.