Registry / http-networking / eslint-plugin-utils

eslint-plugin-utils

library0.4.1jsnpmunverified

eslint-plugin-utils is a utility library for building ESLint plugins and custom rules, developed as part of the un-ts monorepo. The current stable version is 0.4.1, released in December 2024, with a focus on compatibility with ESLint flat config and TypeScript. It provides helpers for rule creation, schema validation, and AST traversal, reducing boilerplate for ESLint plugin authors. Key differentiators include first-class TypeScript support with bundled types, dependency on @typescript-eslint/utils for type-safe rule creation, and support for both legacy and flat ESLint configurations. The package follows semver and is updated as part of a monorepo with several related plugins (text, markup, htm).

http-networking web-framework

npm install eslint-plugin-utils

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-UTIL

eslint-plugin-utils

http-networkingjavascriptv0.4.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createRule

✓ import { createRule } from 'eslint-plugin-utils'

✗ const { createRule } = require('eslint-plugin-utils')

ESM-only since v0.4.0; the package no longer supports CommonJS require()

default

✓ import eslintPluginUtils from 'eslint-plugin-utils'

✗ import * as utils from 'eslint-plugin-utils'

Default export was removed in v0.4.0; all utilities are now named exports. Use 'import * as utils' or destructure named exports.

getFilename

✓ import { getFilename } from 'eslint-plugin-utils'

Use this to reliably get the filename from a context object, works with both legacy and flat config.

RuleTester

✓ import { RuleTester } from 'eslint-plugin-utils'

Not to be confused with ESLint's built-in RuleTester; this is a re-export from @typescript-eslint/utils with enhanced features.

Shows how to create a simple ESLint custom rule using createRule from eslint-plugin-utils with type-safe options and a fixer.

import { createRule } from 'eslint-plugin-utils'; export const myRule = createRule({ name: 'my-rule', meta: { type: 'suggestion', docs: { description: 'Description of my rule', recommended: 'error', }, fixable: 'code', schema: [ { type: 'string' } ], }, defaultOptions: ['defaultOption'], create: (context, optionsWithDefault) => { return { Literal: (node) => { const [option] = optionsWithDefault; if (typeof node.value !== 'string') return; if (node.value === option) { context.report({ node, message: 'Avoid using the default option: {{ option }}', data: { option }, fix: (fixer) => fixer.replaceText(node, `'changed'`), }); } }, }; }, });

Debug

Known issues

breakingESM-only since 0.4.0; require() is no longer supported.

fix

Use import syntax instead of require(). If using CommonJS, upgrade to ESM or stick with v0.3.x.

affects: >=0.4.0

breakingDefault export removed in 0.4.0; use named exports.

fix

Replace import eslintPluginUtils from 'eslint-plugin-utils' with import * as utils from 'eslint-plugin-utils' or destructure named exports.

affects: >=0.4.0

deprecatedThe createRule function no longer accepts a 'create' callback without defaultOptions - use defaultOptions array in create.

fix

Ensure you pass defaultOptions as part of the rule definition, even if empty array.

affects: >=0.4.0

gotchaThe getFilename function may return undefined in flat config if used without a file name.

fix

Always provide a filename in flat config context or handle undefined case.

affects: >=0.4.0

gotchaRuleTester from eslint-plugin-utils requires @typescript-eslint/utils as peer dependency; may cause missing package errors if not installed.

fix

Install @typescript-eslint/utils as a dev dependency: npm install --save-dev @typescript-eslint/utils

affects: >=0.4.0

deprecatedThe 'recommended' meta property is deprecated in favor of 'recommended' being a string severity in 'docs.recommended'? Verify with ESLint docs.

fix

Use 'docs.recommended' as string like 'error' or 'warn' instead of boolean.

affects: >=0.4.0

Errors

Common errors & fixes

Cannot find module 'eslint-plugin-utils' or its corresponding type declarations.

Package is ESM-only and not resolved properly in TypeScript without 'moduleResolution': 'node16' or 'bundler'.

fix

Set 'moduleResolution' to 'node16' or 'bundler' in tsconfig.json, or use 'esModuleInterop'.

TypeError: createRule is not a function

Attempted to use require() to import the package, but it's ESM-only.

fix

Change to import statement: import { createRule } from 'eslint-plugin-utils'

Error: Cannot use 'in' operator to search for 'create' in undefined

Missing defaultOptions in rule definition when using createRule with no defaultOptions provided.

fix

Add defaultOptions: [] to the rule definition.

Error: The 'parserServices' property requires TypeScript and @typescript-eslint/parser to be used.

Using TypeScript-specific utilities without the required parser and plugin.

fix

Ensure you have @typescript-eslint/parser installed and configured in ESLint config.

Upgrade

Version history

0.4.1latest on npm

Audit

Dependencies

eslintrequiredpeer dependency - the utilities are designed to work with ESLint core

@typescript-eslint/utilsrequiredpeer dependency - provides TypeScript utilities and types for rule creation

Agent activity

9 hits · last 30 days

node

OpenAI (training)

Amazon

Resources

githubhttps://github.com/un-ts/eslint ↗

packagehttps://www.npmjs.com/package/eslint-plugin-utils ↗