📦️ chore: Add release package (#1027)

packages/core/src/cli/cliEntrypoint.ts

@@ -0,0 +1,58 @@
+import path from 'node:path'
+import chalk from 'chalk'
+import { Command } from 'commander'
+import { rimraf } from 'rimraf'
+import { WALLET_SETUP_DIR_NAME } from '../constants'
+import { createCache } from '../createCache'
+import { prepareExtension } from '../prepareExtension'
+import { compileWalletSetupFunctions } from './compileWalletSetupFunctions'
+import { footer } from './footer'
+
+interface CliFlags {
+  headless: boolean
+  force: boolean
+  debug: boolean
+}
+
+// TODO: Add unit tests for the CLI!
+export const cliEntrypoint = async () => {
+  console.log(`⚠️ ${chalk.yellowBright`The CLI is in alpha so expect breaking changes!`} ⚠️\n`)
+
+  const program = new Command()
+    .name(chalk.magenta('core'))
+    .description('A CLI for building the cache of wallet setup functions')
+    .argument('[dir]', 'Directory containing the wallet setup functions', path.join('test', WALLET_SETUP_DIR_NAME))
+    .option(
+      '--headless',
+      'Build cache in the headless browser mode. Alternatively, set the `HEADLESS` env variable to `true`',
+      false
+    )
+    .option('-f, --force', 'Force the creation of cache even if it already exists', false)
+    .option('-d, --debug', 'If this flag is present, the compilation files are not going to be deleted', false)
+    .helpOption(undefined, 'Display help for command')
+    .addHelpText('afterAll', `\n${footer}\n`)
+    .parse(process.argv)
+
+  let walletSetupDir = program.args[0]
+  if (!walletSetupDir) {
+    walletSetupDir = path.join(process.cwd(), 'test', WALLET_SETUP_DIR_NAME)
+  }
+
+  const flags: CliFlags = program.opts()
+
+  if (flags.headless) {
+    process.env.HEADLESS = true
+  }
+
+  console.log('[DEBUG] Running with the following options:')
+  console.log({ cacheDir: walletSetupDir, ...flags, headless: Boolean(process.env.HEADLESS) ?? false }, '\n')
+
+  const compiledWalletSetupDirPath = await compileWalletSetupFunctions(walletSetupDir, flags.debug)
+
+  // TODO: We should be using `prepareExtension` function from the wallet itself!
+  await createCache(compiledWalletSetupDirPath, prepareExtension, flags.force)
+
+  if (!flags.debug) {
+    await rimraf(compiledWalletSetupDirPath)
+  }
+}

packages/core/src/cli/index.ts

@@ -1,65 +1,8 @@
 #!/usr/bin/env node
 
-import path from 'node:path'
-import chalk from 'chalk'
-import { Command } from 'commander'
-import { rimraf } from 'rimraf'
-import { WALLET_SETUP_DIR_NAME } from '../constants'
-import { createCache } from '../createCache'
-import { prepareExtension } from '../prepareExtension'
-import { compileWalletSetupFunctions } from './compileWalletSetupFunctions'
-import { footer } from './footer'
+import { cliEntrypoint } from './cliEntrypoint'
 
-interface CliFlags {
-  headless: boolean
-  force: boolean
-  debug: boolean
-}
-
-// TODO: Add unit tests for the CLI!
-export const main = async () => {
-  console.log(`⚠️ ${chalk.yellowBright`The CLI is in alpha so expect breaking changes!`} ⚠️\n`)
-
-  const program = new Command()
-    .name(chalk.magenta('core'))
-    .description('A CLI for building the cache of wallet setup functions')
-    .argument('[dir]', 'Directory containing the wallet setup functions', path.join('test', WALLET_SETUP_DIR_NAME))
-    .option(
-      '--headless',
-      'Build cache in the headless browser mode. Alternatively, set the `HEADLESS` env variable to `true`',
-      false
-    )
-    .option('-f, --force', 'Force the creation of cache even if it already exists', false)
-    .option('-d, --debug', 'If this flag is present, the compilation files are not going to be deleted', false)
-    .helpOption(undefined, 'Display help for command')
-    .addHelpText('afterAll', `\n${footer}\n`)
-    .parse(process.argv)
-
-  let walletSetupDir = program.args[0]
-  if (!walletSetupDir) {
-    walletSetupDir = path.join(process.cwd(), 'test', WALLET_SETUP_DIR_NAME)
-  }
-
-  const flags: CliFlags = program.opts()
-
-  if (flags.headless) {
-    process.env.HEADLESS = true
-  }
-
-  console.log('[DEBUG] Running with the following options:')
-  console.log({ cacheDir: walletSetupDir, ...flags, headless: Boolean(process.env.HEADLESS) ?? false }, '\n')
-
-  const compiledWalletSetupDirPath = await compileWalletSetupFunctions(walletSetupDir, flags.debug)
-
-  // TODO: We should be using `prepareExtension` function from the wallet itself!
-  await createCache(compiledWalletSetupDirPath, prepareExtension, flags.force)
-
-  if (!flags.debug) {
-    await rimraf(compiledWalletSetupDirPath)
-  }
-}
-
-main().catch((err) => {
+cliEntrypoint().catch((err) => {
   console.log('Aborting...')
 
   if (err instanceof Error) {

packages/core/src/index.ts

@@ -7,3 +7,4 @@ export * from './defineWalletSetup'
 export * from './utils/createTempContextDir'
 export * from './utils/removeTempContextDir'
 export * from './prepareExtension'
+export * from './cli/cliEntrypoint'

pnpm-workspace.yaml

@@ -2,3 +2,4 @@ packages:
   - "packages/*"
   - "wallets/*"
   - "examples/*"
+  - "release"

release/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@synthetixio/synpress",
+  "version": "4.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "main": "./dist/index.js",
+  "bin": "./dist/cli.js",
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ],
+  "scripts": {
+    "build": "pnpm run clean && pnpm run build:dist && pnpm run build:types",
+    "build:dist": "tsup",
+    "build:types": "tsc --emitDeclarationOnly",
+    "clean": "rimraf dist types",
+    "lint": "biome check . --apply",
+    "lint:check": "biome check . --verbose",
+    "lint:unsafe": "biome check . --apply-unsafe",
+    "prepublishOnly": "pnpm run build",
+    "types:check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@synthetixio/synpress-core": "workspace:*",
+    "@synthetixio/synpress-fixtures": "workspace:*",
+    "@synthetixio/synpress-metamask": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.0",
+    "rimraf": "^5.0.1",
+    "tsconfig": "workspace:*",
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "@playwright/test": "1.40.0"
+  }
+}

release/src/cli.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+
+import { cliEntrypoint } from '@synthetixio/synpress-core'
+
+cliEntrypoint().catch((err) => {
+  console.log('Aborting...')
+
+  if (err instanceof Error) {
+    console.error(err)
+  } else {
+    console.error('Unknown error occurred!', err)
+  }
+
+  process.exit(1)
+})

release/src/index.ts

@@ -0,0 +1,5 @@
+import { defineWalletSetup } from '@synthetixio/synpress-core'
+import { getExtensionId, testWithSynpress } from '@synthetixio/synpress-fixtures'
+import { MetaMask, unlockForFixture } from '@synthetixio/synpress-metamask'
+
+export { defineWalletSetup, testWithSynpress, getExtensionId, MetaMask, unlockForFixture }

release/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "tsconfig/base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "types",
+    "declaration": true,
+    "sourceMap": false,
+    "declarationMap": true
+  },
+  "include": ["src/index.ts"]
+}

release/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  name: 'synpress',
+  entry: ['src/index.ts', 'src/cli.ts'],
+  outDir: 'dist',
+  format: 'esm',
+  splitting: false,
+  sourcemap: false
+})