eslint-plugin-modularity 2.5.4 → 2.6.0
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 +25 -0
- package/package.json +7 -2
- package/src/index.js +1 -1
- package/src/rules/ddd-anemic-domain-model.js +1 -1
- package/src/rules/ddd-value-object-immutability.js +1 -1
- package/src/rules/enforce-naming.js +1 -1
- package/src/rules/enforce-rest-conventions.js +1 -1
- package/src/rules/no-external-api-calls-in-utils.js +1 -1
- package/src/rules/no-mutable-exports.js +1 -1
package/README.md
CHANGED
|
@@ -46,10 +46,34 @@ That trade costs recall, and we measure it:
|
|
|
46
46
|
|
|
47
47
|
- To check out the [guide](https://eslint.interlace.tools/docs/quality/plugin-modularity?utm_source=github&utm_medium=referral&utm_campaign=eslint-plugin-modularity), visit [eslint.interlace.tools](https://eslint.interlace.tools/?utm_source=github&utm_medium=referral&utm_campaign=eslint-plugin-modularity). 📚
|
|
48
48
|
|
|
49
|
+
<!-- AUTO-GENERATED:INSTALL:START - Do not edit manually -->
|
|
50
|
+
|
|
51
|
+
**oxlint / Vite+** — the same rules under the same `modularity/<rule>` IDs, without ESLint:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm install oxlint-plugin-modularity --save-dev
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
```jsonc
|
|
58
|
+
// .oxlintrc.json
|
|
59
|
+
{ "jsPlugins": ["oxlint-plugin-modularity"] }
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
// vite.config.ts
|
|
64
|
+
import { defineConfig } from 'vite-plus';
|
|
65
|
+
|
|
66
|
+
export default defineConfig({ lint: { jsPlugins: ['oxlint-plugin-modularity'] } });
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**ESLint:**
|
|
70
|
+
|
|
49
71
|
```bash
|
|
50
72
|
npm install eslint-plugin-modularity --save-dev
|
|
51
73
|
```
|
|
52
74
|
|
|
75
|
+
<!-- AUTO-GENERATED:INSTALL:END -->
|
|
76
|
+
|
|
53
77
|
## ⚙️ Configuration Presets
|
|
54
78
|
| Preset | Description |
|
|
55
79
|
| :------------ | :----------------------------------------- |
|
|
@@ -222,6 +246,7 @@ Part of the **Interlace ESLint ecosystem** — AI-native rules with LLM-optimize
|
|
|
222
246
|
|
|
223
247
|
| Plugin | Downloads | Description |
|
|
224
248
|
| :--- | :---: | :--- |
|
|
249
|
+
| [`eslint-plugin-cli-floor`](https://www.npmjs.com/package/eslint-plugin-cli-floor) | [](https://www.npmjs.com/package/eslint-plugin-cli-floor) | CLI floor for commander, yargs and burgee. |
|
|
225
250
|
| [`eslint-plugin-conventions`](https://www.npmjs.com/package/eslint-plugin-conventions) | [](https://www.npmjs.com/package/eslint-plugin-conventions) | Team-specific habits and styles. |
|
|
226
251
|
| [`eslint-plugin-import-next`](https://www.npmjs.com/package/eslint-plugin-import-next) | [](https://www.npmjs.com/package/eslint-plugin-import-next) | Fast cycle + import-graph analysis. |
|
|
227
252
|
| [`eslint-plugin-maintainability`](https://www.npmjs.com/package/eslint-plugin-maintainability) | [](https://www.npmjs.com/package/eslint-plugin-maintainability) | Cognitive load and clean-code patterns. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-modularity",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.6.0",
|
|
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,11 +58,16 @@
|
|
|
58
58
|
"node": ">=18.0.0"
|
|
59
59
|
},
|
|
60
60
|
"dependencies": {
|
|
61
|
-
"@interlace/eslint-devkit": "^1.
|
|
61
|
+
"@interlace/eslint-devkit": "^1.21.0"
|
|
62
62
|
},
|
|
63
63
|
"peerDependencies": {
|
|
64
64
|
"eslint": "^8.40.0 || ^9.0.0 || ^10.0.0"
|
|
65
65
|
},
|
|
66
|
+
"peerDependenciesMeta": {
|
|
67
|
+
"eslint": {
|
|
68
|
+
"optional": true
|
|
69
|
+
}
|
|
70
|
+
},
|
|
66
71
|
"funding": {
|
|
67
72
|
"type": "github",
|
|
68
73
|
"url": "git+https://github.com/ofri-peretz/eslint.git"
|
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.
|
|
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.6.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 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.dddAnemicDomainModel=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");function isDto(className,dtoPatterns){return dtoPatterns.some(pattern=>className.endsWith(pattern))}function isSimpleGetterSetter(member){if(member.value.type!=="FunctionExpression"){return false}const methodName=member.key.type==="Identifier"?member.key.name:"";const body=member.value.body;if(body.type!=="BlockStatement"||body.body.length===0){return false}if(methodName.startsWith("get")&&body.body.length===1){const statement=body.body[0];if(statement.type==="ReturnStatement"&&statement.argument){return true}}if(methodName.startsWith("set")&&body.body.length===1){const statement=body.body[0];if(statement.type==="ExpressionStatement"&&statement.expression.type==="AssignmentExpression"){return true}}return false}function isPureDelegation(member){if(member.value.type!=="FunctionExpression"){return false}const body=member.value.body;if(body.type!=="BlockStatement"||body.body.length!==1){return false}const statement=body.body[0];const builtInMethods=new Set(["map","filter","reduce","forEach","find","findIndex","some","every","includes","indexOf","slice","concat","join","sort","reverse","push","pop","shift","unshift","splice","flat","flatMap","toString","valueOf","toJSON"]);if(statement.type==="ReturnStatement"&&statement.argument){const arg=statement.argument;if(arg.type==="CallExpression"&&arg.callee.type==="MemberExpression"){const callee=arg.callee;const methodName=callee.property.type==="Identifier"?callee.property.name:"";if(builtInMethods.has(methodName)){return false}const object=callee.object;if(object.type==="MemberExpression"&&object.object.type==="ThisExpression"){const propName=object.property.type==="Identifier"?object.property.name:"";if(propName.includes("repository")||propName.includes("service")||propName.includes("api")||propName.includes("client")||propName.includes("dao")||propName.includes("Repository")||propName.includes("Service")||propName.includes("Api")){return true}return false}if(object.type==="Identifier"){return true}}}if(statement.type==="ExpressionStatement"){const expr=statement.expression;if(expr.type==="CallExpression"&&expr.callee.type==="MemberExpression"){const callee=expr.callee;const methodName=callee.property.type==="Identifier"?callee.property.name:"";if(builtInMethods.has(methodName)){return false}const object=callee.object;if(object.type==="MemberExpression"&&object.object.type==="ThisExpression"){const propName=object.property.type==="Identifier"?object.property.name:"";if(propName.includes("repository")||propName.includes("service")||propName.includes("api")||propName.includes("client")||propName.includes("dao")||propName.includes("Repository")||propName.includes("Service")||propName.includes("Api")){return true}return false}}}return false}function countBusinessMethods(node){let count=0;for(const member of node.body.body){if(member.type==="MethodDefinition"){const methodName=member.key.type==="Identifier"?member.key.name:"";if(member.kind==="get"||member.kind==="set"){continue}if(methodName==="constructor"){continue}if(isSimpleGetterSetter(member)){continue}if(isPureDelegation(member)){continue}const valueType=member.value.type;if(valueType==="FunctionExpression"||valueType==="ArrowFunctionExpression"){count++}}else if(member.type==="PropertyDefinition"){continue}}return count}const DEFAULT_DOMAIN_PATHS=["domain","domains","entities","entity","aggregate","aggregates","model","models"];function isDomainFile(filename,segments){if(segments.length===0)return true;return filename.replace(/\\/g,"/").split("/").some(part=>segments.includes(part))}exports.dddAnemicDomainModel=(0,eslint_devkit_2.createRule)({name:"ddd-anemic-domain-model",meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/ddd-anemic-domain-model.md",description:"Detects entities with only getters/setters and no business logic"},hasSuggestions:true,messages:{anemicDomainModel:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"Anemic domain model",description:"Class {{className}} has no business logic (only getters/setters)",severity:"MEDIUM",fix:"Add business logic methods to create a rich domain model",documentationLink:"https://martinfowler.com/bliki/AnemicDomainModel.html"}),addBusinessLogic:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Add Business Logic",description:"Add business logic methods",severity:"LOW",fix:"Add domain behavior methods to {{className}}",documentationLink:"https://martinfowler.com/bliki/AnemicDomainModel.html"}),migrateToRichModel:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Migrate to Rich Model",description:"Migrate to rich domain model",severity:"LOW",fix:"Encapsulate behavior with data",documentationLink:"https://martinfowler.com/bliki/AnemicDomainModel.html"}),identifyAggregateRoot:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Identify Aggregate Root",description:"Identify aggregate root and enforce invariants",severity:"LOW",fix:"Define aggregate boundaries and enforce invariants",documentationLink:"https://martinfowler.com/bliki/DDD_Aggregate.html"})},schema:[{type:"object",properties:{minBusinessMethods:{type:"number",default:1,minimum:0,description:"Minimum business methods required"},ignoreDtos:{type:"boolean",default:true,description:"Ignore DTOs and data transfer objects"},domainPaths:{type:"array",items:{type:"string"},description:"Directory segments holding domain code. Empty checks everywhere."},dtoPatterns:{type:"array",items:{type:"string"},default:["DTO","Dto","Data","Request","Response","Payload"],description:"Patterns for DTO identification"}},additionalProperties:false}]},defaultOptions:[{minBusinessMethods:1,ignoreDtos:true,dtoPatterns:["DTO","Dto","Data","Request","Response","Payload"],domainPaths:DEFAULT_DOMAIN_PATHS}],
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.dddAnemicDomainModel=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");function isDto(className,dtoPatterns){return dtoPatterns.some(pattern=>className.endsWith(pattern))}function isSimpleGetterSetter(member){if(member.value.type!=="FunctionExpression"){return false}const methodName=member.key.type==="Identifier"?member.key.name:"";const body=member.value.body;if(body.type!=="BlockStatement"||body.body.length===0){return false}if(methodName.startsWith("get")&&body.body.length===1){const statement=body.body[0];if(statement.type==="ReturnStatement"&&statement.argument){return true}}if(methodName.startsWith("set")&&body.body.length===1){const statement=body.body[0];if(statement.type==="ExpressionStatement"&&statement.expression.type==="AssignmentExpression"){return true}}return false}function isPureDelegation(member){if(member.value.type!=="FunctionExpression"){return false}const body=member.value.body;if(body.type!=="BlockStatement"||body.body.length!==1){return false}const statement=body.body[0];const builtInMethods=new Set(["map","filter","reduce","forEach","find","findIndex","some","every","includes","indexOf","slice","concat","join","sort","reverse","push","pop","shift","unshift","splice","flat","flatMap","toString","valueOf","toJSON"]);if(statement.type==="ReturnStatement"&&statement.argument){const arg=statement.argument;if(arg.type==="CallExpression"&&arg.callee.type==="MemberExpression"){const callee=arg.callee;const methodName=callee.property.type==="Identifier"?callee.property.name:"";if(builtInMethods.has(methodName)){return false}const object=callee.object;if(object.type==="MemberExpression"&&object.object.type==="ThisExpression"){const propName=object.property.type==="Identifier"?object.property.name:"";if(propName.includes("repository")||propName.includes("service")||propName.includes("api")||propName.includes("client")||propName.includes("dao")||propName.includes("Repository")||propName.includes("Service")||propName.includes("Api")){return true}return false}if(object.type==="Identifier"){return true}}}if(statement.type==="ExpressionStatement"){const expr=statement.expression;if(expr.type==="CallExpression"&&expr.callee.type==="MemberExpression"){const callee=expr.callee;const methodName=callee.property.type==="Identifier"?callee.property.name:"";if(builtInMethods.has(methodName)){return false}const object=callee.object;if(object.type==="MemberExpression"&&object.object.type==="ThisExpression"){const propName=object.property.type==="Identifier"?object.property.name:"";if(propName.includes("repository")||propName.includes("service")||propName.includes("api")||propName.includes("client")||propName.includes("dao")||propName.includes("Repository")||propName.includes("Service")||propName.includes("Api")){return true}return false}}}return false}function countBusinessMethods(node){let count=0;for(const member of node.body.body){if(member.type==="MethodDefinition"){const methodName=member.key.type==="Identifier"?member.key.name:"";if(member.kind==="get"||member.kind==="set"){continue}if(methodName==="constructor"){continue}if(isSimpleGetterSetter(member)){continue}if(isPureDelegation(member)){continue}const valueType=member.value.type;if(valueType==="FunctionExpression"||valueType==="ArrowFunctionExpression"){count++}}else if(member.type==="PropertyDefinition"){continue}}return count}const DEFAULT_DOMAIN_PATHS=["domain","domains","entities","entity","aggregate","aggregates","model","models"];function isDomainFile(filename,segments){if(segments.length===0)return true;return filename.replace(/\\/g,"/").split("/").some(part=>segments.includes(part))}exports.dddAnemicDomainModel=(0,eslint_devkit_2.createRule)({name:"ddd-anemic-domain-model",meta:{interop:{runtimes:["eslint"]},type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/ddd-anemic-domain-model.md",description:"Detects entities with only getters/setters and no business logic"},hasSuggestions:true,messages:{anemicDomainModel:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"Anemic domain model",description:"Class {{className}} has no business logic (only getters/setters)",severity:"MEDIUM",fix:"Add business logic methods to create a rich domain model",documentationLink:"https://martinfowler.com/bliki/AnemicDomainModel.html"}),addBusinessLogic:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Add Business Logic",description:"Add business logic methods",severity:"LOW",fix:"Add domain behavior methods to {{className}}",documentationLink:"https://martinfowler.com/bliki/AnemicDomainModel.html"}),migrateToRichModel:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Migrate to Rich Model",description:"Migrate to rich domain model",severity:"LOW",fix:"Encapsulate behavior with data",documentationLink:"https://martinfowler.com/bliki/AnemicDomainModel.html"}),identifyAggregateRoot:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Identify Aggregate Root",description:"Identify aggregate root and enforce invariants",severity:"LOW",fix:"Define aggregate boundaries and enforce invariants",documentationLink:"https://martinfowler.com/bliki/DDD_Aggregate.html"})},schema:[{type:"object",properties:{minBusinessMethods:{type:"number",default:1,minimum:0,description:"Minimum business methods required"},ignoreDtos:{type:"boolean",default:true,description:"Ignore DTOs and data transfer objects"},domainPaths:{type:"array",items:{type:"string"},description:"Directory segments holding domain code. Empty checks everywhere."},dtoPatterns:{type:"array",items:{type:"string"},default:["DTO","Dto","Data","Request","Response","Payload"],description:"Patterns for DTO identification"}},additionalProperties:false}]},defaultOptions:[{minBusinessMethods:1,ignoreDtos:true,dtoPatterns:["DTO","Dto","Data","Request","Response","Payload"],domainPaths:DEFAULT_DOMAIN_PATHS}],createOnce(context,currentOptions){let minBusinessMethods;let ignoreDtos;let dtoPatterns;let domainPaths;let inDomain;function checkClass(node){if(!inDomain){return}if(!node.id){return}const className=node.id.name;if(ignoreDtos&&isDto(className,dtoPatterns)){return}const businessMethodCount=countBusinessMethods(node);if(businessMethodCount<minBusinessMethods){context.report({node,messageId:"anemicDomainModel",data:{className},suggest:[{messageId:"addBusinessLogic",fix:()=>null,data:{className}},{messageId:"migrateToRichModel",fix:()=>null},{messageId:"identifyAggregateRoot",fix:()=>null}]})}}return{before(){const[options={}]=currentOptions();({minBusinessMethods=1,ignoreDtos=true,dtoPatterns=["DTO","Dto","Data","Request","Response","Payload"],domainPaths=DEFAULT_DOMAIN_PATHS}=options||{});inDomain=isDomainFile(context.filename,domainPaths)},ClassDeclaration:checkClass,ClassExpression:checkClass}}});
|
|
@@ -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"&&(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}],
|
|
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:{interop:{runtimes:["eslint","oxlint"]},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}],createOnce(context,currentOptions){let valueObjectPatterns;let requireReadonly;let checkObjectFreeze;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{before(){const[options={}]=currentOptions();({valueObjectPatterns=["Value","VO","ValueObject"],requireReadonly=true,checkObjectFreeze=true}=options||{})},ClassDeclaration:checkClass,ClassExpression:checkClass}}});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.enforceNaming=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.enforceNaming=(0,eslint_devkit_2.createRule)({name:"enforce-naming",meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/enforce-naming.md",description:"Enforce domain-specific naming conventions with business context",cwe:"CWE-216",cvss:5},fixable:"code",hasSuggestions:true,messages:{wrongTerminology:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.QUALITY,issueName:"Domain terminology mismatch",cwe:"CWE-216",description:"Domain terminology mismatch",severity:"MEDIUM",fix:'Use "{{correctTerm}}" ({{context}}) for ubiquitous language alignment',documentationLink:"Domain glossary"}),useDomainTerm:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Domain Term",description:"Replace with domain terminology",severity:"LOW",fix:'Use "{{correctTerm}}" instead',documentationLink:"https://martinfowler.com/bliki/UbiquitousLanguage.html"}),viewGlossary:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"View Glossary",description:"View domain glossary",severity:"LOW",fix:"Reference domain glossary for correct terminology",documentationLink:"https://martinfowler.com/bliki/UbiquitousLanguage.html"})},schema:[{type:"object",properties:{domain:{type:"string",default:"general"},terms:{type:"array",items:{type:"object",properties:{incorrect:{type:["string","object"]},correct:{type:"string"},context:{type:"string"},examples:{type:"array",items:{type:"string"}}},required:["incorrect","correct","context"]}},glossaryUrl:{type:"string"}},additionalProperties:false}]},defaultOptions:[{domain:"general",terms:[],glossaryUrl:void 0}],
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.enforceNaming=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.enforceNaming=(0,eslint_devkit_2.createRule)({name:"enforce-naming",meta:{interop:{runtimes:["eslint"]},type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/enforce-naming.md",description:"Enforce domain-specific naming conventions with business context",cwe:"CWE-216",cvss:5},fixable:"code",hasSuggestions:true,messages:{wrongTerminology:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.QUALITY,issueName:"Domain terminology mismatch",cwe:"CWE-216",description:"Domain terminology mismatch",severity:"MEDIUM",fix:'Use "{{correctTerm}}" ({{context}}) for ubiquitous language alignment',documentationLink:"Domain glossary"}),useDomainTerm:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Domain Term",description:"Replace with domain terminology",severity:"LOW",fix:'Use "{{correctTerm}}" instead',documentationLink:"https://martinfowler.com/bliki/UbiquitousLanguage.html"}),viewGlossary:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"View Glossary",description:"View domain glossary",severity:"LOW",fix:"Reference domain glossary for correct terminology",documentationLink:"https://martinfowler.com/bliki/UbiquitousLanguage.html"})},schema:[{type:"object",properties:{domain:{type:"string",default:"general"},terms:{type:"array",items:{type:"object",properties:{incorrect:{type:["string","object"]},correct:{type:"string"},context:{type:"string"},examples:{type:"array",items:{type:"string"}}},required:["incorrect","correct","context"]}},glossaryUrl:{type:"string"}},additionalProperties:false}]},defaultOptions:[{domain:"general",terms:[],glossaryUrl:void 0}],createOnce(context){let domain;let terms;const checkIdentifier=name=>{for(const term of terms){if(typeof term.incorrect==="string"){if(name.toLowerCase().includes(term.incorrect.toLowerCase())){return term}}else if(term.incorrect instanceof RegExp){if(term.incorrect.test(name)){return term}}}return null};const preserveCase=(original,replacement)=>{if(original===original.toUpperCase()){return replacement.toUpperCase()}if(original[0]===original[0].toUpperCase()){return replacement.charAt(0).toUpperCase()+replacement.slice(1)}return replacement.toLowerCase()};const generateReplacement=(name,term)=>{if(typeof term.incorrect==="string"){return name.replace(new RegExp(`(${term.incorrect})`,"gi"),match=>{return preserveCase(match,term.correct)})}return term.correct};const reportViolation=(node,violatedTerm)=>{const replacement=generateReplacement(node.name,violatedTerm);context.report({node,messageId:"wrongTerminology",data:{incorrectTerm:node.name,correctTerm:violatedTerm.correct,context:violatedTerm.context||domain,domain},suggest:[{messageId:"useDomainTerm",data:{correctTerm:violatedTerm.correct},fix:fixer=>{return fixer.replaceText(node,replacement)}}]})};return{before(){const options=context.options[0]||{};({domain="general",terms=[]}=options);if(!terms||terms.length===0){return false}return true},VariableDeclarator(node){if(node.id.type!=="Identifier")return;const violatedTerm=checkIdentifier(node.id.name);if(violatedTerm){reportViolation(node.id,violatedTerm)}},FunctionDeclaration(node){if(!node.id)return;const violatedTerm=checkIdentifier(node.id.name);if(violatedTerm){reportViolation(node.id,violatedTerm)}},ClassDeclaration(node){if(!node.id)return;const violatedTerm=checkIdentifier(node.id.name);if(violatedTerm){reportViolation(node.id,violatedTerm)}},PropertyDefinition(node){if(node.key.type!=="Identifier")return;const violatedTerm=checkIdentifier(node.key.name);if(violatedTerm){reportViolation(node.key,violatedTerm)}},MethodDefinition(node){if(node.key.type!=="Identifier")return;const violatedTerm=checkIdentifier(node.key.name);if(violatedTerm){reportViolation(node.key,violatedTerm)}}}}});
|
|
@@ -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}],
|
|
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:{interop:{runtimes:["eslint","oxlint"]},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}],createOnce(context,currentOptions){let checkStatusCodes;let checkResourceNaming;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{before(){const[options={}]=currentOptions();({checkStatusCodes=true,checkResourceNaming=true}=options||{})},CallExpression:checkCallExpression}}});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noExternalApiCallsInUtils=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const DEFAULT_HTTP_MODULES=["axios","got","ky","node-fetch","undici","superagent","request","phin","needle","http","https","http2","node:http","node:https","node:http2"];const DEFAULT_NETWORK_METHODS=["get","post","put","patch","delete","head","options","request","fetch","all","stream"];const DEFAULT_UTILITY_PATTERNS=["**/utils/**","**/helpers/**","**/lib/**"];const GLOBAL_CLIENTS=new Set(["fetch"]);const GLOBAL_CLIENT_HOSTS=new Set(["window","globalThis","global","self"]);const AMBIGUOUS_MODULE_NAMES=new Set(["request","got"]);function isUtilityFile(filename,patterns){return patterns.some(pattern=>{const regex=new RegExp(pattern.replace(/\*\*/g,".*").replace(/\*/g,"[^/]*"));return regex.test(filename)})}function rootName(node){let current=node;while(current.type==="MemberExpression"){current=current.object}return current.type==="Identifier"?current.name:null}function requiredModule(node){if(node.type==="CallExpression"&&node.callee.type==="Identifier"&&node.callee.name==="require"&&node.arguments[0]?.type==="Literal"&&typeof node.arguments[0].value==="string"){return node.arguments[0].value}return null}exports.noExternalApiCallsInUtils=(0,eslint_devkit_2.createRule)({name:"no-external-api-calls-in-utils",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/no-external-api-calls-in-utils.md",description:"Detects network calls in utility functions"},hasSuggestions:true,messages:{externalApiCallInUtils:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"External API call in utils",description:"Network call in utility function - breaks testability",severity:"HIGH",fix:"Use dependency injection for network calls",documentationLink:"https://rules.sonarsource.com/javascript/RSPEC-1075/"}),useDependencyInjection:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Dependency Injection",description:"Inject API client",severity:"LOW",fix:"function util(apiClient) { return apiClient.get(...) }",documentationLink:"https://en.wikipedia.org/wiki/Dependency_injection"}),extractToService:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Extract to Service",description:"Extract to service layer",severity:"LOW",fix:"Create services/apiService.ts",documentationLink:"https://martinfowler.com/eaaCatalog/serviceLayer.html"}),passApiClient:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Pass API Client",description:"Pass API client as parameter",severity:"LOW",fix:"function util(apiClient, data) { ... }",documentationLink:"https://en.wikipedia.org/wiki/Dependency_injection"})},schema:[{type:"object",properties:{httpModules:{type:"array",items:{type:"string"},default:DEFAULT_HTTP_MODULES},ignoreInTests:{type:"boolean",default:true},networkMethods:{description:'HTTP method names to flag. A bare name ("get") applies only when the receiver resolves to a known HTTP client. A dotted entry ("httpClient.get") is an exact object.method escape hatch that bypasses client resolution entirely \u2014 use it for an in-house client this rule cannot trace.',type:"array",items:{type:"string"},default:DEFAULT_NETWORK_METHODS},utilityPatterns:{type:"array",items:{type:"string"},default:DEFAULT_UTILITY_PATTERNS}},additionalProperties:false}]},defaultOptions:[{httpModules:DEFAULT_HTTP_MODULES,ignoreInTests:true,networkMethods:DEFAULT_NETWORK_METHODS,utilityPatterns:DEFAULT_UTILITY_PATTERNS}],
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noExternalApiCallsInUtils=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const DEFAULT_HTTP_MODULES=["axios","got","ky","node-fetch","undici","superagent","request","phin","needle","http","https","http2","node:http","node:https","node:http2"];const DEFAULT_NETWORK_METHODS=["get","post","put","patch","delete","head","options","request","fetch","all","stream"];const DEFAULT_UTILITY_PATTERNS=["**/utils/**","**/helpers/**","**/lib/**"];const GLOBAL_CLIENTS=new Set(["fetch"]);const GLOBAL_CLIENT_HOSTS=new Set(["window","globalThis","global","self"]);const AMBIGUOUS_MODULE_NAMES=new Set(["request","got"]);function isUtilityFile(filename,patterns){return patterns.some(pattern=>{const regex=new RegExp(pattern.replace(/\*\*/g,".*").replace(/\*/g,"[^/]*"));return regex.test(filename)})}function rootName(node){let current=node;while(current.type==="MemberExpression"){current=current.object}return current.type==="Identifier"?current.name:null}function requiredModule(node){if(node.type==="CallExpression"&&node.callee.type==="Identifier"&&node.callee.name==="require"&&node.arguments[0]?.type==="Literal"&&typeof node.arguments[0].value==="string"){return node.arguments[0].value}return null}exports.noExternalApiCallsInUtils=(0,eslint_devkit_2.createRule)({name:"no-external-api-calls-in-utils",meta:{interop:{runtimes:["eslint","oxlint"]},type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/no-external-api-calls-in-utils.md",description:"Detects network calls in utility functions"},hasSuggestions:true,messages:{externalApiCallInUtils:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.ARCHITECTURE,issueName:"External API call in utils",description:"Network call in utility function - breaks testability",severity:"HIGH",fix:"Use dependency injection for network calls",documentationLink:"https://rules.sonarsource.com/javascript/RSPEC-1075/"}),useDependencyInjection:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Use Dependency Injection",description:"Inject API client",severity:"LOW",fix:"function util(apiClient) { return apiClient.get(...) }",documentationLink:"https://en.wikipedia.org/wiki/Dependency_injection"}),extractToService:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Extract to Service",description:"Extract to service layer",severity:"LOW",fix:"Create services/apiService.ts",documentationLink:"https://martinfowler.com/eaaCatalog/serviceLayer.html"}),passApiClient:(0,eslint_devkit_1.formatLLMMessage)({icon:eslint_devkit_1.MessageIcons.INFO,issueName:"Pass API Client",description:"Pass API client as parameter",severity:"LOW",fix:"function util(apiClient, data) { ... }",documentationLink:"https://en.wikipedia.org/wiki/Dependency_injection"})},schema:[{type:"object",properties:{httpModules:{type:"array",items:{type:"string"},default:DEFAULT_HTTP_MODULES},ignoreInTests:{type:"boolean",default:true},networkMethods:{description:'HTTP method names to flag. A bare name ("get") applies only when the receiver resolves to a known HTTP client. A dotted entry ("httpClient.get") is an exact object.method escape hatch that bypasses client resolution entirely \u2014 use it for an in-house client this rule cannot trace.',type:"array",items:{type:"string"},default:DEFAULT_NETWORK_METHODS},utilityPatterns:{type:"array",items:{type:"string"},default:DEFAULT_UTILITY_PATTERNS}},additionalProperties:false}]},defaultOptions:[{httpModules:DEFAULT_HTTP_MODULES,ignoreInTests:true,networkMethods:DEFAULT_NETWORK_METHODS,utilityPatterns:DEFAULT_UTILITY_PATTERNS}],createOnce(context,currentOptions){let modules;let methods;let explicitPairs;let clients;let aliases;let calls;function trackBinding(id){if(id.type==="Identifier"){clients.add(id.name)}else if(id.type==="ObjectPattern"){for(const property of id.properties){if(property.type==="Property"&&property.value.type==="Identifier"){clients.add(property.value.name)}}}}function isNetworkCall(node){const callee=node.callee;if(callee.type==="Identifier"){return clients.has(callee.name)}if(callee.type!=="MemberExpression"||callee.computed||callee.property.type!=="Identifier"){return false}const method=callee.property.name;const root=rootName(callee.object);if(root===null){return false}if(explicitPairs.has(`${root}.${method}`)){return true}if(GLOBAL_CLIENT_HOSTS.has(root)){return GLOBAL_CLIENTS.has(method)}return clients.has(root)&&methods.has(method)}return{before(){const[options={}]=currentOptions();const{httpModules=DEFAULT_HTTP_MODULES,ignoreInTests=true,networkMethods=DEFAULT_NETWORK_METHODS,utilityPatterns=DEFAULT_UTILITY_PATTERNS}=options||{};const filename=context.filename;const isTestFile=ignoreInTests&&/\.(test|spec)\.[cm]?[jt]sx?$/.test(filename);if(isTestFile){return false}const isUtility=isUtilityFile(filename,utilityPatterns);if(!isUtility){return false}modules=new Set(httpModules);methods=new Set(networkMethods);explicitPairs=new Set(networkMethods.filter(method=>method.includes(".")));clients=new Set(GLOBAL_CLIENTS);for(const source of modules){const bare=source.replace(/^node:/,"");if(/^[A-Za-z_$][\w$]*$/.test(bare)&&!AMBIGUOUS_MODULE_NAMES.has(bare)){clients.add(bare)}}aliases=[];calls=[];return true},ImportDeclaration(node){if(node.importKind==="type"||!modules.has(node.source.value)){return}for(const specifier of node.specifiers){if(specifier.type!=="ImportSpecifier"||specifier.importKind!=="type"){clients.add(specifier.local.name)}}},VariableDeclarator(node){if(!node.init){return}const source=requiredModule(node.init);if(source!==null){if(modules.has(source)){trackBinding(node.id)}return}const root=rootName(node.init.type==="CallExpression"?node.init.callee:node.init);if(root!==null&&node.id.type==="Identifier"){aliases.push([node.id.name,root])}},CallExpression(node){calls.push(node)},"Program:exit"(){let changed=true;while(changed){changed=false;for(const[local,root]of aliases){if(clients.has(root)&&!clients.has(local)){clients.add(local);changed=true}}}for(const node of calls){if(!isNetworkCall(node)){continue}context.report({node,messageId:"externalApiCallInUtils",suggest:[{messageId:"useDependencyInjection",fix:()=>null},{messageId:"extractToService",fix:()=>null},{messageId:"passApiClient",fix:()=>null}]})}}}}});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noMutableExports=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.noMutableExports=(0,eslint_devkit_1.createRule)({name:"no-mutable-exports",meta:{type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/no-mutable-exports.md",description:"Disallow mutable exports (export let / export var)"},fixable:"code",messages:{noMutableExport:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Mutable Export",description:"Exporting a `{{kind}}` binding creates a live, mutable reference visible to all importers. Use `const` instead.",severity:"MEDIUM",fix:"Change `export {{kind}}` to `export const`",documentationLink:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export"})},schema:[]},defaultOptions:[],
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noMutableExports=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");exports.noMutableExports=(0,eslint_devkit_1.createRule)({name:"no-mutable-exports",meta:{interop:{runtimes:["eslint","oxlint"],nativeEquivalent:"import/no-mutable-exports"},type:"suggestion",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-modularity/docs/rules/no-mutable-exports.md",description:"Disallow mutable exports (export let / export var)"},fixable:"code",messages:{noMutableExport:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Mutable Export",description:"Exporting a `{{kind}}` binding creates a live, mutable reference visible to all importers. Use `const` instead.",severity:"MEDIUM",fix:"Change `export {{kind}}` to `export const`",documentationLink:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export"})},schema:[]},defaultOptions:[],createOnce(context){return{ExportNamedDeclaration(node){const decl=node.declaration;if(!decl||decl.type!=="VariableDeclaration")return;if(decl.kind!=="let"&&decl.kind!=="var")return;context.report({node:decl,messageId:"noMutableExport",data:{kind:decl.kind},fix(fixer){const sourceCode=context.sourceCode;const kindToken=sourceCode.getFirstToken(decl);if(!kindToken)return null;return fixer.replaceText(kindToken,"const")}})}}}});
|