npmpackage.info

Gathering detailed insights and metrics for eslint-plugin-local-rules

Other packages similar to eslint-plugin-local-rules

eslint-plugin-n8n-local-rules

1.0.0

Plugin for n8n local rules. Based on Clayton Watts's eslint-plugin-local-rules

eslint-plugin-local

6.0.0

This ESLint plugin allows you to implement a custom ESLint plugin including custom rules in your repository without installing them as a dependency.

eslint-plugin-rulesdir

0.2.2

Allows a local ESLint rules directory to be used without a command-line flag

@fltri/eslint-plugin-local-rules

1.1.1

Define local rules for eslint without having an extra package.

Gathering detailed insights and metrics for eslint-plugin-local-rules

eslint-plugin-local-rules - 3.0.2 | npmpackage.info

eslint-plugin-local-rules

A plugin for ESLint that allows you to use project-specific rules

3.0.2

167

MIT

JavaScript

686.00 B

35,925,993 2.8

Installations

npm install eslint-plugin-local-rules

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

20.14.0

NPM Version

10.7.0 Score

99.8

Supply Chain

100

Quality

77.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

19

Closed

2

Merged

15

Issues

Open

5

Total

16

Closed

11

Releases

v3.0.2

Updated on Jun 23, 2024

v3.0.1

Updated on Jun 23, 2024

Update postcss

v2.0.1

Updated on Nov 25, 2023

v2.0.0

Updated on Aug 25, 2023

v1.3.2

Updated on Aug 30, 2022

v1.3.1

Updated on Jul 25, 2022

View All 17 releases

Languages

JavaScript

JavaScript (100%)

Developer

cletusw

Download Statistics

Total Downloads

35,925,993

Last Day

85,179

Last Week

485,120

Last Month

2,103,177

Last Year

18,374,789

GitHub Statistics

MIT License

167 Stars

53 Commits

9 Forks

2 Watchers

3 Branches

10 Contributors

Updated on Mar 27, 2025

Bundle Size

1.21 kB

Minified

686.00 B

Minified + Gzipped

Bundlephobia

Package Meta Information

Latest Version

3.0.2

Package Id

eslint-plugin-local-rules@3.0.2

Unpacked Size

11.08 kB

Size

4.60 kB

File Count

NPM Version

10.7.0

Node Version

20.14.0

Published on

Jun 23, 2024

Total Downloads

Cumulative downloads

Total Downloads

35,925,993

Last Day

14.3%

85,179

Compared to previous day

Last Week

-3.4%

485,120

Compared to previous week

Last Month

0.1%

2,103,177

Compared to previous month

Last Year

118.9%

18,374,789

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

prettier vitest

eslint-plugin-local-rules

A plugin for ESLint that allows you to use project-specific rules, similar to the deprecated --rulesdir command line option (more).

Install

1npm install eslint-plugin-local-rules

Usage (JavaScript)

./eslint-local-rules.js (or ./eslint-local-rules/index.js)

1'use strict';
2
3module.exports = {
4  'disallow-identifiers': {
5    meta: {
6      docs: {
7        description: 'disallow identifiers',
8        category: 'Possible Errors',
9      },
10      schema: [],
11    },
12    create: function (context) {
13      return {
14        Identifier: function (node) {
15          context.report({
16            node: node,
17            message: 'Identifiers not allowed for Super Important reasons.',
18          });
19        },
20      };
21    },
22  },
23};

./.eslintrc

Use all rules as errors

1{
2  "plugins": ["local-rules"],
3  "extends": [
4    "plugin:local-rules/all"
5  ]
6}

Use all rules as warnings

1{
2  "plugins": ["local-rules"],
3  "extends": [
4    "plugin:local-rules/all-warn"
5  ]
6}

Customize each rule independently

1{
2  "plugins": ["local-rules"],
3  "rules": {
4    "local-rules/disallow-identifiers": "error"
5  }
6}

Usage (TypeScript)

npm install ts-node @types/eslint

You'll also need an eslint config like the .eslintrc above (more info).

./eslint-local-rules/index.js

1require("ts-node").register({
2  transpileOnly: true,
3  compilerOptions: {
4    module: "commonjs",
5  },
6});
7
8module.exports = require("./rules").default;

./eslint-local-rules/rules.ts

1import type { Rule } from "eslint";
2
3export default {
4  "disallow-identifiers": {
5    meta: {
6      docs: {
7        description: 'disallow identifiers',
8        category: 'Possible Errors',
9      },
10      schema: [],
11    },
12    create: function (context) {
13      return {
14        Identifier: function (node) {
15          context.report({
16            node: node,
17            message: 'Identifiers not allowed for Super Important reasons.',
18          });
19        },
20      };
21    },
22  },
23} satisfies Record<string, Rule.RuleModule>;

npm/yarn/pnpm workspaces support

This plugin supports npm/yarn/pnpm workspaces, although note that if the eslint-local-rules.js file is in the workspace subdirectory, running from the project root is unsupported.

For example, if there's an eslint-local-rules.js and index.js in ./src/app:

Wrong: npx eslint src/app/index.js

Right: (cd src/app; npx eslint index.js)

Also note that if there is an eslint-local-rules.js file in both the workspace subdirectory and project root, the workspace one takes precedence (assuming you're running eslint from the workspace directory, as above).

Alternatives

eslint-plugin-local - Allows specifying additonal plugin config such as processors
eslint-plugin-rulesdir - Allows for a custom rules directory name

Context for this plugin

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More