eslint-plugin-mizyind

9.0.7 verified Fri May 01 auth: no javascript

eslint-plugin-mizyind is a personal ESLint plugin by miZyind providing custom lint rules and config presets for ESLint v9 flat config. The current stable version is 9.0.7, with release cadence roughly monthly. It enforces custom rules (e.g., filename naming conventions) and offers shared configs for Next.js and TypeScript. Key differentiators: tailored for miZyind's personal style with minimal dependencies, requires Node >=24 and ESLint >=9. The plugin is ESM-only from v9 and supports TypeScript out of the box via bundled configs. It is designed for single-user or small-team use, not a community standard.

Common errors

error Error: Cannot find module 'eslint-plugin-mizyind' ↓

cause Plugin not installed or wrong package name.

fix

Run 'yarn add eslint-plugin-mizyind -D' or 'npm install eslint-plugin-mizyind --save-dev'.

error TypeError: plugin.configs.base is not a function ↓

cause Attempting to call configs.base() as a function.

fix

Use 'require('eslint-plugin-mizyind').configs.base' without parentheses.

error ESLint couldn't find the config 'mizyind'. ↓

cause Trying to use 'extends' with string 'mizyind' in .eslintrc.

fix

Use flat config format (eslint.config.js) and assign configs.base directly.

Warnings

breaking Node >=24 required starting from v9.0.0. ↓

fix Upgrade Node.js to version 24 or later.

breaking ESLint >=9 required; no support for .eslintrc config files. ↓

fix Migrate to eslint.config.js flat config and use ESLint 9+.

breaking Plugin v9 uses OIDC instead of access token for releases (internal). ↓

fix If self-hosting or forking, ensure OIDC is configured or downgrade to v8.

deprecated The 'mizyind/filename' rule may receive breaking changes in future versions. ↓

fix Monitor release notes; consider pinning minor version.

gotcha The plugin does not export ES modules; require() is mandatory in eslint.config.js. ↓

fix Use CommonJS require, not import, in your config file (eslint.config.js).

gotcha Only one custom rule 'mizyind/filename' is provided; no other rules are contributed. ↓

fix If you need additional rules, extend other plugins separately.

Install

npm install eslint-plugin-mizyind

yarn add eslint-plugin-mizyind

pnpm add eslint-plugin-mizyind

Imports

configs.base

wrong

module.exports = require('eslint-plugin-mizyind').configs.base();

correct

module.exports = require('eslint-plugin-mizyind').configs.base;

configs.base is an object, not a function; do not call it.

configs.next

wrong

import { configs } from 'eslint-plugin-mizyind'; export default configs.next;

correct

module.exports = require('eslint-plugin-mizyind').configs.next;

The plugin does not ship ESM exports; use CommonJS require in eslint.config.js.

rules['mizyind/filename']

wrong

import { rules } from 'eslint-plugin-mizyind';

correct

const plugin = require('eslint-plugin-mizyind'); plugin.rules['mizyind/filename'];

rules property is not exported at top level; access via the plugin object.

Quickstart

Shows how to use the base flat config in eslint.config.js with require().

// eslint.config.js
module.exports = require('eslint-plugin-mizyind').configs.base;
// Then run: npx eslint .
// For Next.js:
// module.exports = require('eslint-plugin-mizyind').configs.next;
// For TypeScript:
// module.exports = require('eslint-plugin-mizyind').configs.typescript;