solhint-plugin-mud 2.0.0-alpha.1.192 → 2.0.0-alpha.1.193

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";var o=require("@solidity-parser/parser"),e=class{ruleId="no-msg-sender";reporter;config;constructor(r,t,s,i){this.reporter=r,this.config=t}ContractDefinition(r){let{name:t,kind:s}=r,i=this.reporter,c=this.ruleId;(s==="library"||s==="contract"&&t.endsWith("System"))&&(0,o.visit)(r,{MemberAccess(n){let{expression:m,memberName:a}=n;m.type==="Identifier"&&a==="sender"&&i.error(n,c,'Systems and their libraries should use "_msgSender()" or "_world()" instead of "msg.sender".')}})}};module.exports=[e];
+"use strict";var l=Object.create;var a=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var d=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var u=(r,t,e,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of y(t))!S.call(r,s)&&s!==e&&a(r,s,{get:()=>t[s],enumerable:!(i=h(t,s))||i.enumerable});return r};var C=(r,t,e)=>(e=r!=null?l(d(r)):{},u(t||!r||!r.__esModule?a(e,"default",{value:r,enumerable:!0}):e,r));var n=class{ruleId="no-msg-sender";reporter;config;isSystemOrLibrary=!1;constructor(t,e){this.reporter=t,this.config=e}ContractDefinition(t){let{name:e,kind:i}=t;this.isSystemOrLibrary=i==="library"||i==="contract"&&e.endsWith("System")}"ContractDefinition:exit"(){this.isSystemOrLibrary=!1}MemberAccess(t){let{expression:e,memberName:i}=t;e.type==="Identifier"&&i==="sender"&&this.reporter.error(t,this.ruleId,'Systems and their libraries should use "_msgSender()" or "_world()" instead of "msg.sender".')}};var c=C(require("path")),m=require("@solidity-parser/parser"),o=class{ruleId="system-file-name";reporter;config;expectedContractName;isSystemFile=!1;constructor(t,e,i,s){this.reporter=t,this.config=e,this.expectedContractName=c.default.basename(s,".sol"),this.expectedContractName.endsWith("System")&&this.expectedContractName!=="System"&&!this.expectedContractName.match(/^I[A-Z]/)&&(this.isSystemFile=!0)}SourceUnit(t){if(!this.isSystemFile)return;let e=this.expectedContractName,i=!1;(0,m.visit)(t,{ContractDefinition(s){let{name:p,kind:f}=s;f==="contract"&&p===e&&(i=!0)}}),i||this.reporter.error(t,this.ruleId,`System file must contain a contract with a matching name "${e}"`)}};module.exports=[n,o];
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/rules/NoMsgSender.ts","../src/index.ts"],"sourcesContent":["import { visit } from \"@solidity-parser/parser\";\nimport type { ContractDefinition, MemberAccess } from \"@solidity-parser/parser/dist/src/ast-types\";\nimport { SolhintRule } from \"../solhintTypes\";\n\nexport class NoMsgSender implements SolhintRule {\n  ruleId = \"no-msg-sender\";\n  reporter: any;\n  config: any;\n\n  constructor(reporter: any, config: any, inputSrc: string, fileName: string) {\n    this.reporter = reporter;\n    this.config = config;\n  }\n\n  ContractDefinition(node: ContractDefinition) {\n    const { name, kind } = node;\n    const reporter = this.reporter;\n    const ruleId = this.ruleId;\n\n    if (kind === \"library\" || (kind === \"contract\" && name.endsWith(\"System\"))) {\n      visit(node, {\n        MemberAccess(node: MemberAccess) {\n          const { expression, memberName } = node;\n          if (expression.type === \"Identifier\" && memberName === \"sender\") {\n            reporter.error(\n              node,\n              ruleId,\n              `Systems and their libraries should use \"_msgSender()\" or \"_world()\" instead of \"msg.sender\".`\n            );\n          }\n        },\n      });\n    }\n  }\n}\n","import { NoMsgSender } from \"./rules/NoMsgSender\";\n\nexport = [NoMsgSender];\n"],"mappings":"aAAA,IAAAA,EAAsB,mCAITC,EAAN,KAAyC,CAC9C,OAAS,gBACT,SACA,OAEA,YAAYC,EAAeC,EAAaC,EAAkBC,EAAkB,CAC1E,KAAK,SAAWH,EAChB,KAAK,OAASC,CAChB,CAEA,mBAAmBG,EAA0B,CAC3C,GAAM,CAAE,KAAAC,EAAM,KAAAC,CAAK,EAAIF,EACjBJ,EAAW,KAAK,SAChBO,EAAS,KAAK,QAEhBD,IAAS,WAAcA,IAAS,YAAcD,EAAK,SAAS,QAAQ,OACtE,SAAMD,EAAM,CACV,aAAaA,EAAoB,CAC/B,GAAM,CAAE,WAAAI,EAAY,WAAAC,CAAW,EAAIL,EAC/BI,EAAW,OAAS,cAAgBC,IAAe,UACrDT,EAAS,MACPI,EACAG,EACA,8FACF,CAEJ,CACF,CAAC,CAEL,CACF,EChCA,eAAS,CAACG,CAAW","names":["import_parser","NoMsgSender","reporter","config","inputSrc","fileName","node","name","kind","ruleId","expression","memberName","NoMsgSender"]}
+{"version":3,"sources":["../src/rules/NoMsgSender.ts","../src/rules/SystemFileName.ts","../src/index.ts"],"sourcesContent":["import type { ContractDefinition, MemberAccess } from \"@solidity-parser/parser/dist/src/ast-types\";\nimport { SolhintRule } from \"../solhintTypes\";\n\nexport class NoMsgSender implements SolhintRule {\n  ruleId = \"no-msg-sender\";\n  reporter: any;\n  config: any;\n\n  isSystemOrLibrary = false;\n\n  constructor(reporter: any, config: any) {\n    this.reporter = reporter;\n    this.config = config;\n  }\n\n  ContractDefinition(node: ContractDefinition) {\n    const { name, kind } = node;\n\n    this.isSystemOrLibrary = kind === \"library\" || (kind === \"contract\" && name.endsWith(\"System\"));\n  }\n\n  \"ContractDefinition:exit\"() {\n    this.isSystemOrLibrary = false;\n  }\n\n  MemberAccess(node: MemberAccess) {\n    const { expression, memberName } = node;\n    if (expression.type === \"Identifier\" && memberName === \"sender\") {\n      this.reporter.error(\n        node,\n        this.ruleId,\n        `Systems and their libraries should use \"_msgSender()\" or \"_world()\" instead of \"msg.sender\".`\n      );\n    }\n  }\n}\n","import path from \"path\";\nimport { visit } from \"@solidity-parser/parser\";\nimport type { ContractDefinition, SourceUnit } from \"@solidity-parser/parser/dist/src/ast-types\";\nimport { SolhintRule } from \"../solhintTypes\";\n\nexport class SystemFileName implements SolhintRule {\n  ruleId = \"system-file-name\";\n  reporter: any;\n  config: any;\n\n  expectedContractName: string;\n  isSystemFile = false;\n\n  constructor(reporter: any, config: any, inputSrc: string, fileName: string) {\n    this.reporter = reporter;\n    this.config = config;\n\n    this.expectedContractName = path.basename(fileName, \".sol\");\n    if (\n      this.expectedContractName.endsWith(\"System\") &&\n      this.expectedContractName !== \"System\" &&\n      !this.expectedContractName.match(/^I[A-Z]/)\n    ) {\n      this.isSystemFile = true;\n    }\n  }\n\n  SourceUnit(node: SourceUnit) {\n    // only systems need a matching contract\n    if (!this.isSystemFile) return;\n    const expectedContractName = this.expectedContractName;\n\n    // search the source file for a matching contract name\n    let withMatchingContract = false;\n    visit(node, {\n      ContractDefinition(node: ContractDefinition) {\n        const { name, kind } = node;\n\n        if (kind === \"contract\" && name === expectedContractName) {\n          withMatchingContract = true;\n        }\n      },\n    });\n\n    if (!withMatchingContract) {\n      this.reporter.error(\n        node,\n        this.ruleId,\n        `System file must contain a contract with a matching name \"${expectedContractName}\"`\n      );\n    }\n  }\n}\n","import { NoMsgSender } from \"./rules/NoMsgSender\";\nimport { SystemFileName } from \"./rules/SystemFileName\";\n\nexport = [NoMsgSender, SystemFileName];\n"],"mappings":"wdAGO,IAAMA,EAAN,KAAyC,CAC9C,OAAS,gBACT,SACA,OAEA,kBAAoB,GAEpB,YAAYC,EAAeC,EAAa,CACtC,KAAK,SAAWD,EAChB,KAAK,OAASC,CAChB,CAEA,mBAAmBC,EAA0B,CAC3C,GAAM,CAAE,KAAAC,EAAM,KAAAC,CAAK,EAAIF,EAEvB,KAAK,kBAAoBE,IAAS,WAAcA,IAAS,YAAcD,EAAK,SAAS,QAAQ,CAC/F,CAEA,2BAA4B,CAC1B,KAAK,kBAAoB,EAC3B,CAEA,aAAaD,EAAoB,CAC/B,GAAM,CAAE,WAAAG,EAAY,WAAAC,CAAW,EAAIJ,EAC/BG,EAAW,OAAS,cAAgBC,IAAe,UACrD,KAAK,SAAS,MACZJ,EACA,KAAK,OACL,8FACF,CAEJ,CACF,ECnCA,IAAAK,EAAiB,mBACjBC,EAAsB,mCAITC,EAAN,KAA4C,CACjD,OAAS,mBACT,SACA,OAEA,qBACA,aAAe,GAEf,YAAYC,EAAeC,EAAaC,EAAkBC,EAAkB,CAC1E,KAAK,SAAWH,EAChB,KAAK,OAASC,EAEd,KAAK,qBAAuB,EAAAG,QAAK,SAASD,EAAU,MAAM,EAExD,KAAK,qBAAqB,SAAS,QAAQ,GAC3C,KAAK,uBAAyB,UAC9B,CAAC,KAAK,qBAAqB,MAAM,SAAS,IAE1C,KAAK,aAAe,GAExB,CAEA,WAAWE,EAAkB,CAE3B,GAAI,CAAC,KAAK,aAAc,OACxB,IAAMC,EAAuB,KAAK,qBAG9BC,EAAuB,MAC3B,SAAMF,EAAM,CACV,mBAAmBA,EAA0B,CAC3C,GAAM,CAAE,KAAAG,EAAM,KAAAC,CAAK,EAAIJ,EAEnBI,IAAS,YAAcD,IAASF,IAClCC,EAAuB,GAE3B,CACF,CAAC,EAEIA,GACH,KAAK,SAAS,MACZF,EACA,KAAK,OACL,6DAA6DC,IAC/D,CAEJ,CACF,ECjDA,eAAS,CAACI,EAAaC,CAAc","names":["NoMsgSender","reporter","config","node","name","kind","expression","memberName","import_path","import_parser","SystemFileName","reporter","config","inputSrc","fileName","path","node","expectedContractName","withMatchingContract","name","kind","NoMsgSender","SystemFileName"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solhint-plugin-mud",
-  "version": "2.0.0-alpha.1.192+966b379d",
+  "version": "2.0.0-alpha.1.193+a18fb753",
   "repository": {
     "type": "git",
     "url": "https://github.com/latticexyz/mud.git",
@@ -21,10 +21,11 @@
     "@solidity-parser/parser": "^0.16.0"
   },
   "devDependencies": {
+    "@types/node": "^18.15.11",
     "tsup": "^6.7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "966b379d6331ff7d9f176d098a0b51f022d442d7"
+  "gitHead": "a18fb753aefc74519f4345ee35b04802e1057309"
 }

package/src/index.ts

@@ -1,3 +1,4 @@
 import { NoMsgSender } from "./rules/NoMsgSender";
+import { SystemFileName } from "./rules/SystemFileName";
 
-export = [NoMsgSender];
+export = [NoMsgSender, SystemFileName];

package/src/rules/NoMsgSender.ts

@@ -1,4 +1,3 @@
-import { visit } from "@solidity-parser/parser";
 import type { ContractDefinition, MemberAccess } from "@solidity-parser/parser/dist/src/ast-types";
 import { SolhintRule } from "../solhintTypes";
 
@@ -7,29 +6,31 @@ export class NoMsgSender implements SolhintRule {
   reporter: any;
   config: any;
 
-  constructor(reporter: any, config: any, inputSrc: string, fileName: string) {
+  isSystemOrLibrary = false;
+
+  constructor(reporter: any, config: any) {
     this.reporter = reporter;
     this.config = config;
   }
 
   ContractDefinition(node: ContractDefinition) {
     const { name, kind } = node;
-    const reporter = this.reporter;
-    const ruleId = this.ruleId;
 
-    if (kind === "library" || (kind === "contract" && name.endsWith("System"))) {
-      visit(node, {
-        MemberAccess(node: MemberAccess) {
-          const { expression, memberName } = node;
-          if (expression.type === "Identifier" && memberName === "sender") {
-            reporter.error(
-              node,
-              ruleId,
-              `Systems and their libraries should use "_msgSender()" or "_world()" instead of "msg.sender".`
-            );
-          }
-        },
-      });
+    this.isSystemOrLibrary = kind === "library" || (kind === "contract" && name.endsWith("System"));
+  }
+
+  "ContractDefinition:exit"() {
+    this.isSystemOrLibrary = false;
+  }
+
+  MemberAccess(node: MemberAccess) {
+    const { expression, memberName } = node;
+    if (expression.type === "Identifier" && memberName === "sender") {
+      this.reporter.error(
+        node,
+        this.ruleId,
+        `Systems and their libraries should use "_msgSender()" or "_world()" instead of "msg.sender".`
+      );
     }
   }
 }

package/src/rules/SystemFileName.ts

@@ -0,0 +1,53 @@
+import path from "path";
+import { visit } from "@solidity-parser/parser";
+import type { ContractDefinition, SourceUnit } from "@solidity-parser/parser/dist/src/ast-types";
+import { SolhintRule } from "../solhintTypes";
+
+export class SystemFileName implements SolhintRule {
+  ruleId = "system-file-name";
+  reporter: any;
+  config: any;
+
+  expectedContractName: string;
+  isSystemFile = false;
+
+  constructor(reporter: any, config: any, inputSrc: string, fileName: string) {
+    this.reporter = reporter;
+    this.config = config;
+
+    this.expectedContractName = path.basename(fileName, ".sol");
+    if (
+      this.expectedContractName.endsWith("System") &&
+      this.expectedContractName !== "System" &&
+      !this.expectedContractName.match(/^I[A-Z]/)
+    ) {
+      this.isSystemFile = true;
+    }
+  }
+
+  SourceUnit(node: SourceUnit) {
+    // only systems need a matching contract
+    if (!this.isSystemFile) return;
+    const expectedContractName = this.expectedContractName;
+
+    // search the source file for a matching contract name
+    let withMatchingContract = false;
+    visit(node, {
+      ContractDefinition(node: ContractDefinition) {
+        const { name, kind } = node;
+
+        if (kind === "contract" && name === expectedContractName) {
+          withMatchingContract = true;
+        }
+      },
+    });
+
+    if (!withMatchingContract) {
+      this.reporter.error(
+        node,
+        this.ruleId,
+        `System file must contain a contract with a matching name "${expectedContractName}"`
+      );
+    }
+  }
+}