@yentsun/lint

An opinionated ESLint plugin with custom style and correctness rules for JS/React projects. A couple of rules add support for codebases split into packages or multiple runtime targets, but the plugin works in any project.

Installation

npm install --save-dev @yentsun/lint eslint eslint-plugin-react eslint-plugin-react-hooks

Requires ESLint 9+ (flat config).

Usage

JS / Node projects — built-in rules + all custom rules:

// eslint.config.js
import ytLint from '@yentsun/lint';

export default [
  ytLint.configs.recommended,
];

React projects — everything above + React plugin rules:

import ytLint from '@yentsun/lint';

export default [
  ...ytLint.configs.react,
];

Or enable individual rules:

import ytLint from '@yentsun/lint';

export default [
  {
    plugins: { '@yentsun/lint': ytLint },
    rules: {
      '@yentsun/lint/no-unused': 'error',
      '@yentsun/lint/two-blank-lines-after-imports': 'warn',
    },
  },
];

Rules

Formatting

| Rule | Description | |------|-------------| | object-curly-spacing | Spaced object braces with nested-close exception | | two-blank-lines-after-imports | Exactly two blank lines after the final top-level import | | no-blank-lines-between-declarations | No blank lines between consecutive variable declarations | | blank-line-after-if | Blank line after an if statement before the next statement | | blank-line-after-unpacking | Blank lines between leading declaration preparation phases |

Imports

| Rule | Description | Options | |------|-------------|---------| | import-general-to-specific | Import ordering by source category with alphabetical fallback | internalAliases | | no-relative-cross-package-imports | Disallow relative imports that cross package boundaries | packageRootPattern |

Variables & exports

| Rule | Description | |------|-------------| | no-unused | Report and autofix unused imports, destructured properties, and caught errors | | no-renamed-unused-destructure | Disallow destructuring renames to underscore-prefixed names |

Documentation

| Rule | Description | |------|-------------| | require-jsdoc | Require JSDoc for named/exported functions, class methods, and object methods |

Environment boundaries

| Rule | Description | Options | |------|-------------|---------| | no-process-exit-outside-cli | Disallow process.exit outside CLI files | allowedProcessExitGlobs | | no-nodejs-builtins-in-webapp | Disallow Node.js built-ins in browser code | browserCodeGlobs |

Configurable options

Rules that encode path or alias assumptions accept options so they work in any project layout:

• internalAliases — list of bare import aliases treated as internal (e.g. ["backend", "shared"]).
• packageRootPattern — glob identifying package roots (default: packages/*).
• allowedProcessExitGlobs — globs where process.exit is permitted.
• browserCodeGlobs — globs that define browser-only code boundaries.

Configs

| Config | Description | |--------|-------------| | configs.recommended | Built-in ESLint rules + all custom rules at error | | configs.react | recommended + eslint-plugin-react + eslint-plugin-react-hooks |

Development

Run the rule tests (ESLint's RuleTester on Node's built-in test runner):

npm install
npm test

License

MIT