eslint-plugin-conventions 4.0.0 โ†’ 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -18
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -10,6 +10,8 @@
10
10
  <a href="https://www.npmjs.com/package/eslint-plugin-conventions" target="_blank"><img src="https://img.shields.io/npm/v/eslint-plugin-conventions.svg" alt="NPM Version" /></a>
11
11
  <a href="https://www.npmjs.com/package/eslint-plugin-conventions" target="_blank"><img src="https://img.shields.io/npm/dm/eslint-plugin-conventions.svg" alt="NPM Downloads" /></a>
12
12
  <a href="https://opensource.org/licenses/MIT" target="_blank"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="Package License" /></a>
13
+ <a href="https://app.codecov.io/gh/ofri-peretz/eslint/components?components%5B0%5D=conventions" target="_blank"><img src="https://codecov.io/gh/ofri-peretz/eslint/graph/badge.svg?component=conventions" alt="Codecov" /></a>
14
+ <a href="https://github.com/ofri-peretz/eslint" target="_blank"><img src="https://img.shields.io/badge/Since-Dec_2025-blue?logo=rocket&logoColor=white" alt="Since Dec 2025" /></a>
13
15
  </p>
14
16
 
15
17
  ## Description
@@ -23,6 +25,11 @@ This plugin enforces consistent code conventions and style patterns across JavaS
23
25
  ## Getting Started
24
26
 
25
27
  - To check out the [guide](https://eslint.interlace.tools/docs/conventions), visit [eslint.interlace.tools](https://eslint.interlace.tools). ๐Ÿ“š
28
+ - ่ฆๆŸฅ็œ‹ไธญๆ–‡ [ๆŒ‡ๅ—](https://eslint.interlace.tools/docs/conventions), ่ฏท่ฎฟ้—ฎ [eslint.interlace.tools](https://eslint.interlace.tools). ๐Ÿ“š
29
+ - [๊ฐ€์ด๋“œ](https://eslint.interlace.tools/docs/conventions) ๋ฌธ์„œ๋Š” [eslint.interlace.tools](https://eslint.interlace.tools)์—์„œ ํ™•์ธํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๐Ÿ“š
30
+ - [ใ‚ฌใ‚คใƒ‰](https://eslint.interlace.tools/docs/conventions)ใฏ [eslint.interlace.tools](https://eslint.interlace.tools)ใงใ”็ขบ่ชใใ ใ•ใ„ใ€‚ ๐Ÿ“š
31
+ - Para ver la [guรญa](https://eslint.interlace.tools/docs/conventions), visita [eslint.interlace.tools](https://eslint.interlace.tools). ๐Ÿ“š
32
+ - ู„ู„ุงุทู„ุงุน ุนู„ู‰ [ุงู„ุฏู„ูŠู„](https://eslint.interlace.tools/docs/conventions)ุŒ ู‚ู… ุจุฒูŠุงุฑุฉ [eslint.interlace.tools](https://eslint.interlace.tools). ๐Ÿ“š
26
33
 
27
34
  ```bash
28
35
  npm install eslint-plugin-conventions --save-dev
@@ -47,21 +54,50 @@ export default [conventions.configs.recommended];
47
54
 
48
55
  ---
49
56
 
50
- ## Rules
57
+ ## AI-Optimized Messages
58
+
59
+ This plugin is optimized for ESLint's [Model Context Protocol (MCP)](https://eslint.org/docs/latest/use/mcp), enabling AI assistants like **Cursor**, **GitHub Copilot**, and **Claude** to:
51
60
 
52
- | Rule | Description | ๐Ÿ’ผ | โš ๏ธ |
53
- | :--------------------------------------------------------------------------------------- | :-------------------------------------------------------- | :-: | :-: |
54
- | [no-commented-code](./docs/rules/no-commented-code.md) | Disallow commented-out code blocks | ๐Ÿ’ผ | โš ๏ธ |
55
- | [expiring-todo-comments](./docs/rules/expiring-todo-comments.md) | Enforce expiration dates on TODO comments | ๐Ÿ’ผ | โš ๏ธ |
56
- | [prefer-code-point](./docs/rules/prefer-code-point.md) | Prefer `codePointAt` over `charCodeAt` for Unicode safety | | |
57
- | [prefer-dom-node-text-content](./docs/rules/prefer-dom-node-text-content.md) | Prefer `textContent` over `innerText` for performance | | |
58
- | [no-console-spaces](./docs/rules/no-console-spaces.md) | Disallow leading/trailing spaces in console calls | | |
59
- | [no-deprecated-api](./docs/rules/no-deprecated-api.md) | Disallow usage of deprecated Node.js APIs | ๐Ÿ’ผ | โš ๏ธ |
60
- | [prefer-dependency-version-strategy](./docs/rules/prefer-dependency-version-strategy.md) | Enforce consistent version strategies in package.json | | |
61
- | [filename-case](./docs/rules/filename-case.md) | Enforce consistent file naming conventions | | |
62
- | [consistent-existence-index-check](./docs/rules/consistent-existence-index-check.md) | Enforce consistent array index existence checks | | |
61
+ - Understand the exact issue via structured context
62
+ - Apply the correct fix using guidance
63
+ - Provide educational context to developers
63
64
 
64
- **Legend**: ๐Ÿ’ผ Recommended | โš ๏ธ Warns (not error)
65
+ ```json
66
+ // .cursor/mcp.json
67
+ {
68
+ "mcpServers": {
69
+ "eslint": {
70
+ "command": "npx",
71
+ "args": ["@eslint/mcp@latest"]
72
+ }
73
+ }
74
+ }
75
+ ```
76
+
77
+ ---
78
+
79
+ ## Rules
80
+
81
+ **Legend**
82
+
83
+ | Icon | Description |
84
+ | :--: | :----------------------------------------------------------------- |
85
+ | ๐Ÿ’ผ | **Recommended**: Included in the recommended preset. |
86
+ | โš ๏ธ | **Warns**: Set to warn in recommended preset. |
87
+ | ๐Ÿ”ง | **Auto-fixable**: Automatically fixable by the `--fix` CLI option. |
88
+ | ๐Ÿ’ก | **Suggestions**: Providing code suggestions in IDE. |
89
+
90
+ | Rule | Description | ๐Ÿ’ผ | โš ๏ธ | ๐Ÿ”ง | ๐Ÿ’ก |
91
+ | :--------------------------------------------------------------------------------------- | :-------------------------------------------------------- | :-: | :-: | :-: | :-: |
92
+ | [no-commented-code](./docs/rules/no-commented-code.md) | Disallow commented-out code blocks | ๐Ÿ’ผ | โš ๏ธ | | |
93
+ | [expiring-todo-comments](./docs/rules/expiring-todo-comments.md) | Enforce expiration dates on TODO comments | ๐Ÿ’ผ | โš ๏ธ | | |
94
+ | [prefer-code-point](./docs/rules/prefer-code-point.md) | Prefer `codePointAt` over `charCodeAt` for Unicode safety | | | ๐Ÿ”ง | |
95
+ | [prefer-dom-node-text-content](./docs/rules/prefer-dom-node-text-content.md) | Prefer `textContent` over `innerText` for performance | | | ๐Ÿ”ง | |
96
+ | [no-console-spaces](./docs/rules/no-console-spaces.md) | Disallow leading/trailing spaces in console calls | | | ๐Ÿ”ง | |
97
+ | [no-deprecated-api](./docs/rules/no-deprecated-api.md) | Disallow usage of deprecated Node.js APIs | ๐Ÿ’ผ | โš ๏ธ | | |
98
+ | [prefer-dependency-version-strategy](./docs/rules/prefer-dependency-version-strategy.md) | Enforce consistent version strategies in package.json | | | | |
99
+ | [filename-case](./docs/rules/filename-case.md) | Enforce consistent file naming conventions | | | | |
100
+ | [consistent-existence-index-check](./docs/rules/consistent-existence-index-check.md) | Enforce consistent array index existence checks | | | ๐Ÿ”ง | |
65
101
 
66
102
  ---
67
103
 
@@ -69,12 +105,16 @@ export default [conventions.configs.recommended];
69
105
 
70
106
  Part of the **Interlace ESLint Ecosystem** โ€” AI-native quality plugins with LLM-optimized error messages:
71
107
 
72
- | Plugin | Description |
73
- | :--------------------------------------------------------------------------------------------- | :---------------------------------- |
74
- | [`eslint-plugin-maintainability`](https://www.npmjs.com/package/eslint-plugin-maintainability) | Cognitive complexity & code quality |
75
- | [`eslint-plugin-reliability`](https://www.npmjs.com/package/eslint-plugin-reliability) | Error handling & null safety |
76
- | [`eslint-plugin-operability`](https://www.npmjs.com/package/eslint-plugin-operability) | Production readiness & debug code |
108
+ | Plugin | Downloads | Description |
109
+ | :--------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------- |
110
+ | [`eslint-plugin-maintainability`](https://www.npmjs.com/package/eslint-plugin-maintainability) | [![downloads](https://img.shields.io/npm/dt/eslint-plugin-maintainability.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-maintainability) | Cognitive complexity & code quality |
111
+ | [`eslint-plugin-reliability`](https://www.npmjs.com/package/eslint-plugin-reliability) | [![downloads](https://img.shields.io/npm/dt/eslint-plugin-reliability.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-reliability) | Error handling & null safety |
112
+ | [`eslint-plugin-operability`](https://www.npmjs.com/package/eslint-plugin-operability) | [![downloads](https://img.shields.io/npm/dt/eslint-plugin-operability.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-operability) | Production readiness & debug code |
77
113
 
78
114
  ## ๐Ÿ“„ License
79
115
 
80
116
  MIT ยฉ [Ofri Peretz](https://github.com/ofri-peretz)
117
+
118
+ <p align="center">
119
+ <a href="https://eslint.interlace.tools/docs/conventions"><img src="https://eslint.interlace.tools/images/og-quality.png" alt="ESLint Interlace Plugin" width="300" /></a>
120
+ </p>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-plugin-conventions",
3
- "version": "4.0.0",
3
+ "version": "4.0.1",
4
4
  "description": "ESLint rules for team-specific disciplinary patterns and code conventions.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/index.js",