Registry / testing / eslint-plugin-n8n-local-rules

eslint-plugin-n8n-local-rules

library1.0.0jsnpmunverified

ESLint plugin for defining and using local custom rules within the n8n project. Version 1.0.0, stable. Based on Clayton Watts's eslint-plugin-local-rules, it allows n8n contributors to write project-specific lint rules without publishing separate packages. Key differentiator: designed specifically for n8n's internal code standards, but can serve as a template for any project needing local ESLint rules.

testing

npm install eslint-plugin-n8n-local-rules

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-N8N-

eslint-plugin-n8n-local-rules

testingjavascriptv1.0.0

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.

default

✓ const localRules = require('eslint-plugin-n8n-local-rules');

✗ import localRules from 'eslint-plugin-n8n-local-rules';

Package is CommonJS-only; cannot use ESM import syntax.

rules

✓ const { rules } = require('eslint-plugin-n8n-local-rules');

✗ import { rules } from 'eslint-plugin-n8n-local-rules';

Export is CJS module.exports, not ESM named export.

configs

✓ const { configs } = require('eslint-plugin-n8n-local-rules');

✗ import { configs } from 'eslint-plugin-n8n-local-rules';

Configuration presets provided; requires CJS destructuring.

Shows how to enable the plugin and set local rules in an ESLint config file.

// .eslintrc.js module.exports = { plugins: ['n8n-local-rules'], rules: { 'n8n-local-rules/no-hardcoded-credentials': 'error', 'n8n-local-rules/require-translation': 'warn' } };

Debug

Known issues

gotchaRules are loaded from a 'local-rules' directory; must exist and contain rule files.

fix

Create a 'local-rules' directory in your project root with JavaScript rule files.

affects: >=1.0.0

gotchaPlugin only works with ESLint's legacy config format (.eslintrc.*); flat config not supported.

fix

Use .eslintrc.js or .eslintrc.json instead of eslint.config.js.

affects: >=1.0.0

gotchaRule names must be kebab-case; plugin fails silently if naming convention is off.

fix

Name rule files like 'no-hardcoded-credentials.js' and use that name in config.

affects: >=1.0.0

Errors

Common errors & fixes

ESLint couldn't find the plugin 'eslint-plugin-n8n-local-rules'.

Plugin not installed or not in node_modules.

fix

Run 'npm install eslint-plugin-n8n-local-rules --save-dev'.

Cannot find module 'eslint-plugin-n8n-local-rules'

CommonJS require fails when package is not installed.

fix

Ensure package is installed: npm list eslint-plugin-n8n-local-rules

Definition for rule 'n8n-local-rules/rule-name' was not found

Rule file missing in 'local-rules' directory or name mismatch.

fix

Create a file named 'rule-name.js' in the 'local-rules' directory exporting a rule object.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

eslintrequiredpeer dependency; plugin injects rules into ESLint's runtime

Agent activity

5 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/ivov/eslint-plugin-n8n-local-rules ↗

packagehttps://www.npmjs.com/package/eslint-plugin-n8n-local-rules ↗