eslint-plugin-modularity 2.4.0 → 2.5.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.
package/README.md CHANGED
@@ -13,6 +13,7 @@
13
13
  <p align="center">
14
14
  <a href="https://www.npmjs.com/package/eslint-plugin-modularity" target="_blank"><img src="https://img.shields.io/npm/v/eslint-plugin-modularity.svg" alt="NPM Version" /></a>
15
15
  <a href="https://www.npmjs.com/package/eslint-plugin-modularity" target="_blank"><img src="https://img.shields.io/npm/dm/eslint-plugin-modularity.svg" alt="NPM Downloads" /></a>
16
+ <a href="https://packagephobia.com/result?p=eslint-plugin-modularity" target="_blank"><img src="https://badgen.net/packagephobia/install/eslint-plugin-modularity" alt="Install Size" /></a>
16
17
  <a href="https://opensource.org/licenses/MIT" target="_blank"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="Package License" /></a>
17
18
  <a href="https://app.codecov.io/gh/ofri-peretz/eslint/components?components%5B0%5D=eslint-plugin-modularity" target="_blank"><img src="https://codecov.io/gh/ofri-peretz/eslint/graph/badge.svg?component=eslint-plugin-modularity" alt="Codecov" /></a>
18
19
  <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>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-plugin-modularity",
3
- "version": "2.4.0",
3
+ "version": "2.5.1",
4
4
  "description": "ESLint plugin for module architecture — enforces DDD value objects and anemic-model checks, naming, REST conventions, and utility isolation.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/index.js",
@@ -58,7 +58,7 @@
58
58
  "node": ">=18.0.0"
59
59
  },
60
60
  "dependencies": {
61
- "@interlace/eslint-devkit": "^1.17.4"
61
+ "@interlace/eslint-devkit": "^1.18.2"
62
62
  },
63
63
  "peerDependencies": {
64
64
  "eslint": "^8.40.0 || ^9.0.0 || ^10.0.0"
package/src/index.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.configs=exports.plugin=exports.rules=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");exports.rules={get"ddd-anemic-domain-model"(){return require("./rules/ddd-anemic-domain-model").dddAnemicDomainModel},get"ddd-value-object-immutability"(){return require("./rules/ddd-value-object-immutability").dddValueObjectImmutability},get"enforce-naming"(){return require("./rules/enforce-naming").enforceNaming},get"enforce-rest-conventions"(){return require("./rules/enforce-rest-conventions").enforceRestConventions},get"no-external-api-calls-in-utils"(){return require("./rules/no-external-api-calls-in-utils").noExternalApiCallsInUtils},get"no-mutable-exports"(){return require("./rules/no-mutable-exports").noMutableExports}};(0,eslint_devkit_1.withCanonicalDocsUrls)("plugin-modularity",exports.rules);exports.plugin={meta:{name:"eslint-plugin-modularity",version:"2.4.0"},rules:exports.rules};const recommendedRules={"modularity/ddd-anemic-domain-model":"warn","modularity/ddd-value-object-immutability":"error","modularity/enforce-naming":"warn","modularity/enforce-rest-conventions":"error","modularity/no-external-api-calls-in-utils":"error","modularity/no-mutable-exports":"warn"};exports.configs={recommended:{plugins:{"modularity":exports.plugin},rules:recommendedRules},strict:{plugins:{"modularity":exports.plugin},rules:Object.fromEntries(Object.keys(exports.rules).map(ruleName=>[`modularity/${ruleName}`,"error"]))}};exports.default=exports.plugin;
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.configs=exports.plugin=exports.rules=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");exports.rules={get"ddd-anemic-domain-model"(){return require("./rules/ddd-anemic-domain-model").dddAnemicDomainModel},get"ddd-value-object-immutability"(){return require("./rules/ddd-value-object-immutability").dddValueObjectImmutability},get"enforce-naming"(){return require("./rules/enforce-naming").enforceNaming},get"enforce-rest-conventions"(){return require("./rules/enforce-rest-conventions").enforceRestConventions},get"no-external-api-calls-in-utils"(){return require("./rules/no-external-api-calls-in-utils").noExternalApiCallsInUtils},get"no-mutable-exports"(){return require("./rules/no-mutable-exports").noMutableExports}};(0,eslint_devkit_1.withCanonicalDocsUrls)("plugin-modularity",exports.rules);exports.plugin={meta:{name:"eslint-plugin-modularity",version:"2.5.1"},rules:exports.rules};const recommendedRules={"modularity/ddd-anemic-domain-model":"warn","modularity/ddd-value-object-immutability":"error","modularity/enforce-naming":"warn","modularity/enforce-rest-conventions":"error","modularity/no-external-api-calls-in-utils":"error","modularity/no-mutable-exports":"warn"};exports.configs={recommended:{plugins:{"modularity":exports.plugin},rules:recommendedRules},strict:{plugins:{"modularity":exports.plugin},rules:Object.fromEntries(Object.keys(exports.rules).map(ruleName=>[`modularity/${ruleName}`,"error"]))}};exports.default=exports.plugin;
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.enforceRestConventions=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.enforceRestConventions=(0,eslint_devkit_2.createRule)({name:"enforce-rest-conventions",meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/enforce-rest-conventions.md",description:"Validates REST endpoint design against best practices"},hasSuggestions:true,messages:{restConventionViolation:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"REST convention violation",description:"{{violation}}: {{details}}",severity:"MEDIUM",fix:"Follow RESTful conventions for HTTP methods, status codes, and resource naming",documentationLink:"https://restfulapi.net/"}),useProperHttpMethod:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use HTTP Method",description:"Use proper HTTP method",severity:"LOW",fix:"GET (read), POST (create), PUT/PATCH (update), DELETE (delete)",documentationLink:"https://restfulapi.net/http-methods/"}),useProperStatusCode:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Status Code",description:"Use appropriate status code",severity:"LOW",fix:"200 (OK), 201 (Created), 204 (No Content), 400 (Bad Request), 404 (Not Found)",documentationLink:"https://restfulapi.net/http-status-codes/"}),fixResourceNaming:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Resource Naming",description:"Use plural nouns for resources",severity:"LOW",fix:"/users, /orders, /products (not /user, /order)",documentationLink:"https://restfulapi.net/resource-naming/"})},schema:[{type:"object",properties:{checkHttpMethods:{type:"boolean",default:true,description:"Check HTTP methods"},checkStatusCodes:{type:"boolean",default:true,description:"Check status codes"},checkResourceNaming:{type:"boolean",default:true,description:"Check resource naming"}},additionalProperties:false}]},defaultOptions:[{checkHttpMethods:true,checkStatusCodes:true,checkResourceNaming:true}],create(context,[options={}]){const{checkStatusCodes=true,checkResourceNaming=true}=options||{};function checkCallExpression(node){if(node.callee.type==="MemberExpression"){const property=node.callee.property;if(property.type==="Identifier"){const methodName=property.name.toLowerCase();const httpMethods=["get","post","put","patch","delete","head","options"];if(httpMethods.includes(methodName)){if(checkResourceNaming&&node.arguments.length>0){const pathArg=node.arguments[0];if(pathArg.type==="Literal"&&typeof pathArg.value==="string"){const path=pathArg.value;if(path.startsWith("/")&&path.length>1){const resource=path.split("/")[1];if(!path.includes(":")&&!resource.endsWith("s")&&resource.length>3){context.report({node:pathArg,messageId:"restConventionViolation",data:{violation:"Resource naming",details:`Resource "${resource}" should be plural (e.g., /users, /orders)`},suggest:[{messageId:"fixResourceNaming",fix:()=>null}]})}}}}}}}if(checkStatusCodes&&node.callee.type==="MemberExpression"){const property=node.callee.property;if(property.type==="Identifier"&&property.name==="status"){}}}return{CallExpression:checkCallExpression}}});
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.enforceRestConventions=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.enforceRestConventions=(0,eslint_devkit_2.createRule)({name:"enforce-rest-conventions",meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/enforce-rest-conventions.md",description:"Validates REST endpoint design against best practices"},hasSuggestions:true,messages:{restConventionViolation:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"REST convention violation",description:"{{violation}}: {{details}}",severity:"MEDIUM",fix:"Follow RESTful conventions for HTTP methods, status codes, and resource naming",documentationLink:"https://restfulapi.net/"}),useProperHttpMethod:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use HTTP Method",description:"Use proper HTTP method",severity:"LOW",fix:"GET (read), POST (create), PUT/PATCH (update), DELETE (delete)",documentationLink:"https://restfulapi.net/http-methods/"}),useProperStatusCode:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Status Code",description:"Use appropriate status code",severity:"LOW",fix:"200 (OK), 201 (Created), 204 (No Content), 400 (Bad Request), 404 (Not Found)",documentationLink:"https://restfulapi.net/http-status-codes/"}),fixResourceNaming:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Resource Naming",description:"Use plural nouns for resources",severity:"LOW",fix:"/users, /orders, /products (not /user, /order)",documentationLink:"https://restfulapi.net/resource-naming/"})},schema:[{type:"object",properties:{checkHttpMethods:{type:"boolean",default:true,description:"Check HTTP methods"},checkStatusCodes:{type:"boolean",default:true,description:"Check status codes"},checkResourceNaming:{type:"boolean",default:true,description:"Check resource naming"}},additionalProperties:false}]},defaultOptions:[{checkHttpMethods:true,checkStatusCodes:true,checkResourceNaming:true}],create(context,[options={}]){const{checkStatusCodes=true,checkResourceNaming=true}=options||{};function checkCallExpression(node){if(node.callee.type==="MemberExpression"){const property=node.callee.property;if(property.type==="Identifier"){const methodName=property.name.toLowerCase();const httpMethods=["get","post","put","patch","delete","head","options"];if(httpMethods.includes(methodName)){if(checkResourceNaming&&node.arguments.length>0){const pathArg=node.arguments[0];const staticText=(0,eslint_devkit_1.staticString)(pathArg);if(staticText!==null){const path=staticText;if(path.startsWith("/")&&path.length>1){const resource=path.split("/")[1];if(!path.includes(":")&&!resource.endsWith("s")&&resource.length>3){context.report({node:pathArg,messageId:"restConventionViolation",data:{violation:"Resource naming",details:`Resource "${resource}" should be plural (e.g., /users, /orders)`},suggest:[{messageId:"fixResourceNaming",fix:()=>null}]})}}}}}}}if(checkStatusCodes&&node.callee.type==="MemberExpression"){const property=node.callee.property;if(property.type==="Identifier"&&property.name==="status"){}}}return{CallExpression:checkCallExpression}}});