style(gas-report): rename mud-gas-report to gas-report (#1410)

latticexyz · Sep 7, 2023 · 9af542d · 9af542d
1 parent 4604639
commit 9af542d
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 10 deletions.
diff --git a/.changeset/tricky-carrots-talk.md b/.changeset/tricky-carrots-talk.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/gas-report": major
+---
+
+Renames `mud-gas-report` binary to `gas-report`, since it's no longer MUD specific.
diff --git a/packages/gas-report/README.md b/packages/gas-report/README.md
@@ -20,7 +20,7 @@ contract ExampleTest is Test, GasReporter {
 Then use the cli command to run tests and save the report:
 
 ```console
-pnpm mud-gas-report --save gas-report.json
+pnpm gas-report --save gas-report.json
 ```
 
-Run `pnpm mud-gas-report --help` for more details.
+Run `pnpm gas-report --help` for more details.
diff --git a/packages/gas-report/package.json b/packages/gas-report/package.json
@@ -20,13 +20,13 @@
     }
   },
   "bin": {
-    "mud-gas-report": "./dist/mud-gas-report.js"
+    "gas-report": "./dist/gas-report.js"
   },
   "scripts": {
     "build": "tsup",
     "clean": "rimraf dist",
     "dev": "tsup --watch",
-    "prepare": "mkdir -p ./dist && touch ./dist/mud-gas-report.js",
+    "prepare": "mkdir -p ./dist && touch ./dist/gas-report.js",
     "test": "vitest typecheck --run --passWithNoTests && vitest --run --passWithNoTests && forge test",
     "test:ci": "pnpm run test"
   },

diff --git a/packages/gas-report/ts/mud-gas-report.ts → packages/gas-report/ts/gas-report.ts b/packages/gas-report/ts/mud-gas-report.ts → packages/gas-report/ts/gas-report.ts
@@ -10,11 +10,11 @@ import chalk from "chalk";
 dotenv.config();
 
 // $0 makes this a default command (as opposed to a sub-command),
-// which replaces `mud-gas-report gas-report` with just `mud-gas-report`
+// which replaces `gas-report gas-report` with just `gas-report`
 gasReport.command = "$0";
 
 yargs(hideBin(process.argv))
-  .scriptName("mud-gas-report")
+  .scriptName("gas-report")
   // Use the commands directory to scaffold
   // eslint-disable-next-line @typescript-eslint/no-explicit-any -- command array overload isn't typed, see https://github.com/yargs/yargs/blob/main/docs/advanced.md#esm-hierarchy
   .command(gasReport as any)

diff --git a/packages/gas-report/tsup.config.ts b/packages/gas-report/tsup.config.ts
@@ -1,7 +1,7 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
-  entry: ["ts/index.ts", "ts/mud-gas-report.ts"],
+  entry: ["ts/index.ts", "ts/gas-report.ts"],
   target: "esnext",
   format: ["esm"],
   dts: false,

diff --git a/packages/schema-type/package.json b/packages/schema-type/package.json
@@ -29,7 +29,7 @@
     "clean": "pnpm run clean:js",
     "clean:js": "rimraf dist/typescript",
     "dev": "tsup --watch",
-    "gas-report": "mud-gas-report --save gas-report.json",
+    "gas-report": "gas-report --save gas-report.json",
     "test": "vitest typecheck --run && vitest --run && forge test",
     "test:ci": "pnpm run test"
   },

diff --git a/packages/store/package.json b/packages/store/package.json
@@ -45,7 +45,7 @@
     "clean:js": "rimraf dist",
     "clean:mud": "rimraf src/codegen",
     "dev": "tsup --watch",
-    "gas-report": "mud-gas-report --save gas-report.json",
+    "gas-report": "gas-report --save gas-report.json",
     "lint": "solhint --config ./.solhint.json 'src/**/*.sol'",
     "test": "vitest typecheck --run && vitest --run --passWithNoTests && forge test",
     "test:ci": "pnpm run test"

diff --git a/packages/world/package.json b/packages/world/package.json
@@ -40,7 +40,7 @@
     "clean:js": "rimraf dist",
     "clean:mud": "rimraf src/codegen",
     "dev": "tsup --watch",
-    "gas-report": "mud-gas-report --save gas-report.json",
+    "gas-report": "gas-report --save gas-report.json",
     "lint": "solhint --config ./.solhint.json 'src/**/*.sol'",
     "test": "tsc --noEmit && vitest --run && forge test",
     "test:ci": "pnpm run test"