feat(cli): scaffold package (bigcommerce#2010)

Author: deini

.gitignore

@@ -14,3 +14,4 @@ playwright/.cache/
 bigcommerce.graphql
 bigcommerce-graphql.d.ts
 .DS_Store
+coverage/

packages/cli/.eslintrc.cjs

@@ -0,0 +1,15 @@
+// @ts-check
+
+/** @type {import('eslint').Linter.Config} */
+const config = {
+  root: true,
+  extends: ['@bigcommerce/catalyst/base', '@bigcommerce/catalyst/prettier'],
+  rules: {
+    'no-console': 'off',
+    'import/no-named-as-default': 'off',
+    '@typescript-eslint/naming-convention': 'off',
+  },
+  ignorePatterns: ['/dist/**'],
+};
+
+module.exports = config;

packages/cli/README.md

@@ -0,0 +1,3 @@
+# @bigcommerce/catalyst
+
+CLI

packages/cli/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@bigcommerce/catalyst",
+  "version": "0.1.0",
+  "type": "module",
+  "bin": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "private": true,
+  "scripts": {
+    "dev": "tsup --watch",
+    "dev:run": "node dist/index.js",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --max-warnings 0",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "build": "tsup"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "@commander-js/extra-typings": "^12.1.0",
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "@bigcommerce/eslint-config": "^2.10.0",
+    "@bigcommerce/eslint-config-catalyst": "workspace:^",
+    "@types/node": "^20.17.10",
+    "@vitest/coverage-v8": "^3.0.7",
+    "@vitest/ui": "^3.0.7",
+    "eslint": "^8.57.1",
+    "prettier": "^3.4.2",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^3.0.7"
+  }
+}

packages/cli/prettier.config.cjs

@@ -0,0 +1,10 @@
+// @ts-check
+
+/** @type {import("prettier").Config} */
+const config = {
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: 'all',
+};
+
+module.exports = config;

packages/cli/src/commands/version.ts

@@ -0,0 +1,13 @@
+import chalk from 'chalk';
+import { Command } from 'commander';
+
+import PACKAGE_INFO from '../../package.json';
+
+export const version = new Command('version')
+  .description('Display detailed version information')
+  .action(() => {
+    console.log(chalk.cyanBright('\nVersion Information:'));
+    console.log(`${chalk.bold('CLI Version:')} ${PACKAGE_INFO.version}`);
+    console.log(`${chalk.bold('Node Version:')} ${process.version}`);
+    console.log(`${chalk.bold('Platform:')} ${process.platform} (${process.arch})\n`);
+  });

packages/cli/src/index.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { program } from './program';
+
+program.parse(process.argv);

packages/cli/src/program.ts

@@ -0,0 +1,16 @@
+import chalk from 'chalk';
+import { Command } from 'commander';
+
+import PACKAGE_INFO from '../package.json';
+
+import { version } from './commands/version';
+
+export const program = new Command();
+
+console.log(chalk.cyanBright(`\n◢ ${PACKAGE_INFO.name} v${PACKAGE_INFO.version}\n`));
+
+program
+  .name(PACKAGE_INFO.name)
+  .version(PACKAGE_INFO.version)
+  .description('CLI tool for Catalyst development')
+  .addCommand(version);

packages/cli/tests/commands/version.spec.ts

@@ -0,0 +1,47 @@
+import { Command } from '@commander-js/extra-typings';
+import { afterEach, beforeEach, expect, MockInstance, test, vi } from 'vitest';
+
+import { version } from '../../src/commands/version';
+
+vi.mock('chalk', () => ({
+  default: new Proxy(
+    {},
+    {
+      get: () => (str: string) => str,
+    },
+  ),
+}));
+
+let consoleMock: MockInstance;
+
+beforeEach(() => {
+  consoleMock = vi.spyOn(console, 'log').mockImplementation(() => null);
+});
+
+afterEach(() => {
+  consoleMock.mockReset();
+});
+
+test('properly configured Command instance', () => {
+  expect(version).toBeInstanceOf(Command);
+  expect(version.name()).toBe('version');
+  expect(version.description()).toBe('Display detailed version information');
+});
+
+test('displays version information when executed', async () => {
+  await version.parseAsync([]);
+
+  expect(consoleMock).toHaveBeenCalledWith(expect.stringContaining('Version Information:'));
+
+  expect(consoleMock).toHaveBeenCalledWith(
+    expect.stringContaining(`CLI Version: ${process.env.npm_package_version}`),
+  );
+
+  expect(consoleMock).toHaveBeenCalledWith(
+    expect.stringContaining(`Node Version: ${process.version}`),
+  );
+
+  expect(consoleMock).toHaveBeenCalledWith(
+    expect.stringContaining(`Platform: ${process.platform} (${process.arch})`),
+  );
+});

packages/cli/tests/index.spec.ts

@@ -0,0 +1,19 @@
+import { Command } from '@commander-js/extra-typings';
+import { describe, expect, test } from 'vitest';
+
+import { program } from '../src/program';
+
+describe('CLI program', () => {
+  test('properly configured', () => {
+    expect(program).toBeInstanceOf(Command);
+    expect(program.name()).toBe(process.env.npm_package_name);
+    expect(program.version()).toBe(process.env.npm_package_version);
+    expect(program.description()).toBe('CLI tool for Catalyst development');
+  });
+
+  test('has expected commands', () => {
+    const commands = program.commands.map((cmd) => cmd.name());
+
+    expect(commands).toContain('version');
+  });
+});