feat: add @metamask/wallet-cli package scaffold

eslint.config.mjs

@@ -308,6 +308,27 @@ const config = createConfig([
       'import-x/no-nodejs-modules': 'off',
     },
   },
+  {
+    files: ['packages/wallet-cli/src/**/*.{js,ts}'],
+    rules: {
+      'import-x/no-nodejs-modules': 'off',
+      'no-restricted-globals': 'off',
+    },
+  },
+  {
+    files: ['packages/wallet-cli/src/**/*.test.{js,ts}'],
+    rules: {
+      'jest/unbound-method': 'off',
+      'n/no-process-env': 'off',
+      'n/no-sync': 'off',
+    },
+  },
+  {
+    files: ['packages/wallet-cli/bin/**/*.mjs'],
+    rules: {
+      'import-x/no-unresolved': 'off',
+    },
+  },
   {
     files: [
       'packages/notification-services-controller/src/NotificationServicesPushController/services/push/*-web.ts',

packages/wallet-cli/CHANGELOG.md

@@ -7,4 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Initial package scaffold for `@metamask/wallet-cli`, an [oclif](https://oclif.io)-based `mm` CLI for `@metamask/wallet` ([#9065](https://github.com/MetaMask/core/pull/9065)).
+
 [Unreleased]: https://github.com/MetaMask/core/

packages/wallet-cli/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run.mjs" %*

packages/wallet-cli/bin/run.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core';
+
+await execute({ dir: import.meta.url });

packages/wallet-cli/package.json

@@ -15,23 +15,15 @@
     "type": "git",
     "url": "https://github.com/MetaMask/core.git"
   },
+  "bin": {
+    "mm": "./bin/run.mjs"
+  },
   "files": [
+    "bin/",
     "dist/"
   ],
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
   "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
@@ -41,29 +33,32 @@
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
     "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
-    "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/wallet-cli",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/wallet-cli",
-    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
-    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --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",
     "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
+  "dependencies": {
+    "@oclif/core": "^4.10.5"
+  },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^29.5.14",
     "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"
   },
+  "oclif": {
+    "bin": "mm",
+    "commands": "./dist/commands",
+    "dirname": "mm",
+    "topicSeparator": " "
+  },
   "engines": {
     "node": "^18.18 || >=20"
   }

packages/wallet-cli/src/daemon/paths.test.ts

@@ -0,0 +1,17 @@
+import { join } from 'node:path';
+
+import { getDaemonPaths } from './paths';
+
+describe('getDaemonPaths', () => {
+  it('returns correct paths for the given data directory', () => {
+    const dataDir = '/tmp/test-data';
+    const paths = getDaemonPaths(dataDir);
+
+    expect(paths).toStrictEqual({
+      socketPath: join(dataDir, 'daemon.sock'),
+      pidPath: join(dataDir, 'daemon.pid'),
+      logPath: join(dataDir, 'daemon.log'),
+      dbPath: join(dataDir, 'wallet.db'),
+    });
+  });
+});

packages/wallet-cli/src/daemon/paths.ts

@@ -0,0 +1,18 @@
+import { join } from 'node:path';
+
+import type { DaemonPaths } from './types';
+
+/**
+ * Resolve paths for daemon state files within the given data directory.
+ *
+ * @param dataDir - The base data directory (e.g. oclif config.dataDir).
+ * @returns Resolved paths for socket, PID file, log file, and database file.
+ */
+export function getDaemonPaths(dataDir: string): DaemonPaths {
+  return {
+    socketPath: join(dataDir, 'daemon.sock'),
+    pidPath: join(dataDir, 'daemon.pid'),
+    logPath: join(dataDir, 'daemon.log'),
+    dbPath: join(dataDir, 'wallet.db'),
+  };
+}

packages/wallet-cli/src/daemon/types.ts

@@ -0,0 +1,9 @@
+/**
+ * Resolved paths for daemon state files.
+ */
+export type DaemonPaths = {
+  socketPath: string;
+  pidPath: string;
+  logPath: string;
+  dbPath: string;
+};

packages/wallet-cli/tsconfig.json

@@ -4,5 +4,5 @@
     "baseUrl": "./"
   },
   "references": [],
-  "include": ["../../types", "./src"]
+  "include": ["../../types", "./bin", "./src"]
 }

yarn.config.cjs

@@ -39,6 +39,7 @@ const ALLOWED_PEER_DEPENDENCIES = ['react', 'react-dom', 'react-native'];
 const TOOLS = [
   '@metamask/foundryup',
   '@metamask/messenger-cli',
+  '@metamask/wallet-cli',
   '@metamask/wallet-framework-docs',
 ];