eslint-plugin-modularity 2.5.1 → 2.5.2
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-modularity",
|
|
3
|
-
"version": "2.5.
|
|
3
|
+
"version": "2.5.2",
|
|
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.
|
|
61
|
+
"@interlace/eslint-devkit": "^1.19.0"
|
|
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.5.
|
|
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.2"},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.dddValueObjectImmutability=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");function isValueObject(className,patterns){return patterns.some(pattern=>className.endsWith(pattern))}function hasReadonlyModifier(node){return node.readonly===true}function usesObjectFreeze(node){for(const member of node.body.body){if(member.type==="MethodDefinition"&&member.kind==="constructor"){const constructor=member.value;if(constructor.type==="FunctionExpression"){const body=constructor.body;if(body.type==="BlockStatement"){for(const statement of body.body){if(statement.type==="ExpressionStatement"&&statement.expression.type==="CallExpression"&&statement.expression.callee.type==="MemberExpression"&&statement.expression.callee.object.type==="Identifier"&&statement.expression.callee.object.name==="Object"&&
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.dddValueObjectImmutability=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");function isValueObject(className,patterns){return patterns.some(pattern=>className.endsWith(pattern))}function hasReadonlyModifier(node){return node.readonly===true}function usesObjectFreeze(node){for(const member of node.body.body){if(member.type==="MethodDefinition"&&member.kind==="constructor"){const constructor=member.value;if(constructor.type==="FunctionExpression"){const body=constructor.body;if(body.type==="BlockStatement"){for(const statement of body.body){if(statement.type==="ExpressionStatement"&&statement.expression.type==="CallExpression"&&statement.expression.callee.type==="MemberExpression"&&statement.expression.callee.object.type==="Identifier"&&statement.expression.callee.object.name==="Object"&&(0,eslint_devkit_1.propertyName)(statement.expression.callee)==="freeze"){return true}}}}}}return false}exports.dddValueObjectImmutability=(0,eslint_devkit_2.createRule)({name:"ddd-value-object-immutability",skipGeneratedFiles:true,meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/ddd-value-object-immutability.md",description:"Validates value objects are properly immutable"},hasSuggestions:true,messages:{mutableValueObject:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"Mutable value object",description:"Value object {{className}} has mutable properties",severity:"MEDIUM",fix:"Make properties readonly or use Object.freeze",documentationLink:"https://martinfowler.com/bliki/ValueObject.html"}),mutableNestedType:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"Mutable nested type",description:"Value object {{className}} has mutable nested type (array/object) - use Readonly<T> or readonly arrays",severity:"MEDIUM",fix:"Use readonly arrays or Readonly<T> for nested objects",documentationLink:"https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype"}),addReadonly:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Add Readonly",description:"Add readonly modifier",severity:"LOW",fix:"readonly propertyName: Type",documentationLink:"https://www.typescriptlang.org/docs/handbook/2/classes.html#readonly"}),useObjectFreeze:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Object.freeze",description:"Use Object.freeze in constructor",severity:"LOW",fix:"constructor() { Object.freeze(this); }",documentationLink:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze"}),makeImmutable:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Make Immutable",description:"Make value object fully immutable",severity:"LOW",fix:"Add readonly to all properties and freeze object",documentationLink:"https://martinfowler.com/bliki/ValueObject.html"})},schema:[{type:"object",properties:{valueObjectPatterns:{type:"array",items:{type:"string"},default:["Value","VO","ValueObject"],description:"Patterns to identify value objects"},requireReadonly:{type:"boolean",default:true,description:"Require readonly modifiers"},checkObjectFreeze:{type:"boolean",default:true,description:"Check for Object.freeze usage"}},additionalProperties:false}]},defaultOptions:[{valueObjectPatterns:["Value","VO","ValueObject"],requireReadonly:true,checkObjectFreeze:true}],create(context,[options={}]){const{valueObjectPatterns=["Value","VO","ValueObject"],requireReadonly=true,checkObjectFreeze=true}=options||{};function checkClass(node){if(!node.id){return}const className=node.id.name;if(!isValueObject(className,valueObjectPatterns)){return}if(checkObjectFreeze&&usesObjectFreeze(node)){return}const mutableProperties=[];for(const member of node.body.body){if(member.type==="PropertyDefinition"){if(requireReadonly&&!hasReadonlyModifier(member)){mutableProperties.push(member)}}}if(mutableProperties.length>0){context.report({node,messageId:"mutableValueObject",data:{className},suggest:[{messageId:"addReadonly",fix:()=>null},{messageId:"useObjectFreeze",fix:()=>null},{messageId:"makeImmutable",fix:()=>null}]})}}return{ClassDeclaration:checkClass,ClassExpression:checkClass}}});
|
|
@@ -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
|
|
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 method=(0,eslint_devkit_1.propertyName)(node.callee);if(method!==null){const methodName=method.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"){if((0,eslint_devkit_1.propertyName)(node.callee)==="status"){}}}return{CallExpression:checkCallExpression}}});
|