diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d3b3be15de9..345b70bd039 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -86,6 +86,7 @@ /packages/controller-utils @MetaMask/core-platform /packages/eth-json-rpc-middleware @MetaMask/core-platform /packages/messenger @MetaMask/core-platform +/packages/messenger-cli @MetaMask/core-platform /packages/sample-controllers @MetaMask/core-platform /packages/polling-controller @MetaMask/core-platform /packages/preferences-controller @MetaMask/core-platform diff --git a/.github/workflows/lint-build-test.yml b/.github/workflows/lint-build-test.yml index dc16d6e8d45..4422d670ee6 100644 --- a/.github/workflows/lint-build-test.yml +++ b/.github/workflows/lint-build-test.yml @@ -38,7 +38,7 @@ jobs: - constraints - lint:dependencies - lint:teams - - generate-method-action-types:check + - messenger-action-types:check - readme-content:check steps: - name: Checkout and setup environment diff --git a/README.md b/README.md index bc1d9b20302..352fec4e6ec 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ Each package in this repository has its own README where you can find installati - [`@metamask/logging-controller`](packages/logging-controller) - [`@metamask/message-manager`](packages/message-manager) - [`@metamask/messenger`](packages/messenger) +- [`@metamask/messenger-cli`](packages/messenger-cli) - [`@metamask/money-account-controller`](packages/money-account-controller) - [`@metamask/multichain-account-service`](packages/multichain-account-service) - [`@metamask/multichain-api-middleware`](packages/multichain-api-middleware) @@ -149,6 +150,7 @@ linkStyle default opacity:0.5 logging_controller(["@metamask/logging-controller"]); message_manager(["@metamask/message-manager"]); messenger(["@metamask/messenger"]); + messenger_cli(["@metamask/messenger-cli"]); money_account_controller(["@metamask/money-account-controller"]); multichain_account_service(["@metamask/multichain-account-service"]); multichain_api_middleware(["@metamask/multichain-api-middleware"]); diff --git a/docs/code-guidelines/controller-guidelines.md b/docs/code-guidelines/controller-guidelines.md index fd59467d9e1..6367a1a50d7 100644 --- a/docs/code-guidelines/controller-guidelines.md +++ b/docs/code-guidelines/controller-guidelines.md @@ -457,7 +457,7 @@ Instead, you can follow this process: 1. Define a constant in your controller file called `MESSENGER_EXPOSED_METHODS`, listing the methods you want to expose. 2. Remove manual action registrations; instead, call `registerMethodActionHandlers` and pass `MESSENGER_EXPOSED_METHODS`. -3. Remove messenger action types; instead, run `yarn generate-method-action-types`. This will create a file called `${ControllerName}-method-action-types.ts`, which exports a type called `${ControllerName}MethodActions`. +3. Remove messenger action types; instead, run `yarn messenger-action-types:generate`. This will create a file called `${ControllerName}-method-action-types.ts`, which exports a type called `${ControllerName}MethodActions`. 4. Import `${ControllerName}-method-action-types.ts` in your controller file, and add `${ControllerName}MethodActions` to `${ControllerName}Actions`. 5. Export the action types from `${ControllerName}-method-action-types.ts` in your package's `index.ts` file. Do **not** export the `${ControllerName}MethodActions` type. diff --git a/eslint.config.mjs b/eslint.config.mjs index e1dbfdb5c2d..492f1c99c3c 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -293,6 +293,12 @@ const config = createConfig([ 'import-x/no-nodejs-modules': 'off', }, }, + { + files: ['packages/messenger-cli/src/**/*.{js,ts}'], + rules: { + 'import-x/no-nodejs-modules': 'off', + }, + }, { files: [ 'packages/notification-services-controller/src/NotificationServicesPushController/services/push/*-web.ts', diff --git a/package.json b/package.json index c728851afa5..008bc1deaa9 100644 --- a/package.json +++ b/package.json @@ -21,16 +21,16 @@ "changelog:update": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:update", "changelog:validate": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:validate", "create-package": "tsx scripts/create-package", - "generate-method-action-types": "yarn workspaces foreach --all --parallel --interlaced --verbose run generate-method-action-types", - "generate-method-action-types:check": "yarn generate-method-action-types --check", - "lint": "yarn lint:eslint && echo && yarn lint:misc --check && yarn constraints && yarn lint:dependencies && yarn lint:teams && yarn generate-method-action-types --check && yarn readme-content:check", + "lint": "yarn lint:eslint && echo && yarn lint:misc --check && yarn constraints && yarn lint:dependencies && yarn lint:teams && yarn messenger-action-types:check && yarn readme-content:check", "lint:dependencies": "depcheck && yarn dedupe --check", "lint:dependencies:fix": "depcheck && yarn dedupe", "lint:eslint": "yarn build:only-clean && NODE_OPTIONS='--max-old-space-size=6144' yarn eslint", - "lint:fix": "yarn lint:eslint --fix --prune-suppressions && echo && yarn lint:misc --write && yarn constraints --fix && yarn lint:dependencies:fix && yarn generate-method-action-types --fix && yarn readme-content:update", + "lint:fix": "yarn lint:eslint --fix --prune-suppressions && echo && yarn lint:misc --write && yarn constraints --fix && yarn lint:dependencies:fix && yarn messenger-action-types:generate && yarn readme-content:update", "lint:misc": "prettier --no-error-on-unmatched-pattern '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' '!merged-packages/**' --ignore-path .gitignore", "lint:misc:check": "yarn lint:misc --check", "lint:teams": "tsx scripts/lint-teams-json.ts", + "messenger-action-types:check": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run messenger-action-types:check", + "messenger-action-types:generate": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run messenger-action-types:generate", "prepack": "./scripts/prepack.sh", "prepare-preview-builds": "./scripts/prepare-preview-builds.sh", "readme-content:check": "tsx scripts/update-readme-content.ts --check", diff --git a/packages/account-tree-controller/package.json b/packages/account-tree-controller/package.json index 913d5c6e8b8..8e6af493650 100644 --- a/packages/account-tree-controller/package.json +++ b/packages/account-tree-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/account-tree-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/account-tree-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/accounts-controller/package.json b/packages/accounts-controller/package.json index 3e68ed75441..4eec1f613d5 100644 --- a/packages/accounts-controller/package.json +++ b/packages/accounts-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/accounts-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/accounts-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/address-book-controller/package.json b/packages/address-book-controller/package.json index 2163d205592..3fc1d59c275 100644 --- a/packages/address-book-controller/package.json +++ b/packages/address-book-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/address-book-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/address-book-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/analytics-controller/package.json b/packages/analytics-controller/package.json index 964e7114785..9f3c2cd10d1 100644 --- a/packages/analytics-controller/package.json +++ b/packages/analytics-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/analytics-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/analytics-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/analytics-data-regulation-controller/package.json b/packages/analytics-data-regulation-controller/package.json index 9b397773c7e..42406b574b1 100644 --- a/packages/analytics-data-regulation-controller/package.json +++ b/packages/analytics-data-regulation-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/analytics-data-regulation-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/analytics-data-regulation-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/announcement-controller/package.json b/packages/announcement-controller/package.json index 5d345be8e2d..d706622f94f 100644 --- a/packages/announcement-controller/package.json +++ b/packages/announcement-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/announcement-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/announcement-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/approval-controller/package.json b/packages/approval-controller/package.json index d74a42ea293..caf1061ea55 100644 --- a/packages/approval-controller/package.json +++ b/packages/approval-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/approval-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/approval-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/assets-controller/package.json b/packages/assets-controller/package.json index a0c02ecc311..1d5e165dfcc 100644 --- a/packages/assets-controller/package.json +++ b/packages/assets-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/assets-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/assets-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/assets-controllers/package.json b/packages/assets-controllers/package.json index 509696eb624..6411d62a090 100644 --- a/packages/assets-controllers/package.json +++ b/packages/assets-controllers/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/assets-controllers", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/assets-controllers", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/base-data-service/package.json b/packages/base-data-service/package.json index 6886dde1bb2..da59d32ec6c 100644 --- a/packages/base-data-service/package.json +++ b/packages/base-data-service/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/base-data-service", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/base-data-service", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "publish:preview": "yarn npm publish --tag preview", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", diff --git a/packages/claims-controller/package.json b/packages/claims-controller/package.json index 8c179f0edcf..16f0aaf26f6 100644 --- a/packages/claims-controller/package.json +++ b/packages/claims-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/claims-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/claims-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/client-controller/package.json b/packages/client-controller/package.json index b362d692810..3b5dff8de45 100644 --- a/packages/client-controller/package.json +++ b/packages/client-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/client-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/client-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/compliance-controller/package.json b/packages/compliance-controller/package.json index 990c373b4b5..e1dd2b5c2b1 100644 --- a/packages/compliance-controller/package.json +++ b/packages/compliance-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/compliance-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/compliance-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/config-registry-controller/package.json b/packages/config-registry-controller/package.json index ad0ef27874c..1a358cd7227 100644 --- a/packages/config-registry-controller/package.json +++ b/packages/config-registry-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/config-registry-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/config-registry-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "publish:preview": "yarn npm publish --tag preview", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", diff --git a/packages/connectivity-controller/package.json b/packages/connectivity-controller/package.json index 4544cdd7429..6ceb8dce03b 100644 --- a/packages/connectivity-controller/package.json +++ b/packages/connectivity-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/connectivity-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/connectivity-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/core-backend/package.json b/packages/core-backend/package.json index 28de51c2cc1..4ddf48690e5 100644 --- a/packages/core-backend/package.json +++ b/packages/core-backend/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/core-backend", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/core-backend", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/delegation-controller/package.json b/packages/delegation-controller/package.json index d109f833aa9..537388616c8 100644 --- a/packages/delegation-controller/package.json +++ b/packages/delegation-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/delegation-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/delegation-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/earn-controller/package.json b/packages/earn-controller/package.json index e852c001825..460697228a0 100644 --- a/packages/earn-controller/package.json +++ b/packages/earn-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/earn-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/earn-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/ens-controller/package.json b/packages/ens-controller/package.json index 3df46a600b7..5c6a53eebcf 100644 --- a/packages/ens-controller/package.json +++ b/packages/ens-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/ens-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/ens-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/gas-fee-controller/package.json b/packages/gas-fee-controller/package.json index db5d9a0677c..cfcbe9d9d38 100644 --- a/packages/gas-fee-controller/package.json +++ b/packages/gas-fee-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/gas-fee-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/gas-fee-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/gator-permissions-controller/package.json b/packages/gator-permissions-controller/package.json index d43da7af8d5..710fcc6034e 100644 --- a/packages/gator-permissions-controller/package.json +++ b/packages/gator-permissions-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/gator-permissions-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/gator-permissions-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/geolocation-controller/package.json b/packages/geolocation-controller/package.json index 119390c884f..9b40485693c 100644 --- a/packages/geolocation-controller/package.json +++ b/packages/geolocation-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/geolocation-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/geolocation-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/logging-controller/package.json b/packages/logging-controller/package.json index 6f845bddd8b..eb580bfd4d4 100644 --- a/packages/logging-controller/package.json +++ b/packages/logging-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/logging-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/logging-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/messenger-cli/CHANGELOG.md b/packages/messenger-cli/CHANGELOG.md new file mode 100644 index 00000000000..7558ff7a52a --- /dev/null +++ b/packages/messenger-cli/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Initial release, extracted from `@metamask/messenger` ([#8378](https://github.com/MetaMask/core/pull/8378)) + - CLI tool for generating TypeScript action type files for controllers and services that define `MESSENGER_EXPOSED_METHODS`. + - Available as a CLI binary (`messenger-action-types`). + +[Unreleased]: https://github.com/MetaMask/core/ diff --git a/packages/messenger-cli/LICENSE b/packages/messenger-cli/LICENSE new file mode 100644 index 00000000000..c8a0ff6be3a --- /dev/null +++ b/packages/messenger-cli/LICENSE @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) 2026 MetaMask + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE diff --git a/packages/messenger-cli/README.md b/packages/messenger-cli/README.md new file mode 100644 index 00000000000..428c915c8d1 --- /dev/null +++ b/packages/messenger-cli/README.md @@ -0,0 +1,15 @@ +# `@metamask/messenger-cli` + +CLI tools for the MetaMask messenger system + +## Installation + +`yarn add @metamask/messenger-cli` + +or + +`npm install @metamask/messenger-cli` + +## Contributing + +This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme). diff --git a/packages/messenger-cli/jest.config.js b/packages/messenger-cli/jest.config.js new file mode 100644 index 00000000000..d29f3f6c0db --- /dev/null +++ b/packages/messenger-cli/jest.config.js @@ -0,0 +1,29 @@ +/* + * For a detailed explanation regarding each configuration property and type check, visit: + * https://jestjs.io/docs/configuration + */ + +const merge = require('deepmerge'); +const path = require('path'); + +const baseConfig = require('../../jest.config.packages'); + +const displayName = path.basename(__dirname); + +module.exports = merge(baseConfig, { + // The display name when running multiple projects + displayName, + + // cli.ts is tested via execa subprocess in cli.test.ts; Jest can't instrument it + coveragePathIgnorePatterns: ['./src/cli.ts'], + + // An object that configures minimum threshold enforcement for coverage results + coverageThreshold: { + global: { + branches: 100, + functions: 100, + lines: 100, + statements: 100, + }, + }, +}); diff --git a/packages/messenger-cli/package.json b/packages/messenger-cli/package.json new file mode 100644 index 00000000000..33cd39767f1 --- /dev/null +++ b/packages/messenger-cli/package.json @@ -0,0 +1,68 @@ +{ + "name": "@metamask/messenger-cli", + "version": "0.0.0", + "description": "CLI tools for the MetaMask messenger system", + "keywords": [ + "MetaMask", + "Ethereum" + ], + "homepage": "https://github.com/MetaMask/core/tree/main/packages/messenger-cli#readme", + "bugs": { + "url": "https://github.com/MetaMask/core/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/MetaMask/core.git" + }, + "license": "MIT", + "sideEffects": false, + "bin": { + "messenger-action-types": "./dist/cli.mjs" + }, + "files": [ + "dist/" + ], + "scripts": { + "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references", + "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean", + "changelog:update": "../../scripts/update-changelog.sh @metamask/messenger-cli", + "changelog:validate": "../../scripts/validate-changelog.sh @metamask/messenger-cli", + "since-latest-release": "../../scripts/since-latest-release.sh", + "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", + "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", + "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose", + "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch" + }, + "dependencies": { + "@metamask/utils": "^11.9.0", + "yargs": "^17.7.2" + }, + "devDependencies": { + "@metamask/auto-changelog": "^3.4.4", + "@ts-bridge/cli": "^0.6.4", + "@types/jest": "^29.5.14", + "@types/yargs": "^17.0.32", + "deepmerge": "^4.2.2", + "eslint": "^9.39.1", + "execa": "^5.0.0", + "jest": "^29.7.0", + "ts-jest": "^29.2.5", + "typescript": "~5.3.3" + }, + "peerDependencies": { + "eslint": ">=8", + "typescript": ">=5.0.0" + }, + "peerDependenciesMeta": { + "eslint": { + "optional": true + } + }, + "engines": { + "node": "^18.18 || >=20" + }, + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org/" + } +} diff --git a/packages/messenger-cli/src/check.test.ts b/packages/messenger-cli/src/check.test.ts new file mode 100644 index 00000000000..b46e0682242 --- /dev/null +++ b/packages/messenger-cli/src/check.test.ts @@ -0,0 +1,154 @@ +import { createSandbox } from '@metamask/utils/node'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; + +import { checkActionTypesFiles } from './check'; +import { generateActionTypesContent } from './generate-content'; +import type { SourceInfo } from './parse-source'; + +const { withinSandbox } = createSandbox('messenger/check-action-types'); + +describe('checkActionTypesFiles', () => { + it('reports up to date when files match (no ESLint)', async () => { + expect.assertions(1); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + const content = generateActionTypesContent(controller); + await fs.promises.writeFile( + path.join(directoryPath, 'TestController-method-action-types.ts'), + content, + 'utf8', + ); + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + const result = await checkActionTypesFiles([controller], null); + consoleSpy.mockRestore(); + + expect(result).toBe(true); + }); + }); + + it('reports out of date when files differ', async () => { + expect.assertions(1); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + await fs.promises.writeFile( + path.join(directoryPath, 'TestController-method-action-types.ts'), + '// outdated content\n', + 'utf8', + ); + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + const result = await checkActionTypesFiles([controller], null); + consoleSpy.mockRestore(); + consoleErrorSpy.mockRestore(); + + expect(result).toBe(false); + }); + }); + + it('reports missing files', async () => { + expect.assertions(1); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + const result = await checkActionTypesFiles([controller], null); + consoleSpy.mockRestore(); + consoleErrorSpy.mockRestore(); + + expect(result).toBe(false); + }); + }); + + it('reports non-ENOENT errors when accessing files', async () => { + expect.assertions(2); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + // Mock fs.promises.access to throw a non-ENOENT error + const accessSpy = jest + .spyOn(fs.promises, 'access') + .mockRejectedValue( + Object.assign(new Error('EPERM'), { code: 'EPERM' }), + ); + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + const result = await checkActionTypesFiles([controller], null); + + expect(consoleErrorSpy).toHaveBeenCalledWith( + expect.stringContaining('Error reading'), + expect.anything(), + ); + expect(result).toBe(false); + + accessSpy.mockRestore(); + consoleSpy.mockRestore(); + consoleErrorSpy.mockRestore(); + }); + }); + + it('uses ESLint when provided', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + const content = generateActionTypesContent(controller); + await fs.promises.writeFile( + path.join(directoryPath, 'TestController-method-action-types.ts'), + content, + 'utf8', + ); + + const mockEslint = { + instance: { lintFiles: jest.fn().mockResolvedValue([]) }, + eslintClass: { + outputFixes: jest.fn().mockResolvedValue(undefined), + }, + }; + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + const result = await checkActionTypesFiles([controller], mockEslint); + consoleSpy.mockRestore(); + + expect(mockEslint.instance.lintFiles).toHaveBeenCalled(); + expect(mockEslint.eslintClass.outputFixes).toHaveBeenCalled(); + expect(result).toBe(true); + }); + }); +}); diff --git a/packages/messenger-cli/src/check.ts b/packages/messenger-cli/src/check.ts new file mode 100644 index 00000000000..b635fdacedc --- /dev/null +++ b/packages/messenger-cli/src/check.ts @@ -0,0 +1,115 @@ +import * as fs from 'node:fs'; +import * as path from 'node:path'; + +import { generateActionTypesContent } from './generate-content'; +import type { SourceInfo } from './parse-source'; +import type { ESLint } from './types'; + +/** + * Checks if generated action types files are up to date. + * + * @param sources - Array of source information objects. + * @param eslint - Optional ESLint instance and static methods for formatting. + * @returns Whether all files are up to date. + */ +export async function checkActionTypesFiles( + sources: SourceInfo[], + eslint: ESLint | null, +): Promise { + let hasErrors = false; + + const fileComparisonJobs: { + expectedTempFile: string; + actualFile: string; + baseFileName: string; + }[] = []; + + try { + for (const source of sources) { + console.log(`\nšŸ”§ Checking ${source.name}...`); + const outputDir = path.dirname(source.filePath); + const baseFileName = path.basename(source.filePath, '.ts'); + const actualFile = path.join( + outputDir, + `${baseFileName}-method-action-types.ts`, + ); + + const expectedContent = generateActionTypesContent(source); + const expectedTempFile = actualFile.replace('.ts', '.tmp.ts'); + + try { + await fs.promises.access(actualFile); + + await fs.promises.writeFile(expectedTempFile, expectedContent, 'utf8'); + + fileComparisonJobs.push({ + expectedTempFile, + actualFile, + baseFileName, + }); + } catch (error) { + if ((error as NodeJS.ErrnoException).code === 'ENOENT') { + console.error( + `āŒ ${baseFileName}-method-action-types.ts does not exist`, + ); + } else { + console.error( + `āŒ Error reading ${baseFileName}-method-action-types.ts:`, + error, + ); + } + hasErrors = true; + } + } + + if (fileComparisonJobs.length > 0) { + if (eslint) { + console.log('\nšŸ“ Running ESLint to compare files...'); + + const results = await eslint.instance.lintFiles( + fileComparisonJobs.map((job) => job.expectedTempFile), + ); + await eslint.eslintClass.outputFixes(results); + } + + for (const job of fileComparisonJobs) { + const expectedContent = await fs.promises.readFile( + job.expectedTempFile, + 'utf8', + ); + const actualContent = await fs.promises.readFile( + job.actualFile, + 'utf8', + ); + + if (expectedContent === actualContent) { + console.log( + `āœ… ${job.baseFileName}-method-action-types.ts is up to date`, + ); + } else { + console.error( + `āŒ ${job.baseFileName}-method-action-types.ts is out of date`, + ); + hasErrors = true; + } + } + } + } finally { + for (const job of fileComparisonJobs) { + try { + await fs.promises.unlink(job.expectedTempFile); + } catch { + // Ignore cleanup errors + } + } + } + + if (hasErrors) { + console.error('\nšŸ’„ Some action type files are out of date or missing.'); + console.error('Run `messenger-action-types --generate` to update them.'); + return false; + } + + console.log('\nšŸŽ‰ All action type files are up to date!'); + return true; +} diff --git a/packages/messenger-cli/src/cli.test.ts b/packages/messenger-cli/src/cli.test.ts new file mode 100644 index 00000000000..bd7b658f14e --- /dev/null +++ b/packages/messenger-cli/src/cli.test.ts @@ -0,0 +1,504 @@ +import { createSandbox } from '@metamask/utils/node'; +import execa from 'execa'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; + +const ROOT_DIR = path.resolve(__dirname, '..', '..', '..'); +const TSX_PATH = path.join(ROOT_DIR, 'node_modules', '.bin', 'tsx'); +const CLI_PATH = path.join( + ROOT_DIR, + 'packages', + 'messenger-cli', + 'src', + 'cli.ts', +); + +/** + * Runs the CLI with the given arguments. + * + * @param args - The CLI arguments. + * @returns The execa result. + */ +async function runCLI(args: string[]): Promise { + return await execa(TSX_PATH, [CLI_PATH, ...args], { + cwd: ROOT_DIR, + reject: false, + all: true, + }); +} + +/** + * Recursively lists generated `-method-action-types.ts` files in a directory. + * + * @param dir - The directory to search. + * @returns Sorted list of relative paths to generated files. + */ +async function listGeneratedFiles(dir: string): Promise { + const results: string[] = []; + + async function walk(current: string): Promise { + const entries = await fs.promises.readdir(current, { withFileTypes: true }); + for (const entry of entries) { + const fullPath = path.join(current, entry.name); + if (entry.isDirectory()) { + await walk(fullPath); + } else if (entry.name.endsWith('-method-action-types.ts')) { + results.push(path.relative(dir, fullPath)); + } + } + } + + await walk(dir); + return results.sort(); +} + +const { withinSandbox } = createSandbox('messenger/cli-functional'); + +jest.setTimeout(30_000); + +describe('generate-action-types CLI (functional)', () => { + describe('--generate', () => { + it('generates FooController-method-action-types.ts for a controller with multiple documented methods', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'FooController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['getState', 'reset'] as const; + +class FooController { + /** + * Gets the current state. + */ + getState() { + return {}; + } + + /** + * Resets the controller. + */ + reset() { + return; + } +} +`, + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([ + 'FooController-method-action-types.ts', + ]); + + const content = await fs.promises.readFile( + path.join(directoryPath, 'FooController-method-action-types.ts'), + 'utf8', + ); + expect(content).toBe(`/** + * This file is auto generated. + * Do not edit manually. + */ + +import type { FooController } from './FooController'; + +/** + * Gets the current state. + */ +export type FooControllerGetStateAction = { + type: \`FooController:getState\`; + handler: FooController['getState']; +}; + +/** + * Resets the controller. + */ +export type FooControllerResetAction = { + type: \`FooController:reset\`; + handler: FooController['reset']; +}; + +/** + * Union of all FooController action types. + */ +export type FooControllerMethodActions = FooControllerGetStateAction | FooControllerResetAction; +`); + }); + }); + + it('generates DataService-method-action-types.ts for a service with JSDoc containing @param and @returns', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'DataService.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['fetchItems'] as const; + +class DataService { + /** + * Fetches items from the API. + * + * @returns The items. + */ + fetchItems() { + return []; + } +} +`, + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([ + 'DataService-method-action-types.ts', + ]); + + const content = await fs.promises.readFile( + path.join(directoryPath, 'DataService-method-action-types.ts'), + 'utf8', + ); + expect(content).toBe(`/** + * This file is auto generated. + * Do not edit manually. + */ + +import type { DataService } from './DataService'; + +/** + * Fetches items from the API. + * + * @returns The items. + */ +export type DataServiceFetchItemsAction = { + type: \`DataService:fetchItems\`; + handler: DataService['fetchItems']; +}; + +/** + * Union of all DataService action types. + */ +export type DataServiceMethodActions = DataServiceFetchItemsAction; +`); + }); + }); + + it('generates correct types for a controller with many methods without JSDoc', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'BarController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['enable', 'disable', 'isEnabled'] as const; + +class BarController { + enable() { return; } + disable() { return; } + isEnabled() { return true; } +} +`, + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([ + 'BarController-method-action-types.ts', + ]); + + const content = await fs.promises.readFile( + path.join(directoryPath, 'BarController-method-action-types.ts'), + 'utf8', + ); + expect(content).toBe(`/** + * This file is auto generated. + * Do not edit manually. + */ + +import type { BarController } from './BarController'; + +export type BarControllerEnableAction = { + type: \`BarController:enable\`; + handler: BarController['enable']; +}; + +export type BarControllerDisableAction = { + type: \`BarController:disable\`; + handler: BarController['disable']; +}; + +export type BarControllerIsEnabledAction = { + type: \`BarController:isEnabled\`; + handler: BarController['isEnabled']; +}; + +/** + * Union of all BarController action types. + */ +export type BarControllerMethodActions = BarControllerEnableAction | BarControllerDisableAction | BarControllerIsEnabledAction; +`); + }); + }); + + it('generates AuthService-method-action-types.ts for a service with @param and @returns JSDoc', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'AuthService.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['authenticate'] as const; + +class AuthService { + /** + * Authenticates the user. + * + * @param token - The auth token. + * @returns Whether authentication succeeded. + */ + authenticate(token: string) { + return token.length > 0; + } +} +`, + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([ + 'AuthService-method-action-types.ts', + ]); + + const content = await fs.promises.readFile( + path.join(directoryPath, 'AuthService-method-action-types.ts'), + 'utf8', + ); + expect(content).toBe(`/** + * This file is auto generated. + * Do not edit manually. + */ + +import type { AuthService } from './AuthService'; + +/** + * Authenticates the user. + * + * @param token - The auth token. + * @returns Whether authentication succeeded. + */ +export type AuthServiceAuthenticateAction = { + type: \`AuthService:authenticate\`; + handler: AuthService['authenticate']; +}; + +/** + * Union of all AuthService action types. + */ +export type AuthServiceMethodActions = AuthServiceAuthenticateAction; +`); + }); + }); + + it('generates separate files for both a controller and service in the same directory', async () => { + expect.assertions(8); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'MyController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doWork'] as const; +class MyController { + doWork() { return true; } +} +`, + 'utf8', + ); + await fs.promises.writeFile( + path.join(directoryPath, 'MyService.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['query'] as const; +class MyService { + query() { return []; } +} +`, + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([ + 'MyController-method-action-types.ts', + 'MyService-method-action-types.ts', + ]); + + const controllerContent = await fs.promises.readFile( + path.join(directoryPath, 'MyController-method-action-types.ts'), + 'utf8', + ); + expect(controllerContent).toContain('MyControllerDoWorkAction'); + expect(controllerContent).toContain("handler: MyController['doWork']"); + expect(controllerContent).toContain('MyControllerMethodActions'); + + const serviceContent = await fs.promises.readFile( + path.join(directoryPath, 'MyService-method-action-types.ts'), + 'utf8', + ); + expect(serviceContent).toContain('MyServiceQueryAction'); + expect(serviceContent).toContain("handler: MyService['query']"); + expect(serviceContent).toContain('MyServiceMethodActions'); + }); + }); + + it('discovers and generates files for sources in nested subdirectories', async () => { + expect.assertions(4); + + await withinSandbox(async ({ directoryPath }) => { + const subDir = path.join(directoryPath, 'nested'); + await fs.promises.mkdir(subDir); + await fs.promises.writeFile( + path.join(subDir, 'NestedController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doNested'] as const; +class NestedController { + doNested() { return 'nested'; } +} +`, + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([ + path.join('nested', 'NestedController-method-action-types.ts'), + ]); + + const content = await fs.promises.readFile( + path.join(subDir, 'NestedController-method-action-types.ts'), + 'utf8', + ); + expect(content).toContain('NestedControllerDoNestedAction'); + expect(content).toContain("handler: NestedController['doNested']"); + }); + }); + + it('warns and generates no files when no sources are found', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'empty.ts'), + 'export const foo = 1;', + 'utf8', + ); + + const result = await runCLI(['--generate', directoryPath]); + expect(result.exitCode).toBe(0); + expect(result.all).toContain('No controllers/services found'); + + const generatedFiles = await listGeneratedFiles(directoryPath); + expect(generatedFiles).toStrictEqual([]); + }); + }); + }); + + describe('--check', () => { + it('exits 0 when generated files are up to date', async () => { + expect.assertions(2); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'TestController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const; +class TestController { + doStuff() { return true; } +} +`, + 'utf8', + ); + + await runCLI(['--generate', directoryPath]); + const result = await runCLI(['--check', directoryPath]); + + expect(result.exitCode).toBe(0); + expect(result.all).toContain('up to date'); + }); + }); + + it('exits 1 when generated files are out of date', async () => { + expect.assertions(2); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'TestController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const; +class TestController { + doStuff() { return true; } +} +`, + 'utf8', + ); + await fs.promises.writeFile( + path.join(directoryPath, 'TestController-method-action-types.ts'), + '// outdated\n', + 'utf8', + ); + + const result = await runCLI(['--check', directoryPath]); + + expect(result.exitCode).toBe(1); + expect(result.all).toContain('out of date'); + }); + }); + + it('exits 1 when generated files are missing', async () => { + expect.assertions(2); + + await withinSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'TestController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const; +class TestController { + doStuff() { return true; } +} +`, + 'utf8', + ); + + const result = await runCLI(['--check', directoryPath]); + + expect(result.exitCode).toBe(1); + expect(result.all).toContain('does not exist'); + }); + }); + }); + + describe('argument validation', () => { + it('exits 1 when neither --check nor --fix is provided', async () => { + expect.assertions(1); + + await withinSandbox(async ({ directoryPath }) => { + const result = await runCLI([directoryPath]); + expect(result.exitCode).toBe(1); + }); + }); + }); +}); diff --git a/packages/messenger-cli/src/cli.ts b/packages/messenger-cli/src/cli.ts new file mode 100644 index 00000000000..6d040461ca2 --- /dev/null +++ b/packages/messenger-cli/src/cli.ts @@ -0,0 +1,139 @@ +#!/usr/bin/env node + +import yargs from 'yargs'; + +import { checkActionTypesFiles } from './check'; +import { generateAllActionTypesFiles } from './fix'; +import { findSourcesWithExposedMethods } from './parse-source'; +import type { ESLint } from './types'; + +type CommandLineArguments = { + check: boolean; + generate: boolean; + sourcePath: string; +}; + +/** + * Parses the given CLI arguments. + * + * @param args - The arguments to parse. + * @returns The parsed command line arguments. + */ +async function parseCommandLineArguments( + args: string[], +): Promise { + const { + check, + generate, + path: sourcePath, + } = await yargs(args) + .command( + '$0 [path]', + 'Generate method action types for controller and service messengers', + (yargsInstance) => { + yargsInstance.positional('path', { + type: 'string', + description: + 'Path to the folder where controllers/services are located', + default: 'src', + }); + }, + ) + .option('check', { + type: 'boolean', + description: 'Check if generated action type files are up to date', + default: false, + }) + .option('generate', { + type: 'boolean', + description: 'Generate/update action type files', + default: false, + }) + .help() + .check((argv) => { + if (!argv.check && !argv.generate) { + throw new Error('Either --check or --generate must be provided.\n'); + } + return true; + }).argv; + + return { + check, + generate, + sourcePath: sourcePath as string, + }; +} + +/** + * Attempt to load ESLint from the current project. Returns null if unavailable. + * + * @returns An ESLint object with instance and static methods, or null if unavailable. + */ +async function loadESLint(): Promise { + try { + const { ESLint: ESLintClass } = await import('eslint'); + const instance = new ESLintClass({ + fix: true, + errorOnUnmatchedPattern: false, + }); + return { + instance, + eslintClass: ESLintClass, + }; + } catch { + console.warn( + 'āš ļø ESLint could not be loaded. Generated files will not be formatted.', + ); + return null; + } +} + +/** + * Main entry point for the CLI. + */ +async function main(): Promise { + const { generate, sourcePath } = await parseCommandLineArguments( + globalThis.process.argv.slice(2), + ); + + console.log( + 'šŸ” Searching for controllers/services with MESSENGER_EXPOSED_METHODS...', + ); + + const sources = await findSourcesWithExposedMethods(sourcePath); + + if (sources.length === 0) { + console.log( + 'āš ļø No controllers/services found with MESSENGER_EXPOSED_METHODS', + ); + return; + } + + console.log( + `šŸ“¦ Found ${sources.length} controller(s)/service(s) with exposed methods`, + ); + + const eslint = await loadESLint(); + + if (generate) { + const success = await generateAllActionTypesFiles(sources, eslint); + if (success) { + console.log('\nšŸŽ‰ All action types generated successfully!'); + } else { + // eslint-disable-next-line no-restricted-globals + process.exitCode = 1; + } + } else { + const success = await checkActionTypesFiles(sources, eslint); + if (!success) { + // eslint-disable-next-line no-restricted-globals + process.exitCode = 1; + } + } +} + +main().catch((error) => { + console.error('āŒ Script failed:', error); + // eslint-disable-next-line no-restricted-globals + process.exitCode = 1; +}); diff --git a/packages/messenger-cli/src/fix.test.ts b/packages/messenger-cli/src/fix.test.ts new file mode 100644 index 00000000000..6a318da162f --- /dev/null +++ b/packages/messenger-cli/src/fix.test.ts @@ -0,0 +1,146 @@ +import { createSandbox } from '@metamask/utils/node'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; + +import { generateAllActionTypesFiles } from './fix'; +import { generateActionTypesContent } from './generate-content'; +import type { SourceInfo } from './parse-source'; + +const { withinSandbox } = createSandbox('messenger/fix-action-types'); + +describe('generateAllActionTypesFiles', () => { + it('generates files for controllers (no ESLint)', async () => { + expect.assertions(1); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + await generateAllActionTypesFiles([controller], null); + consoleSpy.mockRestore(); + + const outputFile = path.join( + directoryPath, + 'TestController-method-action-types.ts', + ); + const content = await fs.promises.readFile(outputFile, 'utf8'); + const expected = generateActionTypesContent(controller); + + expect(content).toBe(expected); + }); + }); + + it('generates files for multiple controllers', async () => { + expect.assertions(2); + + await withinSandbox(async ({ directoryPath }) => { + const controllers: SourceInfo[] = [ + { + name: 'FooController', + filePath: path.join(directoryPath, 'FooController.ts'), + methods: [{ name: 'doFoo', jsDoc: '' }], + }, + { + name: 'BarService', + filePath: path.join(directoryPath, 'BarService.ts'), + methods: [{ name: 'doBar', jsDoc: '' }], + }, + ]; + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + await generateAllActionTypesFiles(controllers, null); + consoleSpy.mockRestore(); + + const fooFile = path.join( + directoryPath, + 'FooController-method-action-types.ts', + ); + const barFile = path.join( + directoryPath, + 'BarService-method-action-types.ts', + ); + + const fooContent = await fs.promises.readFile(fooFile, 'utf8'); + const barContent = await fs.promises.readFile(barFile, 'utf8'); + + expect(fooContent).toContain('FooController'); + expect(barContent).toContain('BarService'); + }); + }); + + it('invokes ESLint when provided', async () => { + expect.assertions(3); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + const mockEslint = { + instance: { lintFiles: jest.fn().mockResolvedValue([]) }, + eslintClass: { + outputFixes: jest.fn().mockResolvedValue(undefined), + getErrorResults: jest.fn().mockReturnValue([]), + }, + }; + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + await generateAllActionTypesFiles([controller], mockEslint); + consoleSpy.mockRestore(); + + expect(mockEslint.instance.lintFiles).toHaveBeenCalledWith([ + path.join(directoryPath, 'TestController-method-action-types.ts'), + ]); + expect(mockEslint.eslintClass.outputFixes).toHaveBeenCalled(); + expect(mockEslint.eslintClass.getErrorResults).toHaveBeenCalled(); + }); + }); + + it('returns false when ESLint reports errors', async () => { + expect.assertions(2); + + await withinSandbox(async ({ directoryPath }) => { + const controller: SourceInfo = { + name: 'TestController', + filePath: path.join(directoryPath, 'TestController.ts'), + methods: [{ name: 'doStuff', jsDoc: '' }], + }; + + const mockEslint = { + instance: { + lintFiles: jest.fn().mockResolvedValue([{ filePath: 'test.ts' }]), + }, + eslintClass: { + outputFixes: jest.fn().mockResolvedValue(undefined), + getErrorResults: jest + .fn() + .mockReturnValue([{ filePath: 'test.ts', messages: ['err'] }]), + }, + }; + + const consoleSpy = jest.spyOn(console, 'log').mockImplementation(); + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + const result = await generateAllActionTypesFiles( + [controller], + mockEslint, + ); + + expect(result).toBe(false); + expect(consoleErrorSpy).toHaveBeenCalledWith( + 'āŒ ESLint errors:', + expect.anything(), + ); + + consoleSpy.mockRestore(); + consoleErrorSpy.mockRestore(); + }); + }); +}); diff --git a/packages/messenger-cli/src/fix.ts b/packages/messenger-cli/src/fix.ts new file mode 100644 index 00000000000..25e0f3a9711 --- /dev/null +++ b/packages/messenger-cli/src/fix.ts @@ -0,0 +1,50 @@ +import * as fs from 'node:fs'; +import * as path from 'node:path'; + +import { generateActionTypesContent } from './generate-content'; +import type { SourceInfo } from './parse-source'; +import type { ESLint } from './types'; + +/** + * Generates action types files for all controllers/services. + * + * @param sources - Array of source information objects. + * @param eslint - Optional ESLint instance and static methods for formatting. + * @returns Whether all files were generated successfully. + */ +export async function generateAllActionTypesFiles( + sources: SourceInfo[], + eslint: ESLint | null, +): Promise { + const outputFiles: string[] = []; + + for (const source of sources) { + console.log(`\nšŸ”§ Processing ${source.name}...`); + const outputDir = path.dirname(source.filePath); + const baseFileName = path.basename(source.filePath, '.ts'); + const outputFile = path.join( + outputDir, + `${baseFileName}-method-action-types.ts`, + ); + + const generatedContent = generateActionTypesContent(source); + await fs.promises.writeFile(outputFile, generatedContent, 'utf8'); + outputFiles.push(outputFile); + console.log(`āœ… Generated action types for ${source.name}`); + } + + if (outputFiles.length > 0 && eslint) { + console.log('\nšŸ“ Running ESLint on generated files...'); + + const results = await eslint.instance.lintFiles(outputFiles); + await eslint.eslintClass.outputFixes(results); + const errors = eslint.eslintClass.getErrorResults(results); + if (errors.length > 0) { + console.error('āŒ ESLint errors:', errors); + return false; + } + console.log('āœ… ESLint formatting applied'); + } + + return true; +} diff --git a/packages/messenger-cli/src/generate-content.test.ts b/packages/messenger-cli/src/generate-content.test.ts new file mode 100644 index 00000000000..4636869b4d1 --- /dev/null +++ b/packages/messenger-cli/src/generate-content.test.ts @@ -0,0 +1,84 @@ +import { generateActionTypesContent } from './generate-content'; +import type { SourceInfo } from './parse-source'; + +describe('generateActionTypesContent', () => { + it('generates action types for a controller with one method', () => { + const controller: SourceInfo = { + name: 'FooController', + filePath: '/some/path/FooController.ts', + + methods: [ + { + name: 'doSomething', + jsDoc: '', + signature: 'doSomething', + }, + ], + }; + + const result = generateActionTypesContent(controller); + + expect(result).toContain('This file is auto generated.'); + expect(result).toContain( + "import type { FooController } from './FooController';", + ); + expect(result).toContain('export type FooControllerDoSomethingAction = {'); + expect(result).toContain('type: `FooController:doSomething`;'); + expect(result).toContain("handler: FooController['doSomething'];"); + expect(result).toContain( + 'export type FooControllerMethodActions = FooControllerDoSomethingAction;', + ); + }); + + it('generates action types for a controller with multiple methods', () => { + const controller: SourceInfo = { + name: 'BarController', + filePath: '/some/path/BarController.ts', + + methods: [ + { name: 'methodA', jsDoc: '' }, + { name: 'methodB', jsDoc: '' }, + ], + }; + + const result = generateActionTypesContent(controller); + + expect(result).toContain('export type BarControllerMethodAAction = {'); + expect(result).toContain('export type BarControllerMethodBAction = {'); + expect(result).toContain( + 'export type BarControllerMethodActions = BarControllerMethodAAction | BarControllerMethodBAction;', + ); + }); + + it('includes JSDoc comments when present', () => { + const controller: SourceInfo = { + name: 'FooController', + filePath: '/some/path/FooController.ts', + + methods: [ + { + name: 'doSomething', + jsDoc: '/**\n * Does something.\n */', + signature: 'doSomething', + }, + ], + }; + + const result = generateActionTypesContent(controller); + + expect(result).toContain('/**\n * Does something.\n */'); + }); + + it('generates no union type for controllers with no methods', () => { + const controller: SourceInfo = { + name: 'EmptyController', + filePath: '/some/path/EmptyController.ts', + + methods: [], + }; + + const result = generateActionTypesContent(controller); + + expect(result).not.toContain('EmptyControllerMethodActions'); + }); +}); diff --git a/packages/messenger-cli/src/generate-content.ts b/packages/messenger-cli/src/generate-content.ts new file mode 100644 index 00000000000..88fda26fba2 --- /dev/null +++ b/packages/messenger-cli/src/generate-content.ts @@ -0,0 +1,53 @@ +import * as path from 'node:path'; + +import type { SourceInfo } from './parse-source'; + +/** + * Generates the content for the action types file. + * + * @param source - The source information object (controller or service). + * @returns The content for the action types file. + */ +export function generateActionTypesContent(source: SourceInfo): string { + const baseFileName = path.basename(source.filePath, '.ts'); + const sourceImportPath = `./${baseFileName}`; + + let content = `/** + * This file is auto generated. + * Do not edit manually. + */ + +import type { ${source.name} } from '${sourceImportPath}'; + +`; + + const actionTypeNames: string[] = []; + + for (const method of source.methods) { + const capitalizedName = + method.name.charAt(0).toUpperCase() + method.name.slice(1); + const actionTypeName = `${source.name}${capitalizedName}Action`; + const actionString = `${source.name}:${method.name}`; + + actionTypeNames.push(actionTypeName); + + if (method.jsDoc) { + content += `${method.jsDoc}\n`; + } + + content += `export type ${actionTypeName} = { + type: \`${actionString}\`; + handler: ${source.name}['${method.name}']; +};\n\n`; + } + + if (actionTypeNames.length > 0) { + const unionTypeName = `${source.name}MethodActions`; + content += `/** + * Union of all ${source.name} action types. + */ +export type ${unionTypeName} = ${actionTypeNames.join(' | ')};\n`; + } + + return `${content.trimEnd()}\n`; +} diff --git a/packages/messenger-cli/src/parse-source.test.ts b/packages/messenger-cli/src/parse-source.test.ts new file mode 100644 index 00000000000..80366d4994a --- /dev/null +++ b/packages/messenger-cli/src/parse-source.test.ts @@ -0,0 +1,624 @@ +import { createSandbox } from '@metamask/utils/node'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; + +import { findSourcesWithExposedMethods, parseSourceFile } from './parse-source'; + +const { withinSandbox: withinParseSourceSandbox } = createSandbox( + 'messenger/parse-source', +); +const { withinSandbox: withinFindControllersSandbox } = createSandbox( + 'messenger/find-controllers', +); + +describe('parseSourceFile', () => { + it('extracts controller info from a file with MESSENGER_EXPOSED_METHODS', async () => { + expect.assertions(1); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join(directoryPath, 'TestController.ts'); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const; + +class TestController { + /** + * Does stuff. + */ + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).toStrictEqual({ + name: 'TestController', + filePath: controllerFile, + methods: [ + { + name: 'doStuff', + jsDoc: '/**\n * Does stuff.\n */', + }, + ], + }); + }); + }); + + it('returns null for a file without MESSENGER_EXPOSED_METHODS', async () => { + expect.assertions(1); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join(directoryPath, 'NoExposed.ts'); + await fs.promises.writeFile( + controllerFile, + ` +class NoExposedController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).toBeNull(); + }); + }); + + it('returns null for a file with empty MESSENGER_EXPOSED_METHODS', async () => { + expect.assertions(1); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join(directoryPath, 'EmptyController.ts'); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = [] as const; + +class EmptyController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).toBeNull(); + }); + }); + + it('handles array literals without as const', async () => { + expect.assertions(2); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join( + directoryPath, + 'PlainArrayController.ts', + ); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff']; + +class PlainArrayController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods.map((method) => method.name)).toStrictEqual([ + 'doStuff', + ]); + }); + }); + + it('works with Service class names', async () => { + expect.assertions(2); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const serviceFile = path.join(directoryPath, 'TestService.ts'); + await fs.promises.writeFile( + serviceFile, + ` +const MESSENGER_EXPOSED_METHODS = ['fetchData'] as const; + +class TestService { + fetchData() { + return []; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(serviceFile); + + expect(result).not.toBeNull(); + expect(result?.name).toBe('TestService'); + }); + }); + + it('extracts methods without JSDoc', async () => { + expect.assertions(2); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join(directoryPath, 'NoDocController.ts'); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const; + +class NoDocController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods[0].jsDoc).toBe(''); + }); + }); + + it('handles inherited methods via type checker', async () => { + expect.assertions(5); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + // Create a tsconfig.json so the type checker can work + await fs.promises.writeFile( + path.join(directoryPath, 'tsconfig.json'), + JSON.stringify({ + compilerOptions: { + target: 'ES2020', + module: 'commonjs', + strict: true, + }, + include: ['./*.ts'], + }), + 'utf8', + ); + + await fs.promises.writeFile( + path.join(directoryPath, 'BaseController.ts'), + ` +export class BaseController { + /** + * Base method. + */ + baseMethod() { + return 'base'; + } +} +`, + 'utf8', + ); + + const controllerFile = path.join(directoryPath, 'ChildController.ts'); + await fs.promises.writeFile( + controllerFile, + ` +import { BaseController } from './BaseController'; + +const MESSENGER_EXPOSED_METHODS = ['doStuff', 'baseMethod'] as const; + +class ChildController extends BaseController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods).toHaveLength(2); + expect(result?.methods[0].name).toBe('doStuff'); + expect(result?.methods[1].name).toBe('baseMethod'); + expect(result?.methods[1].jsDoc).toContain('Base method.'); + }); + }); + + it('handles inherited methods without JSDoc', async () => { + expect.assertions(4); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'tsconfig.json'), + JSON.stringify({ + compilerOptions: { + target: 'ES2020', + module: 'commonjs', + strict: true, + }, + include: ['./*.ts'], + }), + 'utf8', + ); + + await fs.promises.writeFile( + path.join(directoryPath, 'BaseNoDoc.ts'), + ` +export class BaseNoDoc { + baseMethod() { + return 'base'; + } +} +`, + 'utf8', + ); + + const controllerFile = path.join( + directoryPath, + 'ChildNoDocController.ts', + ); + await fs.promises.writeFile( + controllerFile, + ` +import { BaseNoDoc } from './BaseNoDoc'; + +const MESSENGER_EXPOSED_METHODS = ['doStuff', 'baseMethod'] as const; + +class ChildNoDocController extends BaseNoDoc { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods).toHaveLength(2); + expect(result?.methods[1].name).toBe('baseMethod'); + // Method without JSDoc should have empty string + expect(result?.methods[1].jsDoc).toBe(''); + }); + }); + + it('handles exposed method not found in hierarchy', async () => { + expect.assertions(4); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'tsconfig.json'), + JSON.stringify({ + compilerOptions: { + target: 'ES2020', + module: 'commonjs', + strict: true, + }, + include: ['./*.ts'], + }), + 'utf8', + ); + + const controllerFile = path.join( + directoryPath, + 'MissingMethodController.ts', + ); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff', 'nonExistentMethod'] as const; + +class MissingMethodController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods).toHaveLength(2); + expect(result?.methods[1].name).toBe('nonExistentMethod'); + expect(result?.methods[1].jsDoc).toBe(''); + }); + }); + + it('formats JSDoc with empty middle lines', async () => { + expect.assertions(4); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join( + directoryPath, + 'EmptyLineDocController.ts', + ); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const; + +class EmptyLineDocController { + /** + * First line. + * + * After empty line. + */ + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods[0].jsDoc).toContain(' *\n'); + expect(result?.methods[0].jsDoc).toContain(' * First line.'); + expect(result?.methods[0].jsDoc).toContain(' * After empty line.'); + }); + }); + + it('extracts JSDoc with non-standard middle lines', async () => { + expect.assertions(3); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + const controllerFile = path.join(directoryPath, 'WeirdDocController.ts'); + // Write file with a JSDoc containing a line without * prefix and an empty line without * prefix + const source = [ + '', + "const MESSENGER_EXPOSED_METHODS = ['doStuff'] as const;", + '', + 'class WeirdDocController {', + ' /**', + ' This line has no asterisk prefix.', + ' ', + ' */', + ' doStuff() {', + ' return true;', + ' }', + '}', + '', + ].join('\n'); + await fs.promises.writeFile(controllerFile, source, 'utf8'); + + const result = await parseSourceFile(controllerFile); + + expect(result).not.toBeNull(); + expect(result?.methods[0].jsDoc).toContain( + ' * This line has no asterisk prefix.', + ); + // The empty line (only whitespace, no *) should become ' *' + expect(result?.methods[0].jsDoc).toContain(' *\n'); + }); + }); + + it('handles inherited methods with malformed tsconfig', async () => { + expect.assertions(2); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + // Write an invalid tsconfig to trigger readConfigFile error + await fs.promises.writeFile( + path.join(directoryPath, 'tsconfig.json'), + 'this is not valid json', + 'utf8', + ); + + const controllerFile = path.join( + directoryPath, + 'BadTsconfigController.ts', + ); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff', 'inherited'] as const; + +class BadTsconfigController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + const result = await parseSourceFile(controllerFile); + + expect(result).toBeNull(); + expect(consoleErrorSpy).toHaveBeenCalled(); + + consoleErrorSpy.mockRestore(); + }); + }); + + it('handles inherited methods when tsconfig is missing', async () => { + expect.assertions(2); + + await withinParseSourceSandbox(async ({ directoryPath }) => { + // No tsconfig.json in directoryPath ā€” createProgramForFile should fail with assert + const controllerFile = path.join( + directoryPath, + 'NoTsconfigController.ts', + ); + await fs.promises.writeFile( + controllerFile, + ` +const MESSENGER_EXPOSED_METHODS = ['doStuff', 'inheritedMethod'] as const; + +class NoTsconfigController { + doStuff() { + return true; + } +} +`, + 'utf8', + ); + + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + const result = await parseSourceFile(controllerFile); + + // Should return null because assert fails when type checker can't be created + expect(result).toBeNull(); + expect(consoleErrorSpy).toHaveBeenCalled(); + + consoleErrorSpy.mockRestore(); + }); + }); + + it('returns null and logs error for invalid file', async () => { + expect.assertions(2); + + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); + + const result = await parseSourceFile('/nonexistent/file.ts'); + + expect(result).toBeNull(); + expect(consoleErrorSpy).toHaveBeenCalled(); + consoleErrorSpy.mockRestore(); + }); +}); + +describe('findSourcesWithExposedMethods', () => { + it('finds controllers with MESSENGER_EXPOSED_METHODS in a directory', async () => { + expect.assertions(2); + + await withinFindControllersSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'FooController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doFoo'] as const; +class FooController { + doFoo() { return 'foo'; } +} +`, + 'utf8', + ); + + await fs.promises.writeFile( + path.join(directoryPath, 'BarController.ts'), + ` +class BarController { + doBar() { return 'bar'; } +} +`, + 'utf8', + ); + + const result = await findSourcesWithExposedMethods(directoryPath); + + expect(result).toHaveLength(1); + expect(result[0].name).toBe('FooController'); + }); + }); + + it('skips test files', async () => { + expect.assertions(1); + + await withinFindControllersSandbox(async ({ directoryPath }) => { + await fs.promises.writeFile( + path.join(directoryPath, 'FooController.test.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doFoo'] as const; +class FooController { + doFoo() { return 'foo'; } +} +`, + 'utf8', + ); + + const result = await findSourcesWithExposedMethods(directoryPath); + + expect(result).toHaveLength(0); + }); + }); + + it('finds sources in nested subdirectories', async () => { + expect.assertions(2); + + await withinFindControllersSandbox(async ({ directoryPath }) => { + const subDir = path.join(directoryPath, 'nested'); + await fs.promises.mkdir(subDir); + + await fs.promises.writeFile( + path.join(subDir, 'NestedController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doNested'] as const; +class NestedController { + doNested() { return 'nested'; } +} +`, + 'utf8', + ); + + const result = await findSourcesWithExposedMethods(directoryPath); + + expect(result).toHaveLength(1); + expect(result[0].name).toBe('NestedController'); + }); + }); + + it('skips excluded directories like node_modules', async () => { + expect.assertions(1); + + await withinFindControllersSandbox(async ({ directoryPath }) => { + const nodeModulesDir = path.join(directoryPath, 'node_modules'); + await fs.promises.mkdir(nodeModulesDir); + + await fs.promises.writeFile( + path.join(nodeModulesDir, 'HiddenController.ts'), + ` +const MESSENGER_EXPOSED_METHODS = ['doHidden'] as const; +class HiddenController { + doHidden() { return 'hidden'; } +} +`, + 'utf8', + ); + + const result = await findSourcesWithExposedMethods(directoryPath); + + expect(result).toHaveLength(0); + }); + }); + + it('throws an error when the path is not a directory', async () => { + await expect( + findSourcesWithExposedMethods('/nonexistent/path'), + ).rejects.toThrow('The specified path is not a directory'); + }); + + it('re-throws non-ENOENT errors from isDirectory', async () => { + const statSpy = jest + .spyOn(fs.promises, 'stat') + .mockRejectedValue( + Object.assign(new Error('EACCES'), { code: 'EACCES' }), + ); + + await expect(findSourcesWithExposedMethods('/some/path')).rejects.toThrow( + 'EACCES', + ); + + statSpy.mockRestore(); + }); +}); diff --git a/packages/messenger-cli/src/parse-source.ts b/packages/messenger-cli/src/parse-source.ts new file mode 100644 index 00000000000..133ad6ce361 --- /dev/null +++ b/packages/messenger-cli/src/parse-source.ts @@ -0,0 +1,439 @@ +import { assert, hasProperty, isObject } from '@metamask/utils'; +import * as fs from 'node:fs'; +import * as path from 'node:path'; +import type { + ArrayLiteralExpression, + ClassDeclaration, + MethodDeclaration, + Node as TSNode, + Program, + SourceFile, + Type, +} from 'typescript'; +import { + ScriptTarget, + createProgram, + createSourceFile, + findConfigFile, + forEachChild, + getJSDocCommentsAndTags, + isArrayLiteralExpression, + isAsExpression, + isClassDeclaration, + isIdentifier, + isJSDoc, + isMethodDeclaration, + isStringLiteral, + isVariableStatement, + parseJsonConfigFileContent, + readConfigFile, + sys, +} from 'typescript'; + +export type MethodInfo = { + name: string; + jsDoc: string; +}; + +export type SourceInfo = { + name: string; + filePath: string; + methods: MethodInfo[]; +}; + +type VisitorContext = { + exposedMethods: string[]; + className: string; + methods: MethodInfo[]; + sourceFile: SourceFile; +}; + +/** + * Extracts JSDoc comment from a method declaration. + * + * @param node - The method declaration node. + * @param source - The source file. + * @returns The JSDoc comment. + */ +function extractJSDoc(node: MethodDeclaration, source: SourceFile): string { + const jsDocTags = getJSDocCommentsAndTags(node); + if (jsDocTags.length === 0) { + return ''; + } + + const jsDoc = jsDocTags[0]; + if (isJSDoc(jsDoc)) { + const fullText = source.getFullText(); + const start = jsDoc.getFullStart(); + const end = jsDoc.getEnd(); + const rawJsDoc = fullText.substring(start, end).trim(); + return formatJSDoc(rawJsDoc); + } + + // istanbul ignore next: defensive check ā€” getJSDocCommentsAndTags always returns JSDoc nodes + return ''; +} + +/** + * Formats JSDoc comments to have consistent indentation for the generated file. + * + * @param rawJsDoc - The raw JSDoc comment from the source. + * @returns The formatted JSDoc comment. + */ +function formatJSDoc(rawJsDoc: string): string { + const lines = rawJsDoc.split('\n'); + const formattedLines: string[] = []; + + for (let i = 0; i < lines.length; i++) { + const line = lines[i]; + if (i === 0) { + formattedLines.push('/**'); + } else if (i === lines.length - 1) { + formattedLines.push(' */'); + } else { + const trimmed = line.trim(); + if (trimmed.startsWith('*')) { + const content = trimmed.substring(1).trim(); + formattedLines.push(content ? ` * ${content}` : ' *'); + } else { + formattedLines.push(trimmed ? ` * ${trimmed}` : ' *'); + } + } + } + + return formattedLines.join('\n'); +} + +/** + * Visits AST nodes to find exposed methods and controller/service class. + * + * @param context - The visitor context. + * @returns A function to visit nodes. + */ +function createASTVisitor(context: VisitorContext): (node: TSNode) => void { + function visitNode(node: TSNode): void { + if (isVariableStatement(node)) { + const declaration = node.declarationList.declarations[0]; + if ( + isIdentifier(declaration.name) && + declaration.name.text === 'MESSENGER_EXPOSED_METHODS' + ) { + if (declaration.initializer) { + let arrayExpression: ArrayLiteralExpression | undefined; + + if (isArrayLiteralExpression(declaration.initializer)) { + arrayExpression = declaration.initializer; + } else if ( + isAsExpression(declaration.initializer) && + isArrayLiteralExpression(declaration.initializer.expression) + ) { + arrayExpression = declaration.initializer.expression; + } + + if (arrayExpression) { + context.exposedMethods = arrayExpression.elements + .filter(isStringLiteral) + .map((element) => element.text); + } + } + } + } + + if (isClassDeclaration(node) && node.name) { + const classText = node.name.text; + if (classText.includes('Controller') || classText.includes('Service')) { + context.className = classText; + + const seenMethods = new Set(); + for (const member of node.members) { + if ( + isMethodDeclaration(member) && + member.name && + isIdentifier(member.name) + ) { + const methodName = member.name.text; + if ( + context.exposedMethods.includes(methodName) && + !seenMethods.has(methodName) + ) { + seenMethods.add(methodName); + const jsDoc = extractJSDoc(member, context.sourceFile); + context.methods.push({ + name: methodName, + jsDoc, + }); + } + } + } + } + } + + forEachChild(node, visitNode); + } + + return visitNode; +} + +/** + * Create a TypeScript program for the given file by locating the nearest + * tsconfig.json. + * + * @param filePath - Absolute path to the source file. + * @returns A TypeScript program, or null if no tsconfig was found. + */ +function createProgramForFile(filePath: string): Program | null { + const configPath = findConfigFile( + path.dirname(filePath), + sys.fileExists.bind(sys), + 'tsconfig.json', + ); + if (!configPath) { + return null; + } + + const { config, error } = readConfigFile(configPath, sys.readFile.bind(sys)); + + if (error) { + return null; + } + + const parsedConfig = parseJsonConfigFileContent( + config, + sys, + path.dirname(configPath), + ); + + return createProgram({ + rootNames: parsedConfig.fileNames, + options: parsedConfig.options, + }); +} + +/** + * Find a class declaration with the given name in a source file. + * + * @param source - The source file to search. + * @param className - The class name to look for. + * @returns The class declaration node, or null if not found. + */ +function findClassInSourceFile( + source: SourceFile, + className: string, +): ClassDeclaration | null { + return ( + source.statements.find( + (node): node is ClassDeclaration => + isClassDeclaration(node) && node.name?.text === className, + ) ?? // istanbul ignore next: class is always found when called from parseSourceFile + null + ); +} + +/** + * Search through the class hierarchy of a TypeScript type to find the + * declaration of a method with the given name. + * + * @param classType - The class type to search. + * @param methodName - The method name to look for. + * @returns The method declaration node, or null if not found. + */ +function findMethodInHierarchy( + classType: Type, + methodName: string, +): MethodDeclaration | null { + const symbol = classType.getProperty(methodName); + if (!symbol) { + return null; + } + + const declarations = symbol.getDeclarations(); + // istanbul ignore next: defensive check ā€” symbols from getProperty always have declarations + if (!declarations) { + return null; + } + + for (const declaration of declarations) { + if (isMethodDeclaration(declaration)) { + return declaration; + } + } + + // istanbul ignore next: defensive fallback ā€” property found but not a method declaration + return null; +} + +/** + * Check if a path is a directory. + * + * @param pathValue - The path to check. + * @returns True if the path is a directory, false otherwise. + */ +async function isDirectory(pathValue: string): Promise { + try { + const stats = await fs.promises.stat(pathValue); + return stats.isDirectory(); + } catch (error) { + if ( + isObject(error) && + hasProperty(error, 'code') && + error.code === 'ENOENT' + ) { + return false; + } + + throw error; + } +} + +/** + * Parses a source file to extract exposed methods and their metadata. + * + * @param filePath - Path to the controller/service file to parse. + * @returns Source information or null if parsing fails. + */ +export async function parseSourceFile( + filePath: string, +): Promise { + try { + const content = await fs.promises.readFile(filePath, 'utf8'); + const source = createSourceFile( + filePath, + content, + ScriptTarget.Latest, + true, + ); + + const context: VisitorContext = { + exposedMethods: [], + className: '', + methods: [], + sourceFile: source, + }; + + createASTVisitor(context)(source); + + if (context.exposedMethods.length === 0 || !context.className) { + return null; + } + + const foundMethodNames = new Set( + context.methods.map((method) => method.name), + ); + + const inheritedMethodNames = context.exposedMethods.filter( + (name) => !foundMethodNames.has(name), + ); + + if (inheritedMethodNames.length > 0) { + const program = createProgramForFile(filePath); + const checker = program?.getTypeChecker(); + const programSourceFile = program?.getSourceFile(filePath); + + assert( + checker, + `Type checker could not be created for "${filePath}". Ensure a valid tsconfig.json is present.`, + ); + + assert( + programSourceFile, + `Source file "${filePath}" not found in program.`, + ); + + const classNode = findClassInSourceFile( + programSourceFile, + context.className, + ); + + assert( + classNode, + `Class "${context.className}" not found in "${filePath}".`, + ); + + const classType = checker.getTypeAtLocation(classNode); + for (const methodName of inheritedMethodNames) { + const methodDeclaration = findMethodInHierarchy(classType, methodName); + + const jsDoc = methodDeclaration + ? extractJSDoc(methodDeclaration, methodDeclaration.getSourceFile()) + : ''; + context.methods.push({ name: methodName, jsDoc }); + } + } + + return { + name: context.className, + filePath, + methods: context.methods, + }; + } catch (error) { + console.error(`Error parsing ${filePath}:`, error); + return null; + } +} + +/** + * Recursively get all files in a directory and its subdirectories. + * + * @param directory - The directory to search. + * @returns An array of file paths. + */ +const EXCLUDED_DIRECTORIES = new Set([ + 'node_modules', + 'dist', + '.git', + 'coverage', +]); + +async function getFiles(directory: string): Promise { + const entries = await fs.promises.readdir(directory, { withFileTypes: true }); + const files = await Promise.all( + entries.map(async (entry) => { + const fullPath = path.join(directory, entry.name); + if (entry.isDirectory()) { + return EXCLUDED_DIRECTORIES.has(entry.name) + ? [] + : await getFiles(fullPath); + } + return fullPath; + }), + ); + + return files.flat(); +} + +/** + * Finds all source files that have MESSENGER_EXPOSED_METHODS constants. + * Searches recursively through subdirectories. + * + * @param sourcePath - Path to the folder where controllers/services are located. + * @returns A list of source information objects. + */ +export async function findSourcesWithExposedMethods( + sourcePath: string, +): Promise { + const srcPath = path.resolve(globalThis.process.cwd(), sourcePath); + const sources: SourceInfo[] = []; + + if (!(await isDirectory(srcPath))) { + throw new Error(`The specified path is not a directory: ${srcPath}`); + } + + const srcFiles = await getFiles(srcPath); + + for (const file of srcFiles) { + if (!file.endsWith('.ts') || file.endsWith('.test.ts')) { + continue; + } + + const content = await fs.promises.readFile(file, 'utf8'); + + if (content.includes('MESSENGER_EXPOSED_METHODS')) { + const sourceInfo = await parseSourceFile(file); + if (sourceInfo) { + sources.push(sourceInfo); + } + } + } + + return sources; +} diff --git a/packages/messenger-cli/src/types.ts b/packages/messenger-cli/src/types.ts new file mode 100644 index 00000000000..77ced93647c --- /dev/null +++ b/packages/messenger-cli/src/types.ts @@ -0,0 +1,6 @@ +import type { ESLint as eslintClass } from 'eslint'; + +export type ESLint = { + instance: eslintClass; + eslintClass: typeof eslintClass; +}; diff --git a/packages/messenger-cli/tsconfig.build.json b/packages/messenger-cli/tsconfig.build.json new file mode 100644 index 00000000000..02a0eea03fe --- /dev/null +++ b/packages/messenger-cli/tsconfig.build.json @@ -0,0 +1,10 @@ +{ + "extends": "../../tsconfig.packages.build.json", + "compilerOptions": { + "baseUrl": "./", + "outDir": "./dist", + "rootDir": "./src" + }, + "references": [], + "include": ["../../types", "./src"] +} diff --git a/packages/messenger-cli/tsconfig.json b/packages/messenger-cli/tsconfig.json new file mode 100644 index 00000000000..025ba2ef7f4 --- /dev/null +++ b/packages/messenger-cli/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../tsconfig.packages.json", + "compilerOptions": { + "baseUrl": "./" + }, + "references": [], + "include": ["../../types", "./src"] +} diff --git a/packages/messenger/CHANGELOG.md b/packages/messenger/CHANGELOG.md index 15e59ce3615..9b7ca7f9179 100644 --- a/packages/messenger/CHANGELOG.md +++ b/packages/messenger/CHANGELOG.md @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Deprecated + +- Deprecate `generate-action-types` CLI tool and `messenger-generate-action-types` binary ([#8378](https://github.com/MetaMask/core/pull/8378)) + - The CLI has been extracted to `@metamask/messenger-cli`. Use `messenger-action-types` from this package instead. + ## [1.1.1] ### Fixed diff --git a/packages/messenger/src/generate-action-types/cli.ts b/packages/messenger/src/generate-action-types/cli.ts index 5fd021ebf5b..4cf338ae31d 100644 --- a/packages/messenger/src/generate-action-types/cli.ts +++ b/packages/messenger/src/generate-action-types/cli.ts @@ -92,6 +92,10 @@ async function loadESLint(): Promise { * Main entry point for the CLI. */ async function main(): Promise { + console.warn( + 'āš ļø `messenger-generate-action-types` from @metamask/messenger is deprecated. Use `messenger-action-types` from @metamask/messenger-cli instead.', + ); + const { fix, sourcePath } = await parseCommandLineArguments( globalThis.process.argv.slice(2), ); diff --git a/packages/money-account-controller/package.json b/packages/money-account-controller/package.json index edd9e0e2f95..8e4f6933efe 100644 --- a/packages/money-account-controller/package.json +++ b/packages/money-account-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/money-account-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/money-account-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/multichain-account-service/package.json b/packages/multichain-account-service/package.json index 473393ab74b..90effe6374d 100644 --- a/packages/multichain-account-service/package.json +++ b/packages/multichain-account-service/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain-account-service", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain-account-service", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/name-controller/package.json b/packages/name-controller/package.json index e58ab2e28fb..9a3ee1ec8c6 100644 --- a/packages/name-controller/package.json +++ b/packages/name-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/name-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/name-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", diff --git a/packages/network-controller/package.json b/packages/network-controller/package.json index 9d1135acc5d..7a31e1c2322 100644 --- a/packages/network-controller/package.json +++ b/packages/network-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/network-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/network-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/network-enablement-controller/package.json b/packages/network-enablement-controller/package.json index 09e94775597..79da0d72229 100644 --- a/packages/network-enablement-controller/package.json +++ b/packages/network-enablement-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/network-enablement-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/network-enablement-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/notification-services-controller/package.json b/packages/notification-services-controller/package.json index 0c2346663bb..a2600ddd0d0 100644 --- a/packages/notification-services-controller/package.json +++ b/packages/notification-services-controller/package.json @@ -92,7 +92,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/notification-services-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/notification-services-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/permission-controller/package.json b/packages/permission-controller/package.json index 574372ed4a0..eb773eca6af 100644 --- a/packages/permission-controller/package.json +++ b/packages/permission-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/permission-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/permission-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/permission-log-controller/package.json b/packages/permission-log-controller/package.json index 2756104f843..5a5c39fca5e 100644 --- a/packages/permission-log-controller/package.json +++ b/packages/permission-log-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/permission-log-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/permission-log-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/perps-controller/package.json b/packages/perps-controller/package.json index 841feb4b8b8..e45b9ace013 100644 --- a/packages/perps-controller/package.json +++ b/packages/perps-controller/package.json @@ -43,7 +43,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/perps-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/perps-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/phishing-controller/package.json b/packages/phishing-controller/package.json index 33f5e25d1c3..a5114eb531b 100644 --- a/packages/phishing-controller/package.json +++ b/packages/phishing-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/phishing-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/phishing-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/preferences-controller/package.json b/packages/preferences-controller/package.json index 0e0dfc3cb3c..4a995b1cc22 100644 --- a/packages/preferences-controller/package.json +++ b/packages/preferences-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/preferences-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/preferences-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/profile-metrics-controller/package.json b/packages/profile-metrics-controller/package.json index bf2917ae8a6..e9c0a0b9ca6 100644 --- a/packages/profile-metrics-controller/package.json +++ b/packages/profile-metrics-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/profile-metrics-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/profile-metrics-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/profile-sync-controller/package.json b/packages/profile-sync-controller/package.json index 2653edc3d7a..5a8bf22e915 100644 --- a/packages/profile-sync-controller/package.json +++ b/packages/profile-sync-controller/package.json @@ -93,7 +93,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/profile-sync-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/profile-sync-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/ramps-controller/package.json b/packages/ramps-controller/package.json index 19d9f8b98e8..6ea7036e40a 100644 --- a/packages/ramps-controller/package.json +++ b/packages/ramps-controller/package.json @@ -41,7 +41,8 @@ "changelog:update": "../../scripts/update-changelog.sh @metamask/ramps-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/ramps-controller", "dev": "node dev-watch.js", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/remote-feature-flag-controller/package.json b/packages/remote-feature-flag-controller/package.json index 5783dadbe26..7a8da460a44 100644 --- a/packages/remote-feature-flag-controller/package.json +++ b/packages/remote-feature-flag-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/remote-feature-flag-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/remote-feature-flag-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/sample-controllers/package.json b/packages/sample-controllers/package.json index 6dd5fa9f987..72e4f26dbe0 100644 --- a/packages/sample-controllers/package.json +++ b/packages/sample-controllers/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/sample-controllers", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/sample-controllers", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/seedless-onboarding-controller/package.json b/packages/seedless-onboarding-controller/package.json index 557dd75f812..0d3bcae76ed 100644 --- a/packages/seedless-onboarding-controller/package.json +++ b/packages/seedless-onboarding-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/seedless-onboarding-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/seedless-onboarding-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/selected-network-controller/package.json b/packages/selected-network-controller/package.json index dfe5892449d..42390bfc441 100644 --- a/packages/selected-network-controller/package.json +++ b/packages/selected-network-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/selected-network-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/selected-network-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/shield-controller/package.json b/packages/shield-controller/package.json index fe981726440..5e4e40ee0e3 100644 --- a/packages/shield-controller/package.json +++ b/packages/shield-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/shield-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/shield-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/signature-controller/package.json b/packages/signature-controller/package.json index d9ecb7f13c5..7a119000925 100644 --- a/packages/signature-controller/package.json +++ b/packages/signature-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/signature-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/signature-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/social-controllers/package.json b/packages/social-controllers/package.json index d82a76a8fc4..89df32191ca 100644 --- a/packages/social-controllers/package.json +++ b/packages/social-controllers/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/social-controllers", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/social-controllers", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", @@ -61,6 +62,7 @@ "deepmerge": "^4.2.2", "jest": "^29.7.0", "ts-jest": "^29.2.5", + "tsx": "^4.20.5", "typedoc": "^0.25.13", "typedoc-plugin-missing-exports": "^2.0.0", "typescript": "~5.3.3" diff --git a/packages/storage-service/package.json b/packages/storage-service/package.json index 702b7d6a148..0155c9f14a2 100644 --- a/packages/storage-service/package.json +++ b/packages/storage-service/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/storage-service", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/storage-service", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/subscription-controller/package.json b/packages/subscription-controller/package.json index 69c132b4b46..c6a328e91f0 100644 --- a/packages/subscription-controller/package.json +++ b/packages/subscription-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/subscription-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/subscription-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/transaction-controller/package.json b/packages/transaction-controller/package.json index dff35d0d69d..ed649ccb7aa 100644 --- a/packages/transaction-controller/package.json +++ b/packages/transaction-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/transaction-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/transaction-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", diff --git a/packages/transaction-pay-controller/package.json b/packages/transaction-pay-controller/package.json index 1632b1e0577..cd48626a7e8 100644 --- a/packages/transaction-pay-controller/package.json +++ b/packages/transaction-pay-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/transaction-pay-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/transaction-pay-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", diff --git a/packages/user-operation-controller/package.json b/packages/user-operation-controller/package.json index ef1c1d586b4..bf3adb57921 100644 --- a/packages/user-operation-controller/package.json +++ b/packages/user-operation-controller/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh @metamask/user-operation-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/user-operation-controller", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", diff --git a/scripts/create-package/package-template/package.json b/scripts/create-package/package-template/package.json index 3e62b61e574..48b4e92d110 100644 --- a/scripts/create-package/package-template/package.json +++ b/scripts/create-package/package-template/package.json @@ -40,7 +40,8 @@ "build:docs": "typedoc", "changelog:update": "../../scripts/update-changelog.sh PACKAGE_NAME", "changelog:validate": "../../scripts/validate-changelog.sh PACKAGE_NAME", - "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts", + "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check", + "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate", "since-latest-release": "../../scripts/since-latest-release.sh", "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", @@ -54,6 +55,7 @@ "deepmerge": "^4.2.2", "jest": "^29.7.0", "ts-jest": "^29.2.5", + "tsx": "^4.20.5", "typedoc": "^0.25.13", "typedoc-plugin-missing-exports": "^2.0.0", "typescript": "~5.3.3" diff --git a/teams.json b/teams.json index 7ac46551521..176c831c5af 100644 --- a/teams.json +++ b/teams.json @@ -46,6 +46,7 @@ "metamask/geolocation-controller": "team-core-platform", "metamask/controller-utils": "team-core-platform", "metamask/messenger": "team-core-platform", + "metamask/messenger-cli": "team-core-platform", "metamask/sample-controllers": "team-core-platform", "metamask/polling-controller": "team-core-platform", "metamask/preferences-controller": "team-core-platform", diff --git a/tsconfig.build.json b/tsconfig.build.json index 35740bcf709..b02f3a882f5 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -136,6 +136,9 @@ { "path": "./packages/message-manager/tsconfig.build.json" }, + { + "path": "./packages/messenger-cli/tsconfig.build.json" + }, { "path": "./packages/messenger/tsconfig.build.json" }, diff --git a/tsconfig.json b/tsconfig.json index bd03b3fc5f0..7eb3aadc457 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -131,6 +131,9 @@ { "path": "./packages/messenger" }, + { + "path": "./packages/messenger-cli" + }, { "path": "./packages/money-account-controller" }, diff --git a/yarn.config.cjs b/yarn.config.cjs index 6321d9137cd..78612e4699e 100644 --- a/yarn.config.cjs +++ b/yarn.config.cjs @@ -117,7 +117,10 @@ module.exports = defineConfig({ // All non-root packages must set up ESM- and CommonJS-compatible // exports correctly. - if (workspace.ident !== '@metamask/foundryup') { + if ( + workspace.ident !== '@metamask/foundryup' && + workspace.ident !== '@metamask/messenger-cli' + ) { expectCorrectWorkspaceExports(workspace); } @@ -136,7 +139,9 @@ module.exports = defineConfig({ ); // All non-root packages must have the same "build:docs" script. - expectWorkspaceField(workspace, 'scripts.build:docs', 'typedoc'); + if (workspace.ident !== '@metamask/messenger-cli') { + expectWorkspaceField(workspace, 'scripts.build:docs', 'typedoc'); + } // No non-root packages may have a "prepack" script. workspace.unset('scripts.prepack'); diff --git a/yarn.lock b/yarn.lock index 3c2eb27a675..9dfb37dd539 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4332,6 +4332,33 @@ __metadata: languageName: unknown linkType: soft +"@metamask/messenger-cli@workspace:packages/messenger-cli": + version: 0.0.0-use.local + resolution: "@metamask/messenger-cli@workspace:packages/messenger-cli" + dependencies: + "@metamask/auto-changelog": "npm:^3.4.4" + "@metamask/utils": "npm:^11.9.0" + "@ts-bridge/cli": "npm:^0.6.4" + "@types/jest": "npm:^29.5.14" + "@types/yargs": "npm:^17.0.32" + deepmerge: "npm:^4.2.2" + eslint: "npm:^9.39.1" + execa: "npm:^5.0.0" + jest: "npm:^29.7.0" + ts-jest: "npm:^29.2.5" + typescript: "npm:~5.3.3" + yargs: "npm:^17.7.2" + peerDependencies: + eslint: ">=8" + typescript: ">=5.0.0" + peerDependenciesMeta: + eslint: + optional: true + bin: + messenger-action-types: ./dist/cli.mjs + languageName: unknown + linkType: soft + "@metamask/messenger@npm:^0.3.0": version: 0.3.0 resolution: "@metamask/messenger@npm:0.3.0" @@ -5383,6 +5410,7 @@ __metadata: deepmerge: "npm:^4.2.2" jest: "npm:^29.7.0" ts-jest: "npm:^29.2.5" + tsx: "npm:^4.20.5" typedoc: "npm:^0.25.13" typedoc-plugin-missing-exports: "npm:^2.0.0" typescript: "npm:~5.3.3"