feat: recursively copy cwd into temp folder by matthewvolk · Pull Request #2479 · bigcommerce/catalyst

matthewvolk · 2025-07-16T15:29:55Z

What/Why?

Adds consola for logging
Runs CLI tests in all popular OS's to match the different environments where our customers run the CLI
Recursively copy a Catalyst project to a temporary directory, OS-agnostic API's from Node.js are being used
Includes tests

Testing

Includes unit tests

Migration

N/A

changeset-bot · 2025-07-16T15:29:59Z

⚠️ No Changeset found

Latest commit: 91d0d22

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2025-07-16T15:30:00Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
catalyst-canary	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 16, 2025 6:09pm

4 Skipped Deployments

Name	Status	Preview	Updated (UTC)
catalyst	⬜️ Ignored (Inspect)		Jul 16, 2025 6:09pm
catalyst-au	⬜️ Ignored (Inspect)	Visit Preview	Jul 16, 2025 6:09pm
catalyst-b2b	⬜️ Ignored (Inspect)	Visit Preview	Jul 16, 2025 6:09pm
catalyst-uk	⬜️ Ignored (Inspect)	Visit Preview	Jul 16, 2025 6:09pm

jorgemoya

Looks good to me, just have some questions.

jorgemoya · 2025-07-16T16:45:35Z

+}
+
+export const build = new Command('build')
+  .option('--keep-temp-dir', 'Keep the temporary directory after the build')


Should we set the pattern to use kebab case for all options? In preference over camel case?

Yeah, POSIX standardized on --kebab-case convention, so it's what people are used to IMO. Commander automatically transforms those to camel case too:

Multi-word options such as "--template-engine" are camel-cased, becoming program.opts().templateEngine etc.

jorgemoya · 2025-07-16T16:46:15Z

+import { cp, mkdtemp, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join, relative, sep } from 'node:path';


Curious to understand why we use these libs instead of using path or fs?

Not required, I just do it to explicitly indicate a built-in Node.js module and avoid ambiguity between built-ins and potentially conflicting userland modules (like https://www.npmjs.com/package/test vs node:test)

jorgemoya · 2025-07-16T16:47:34Z

+    await expect(access(path)).rejects.toThrow();
+  });
+
+  test('cleanup is idempotent', async () => {


idempotent TIL

Yeah, in other words, cleanup() should not fail on the second call

jorgemoya · 2025-07-16T16:48:13Z

+
+import { createFilter, mkTempDir } from '../../src/commands/build';
+
+describe('mkTempDir', () => {


Should we wrap all describes under the build command describe?

Chatted offline, will leave as is until it gets unwieldy

…rtal (#2504) * Version Packages (`canary`) (#2452) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Bump next to latest canary (#2465) * docs: how to verify new merge base established when syncing (#2451) Improve explanation around the importance of establishing a new merge base every time `canary` is merged into `integrations/makeswift` * chore(core): remove runtime edge declarations (#2464) * Update translations (#2468) * feat(other): LOCAL-1444 delivery translation * chore(core): create translations patch --------- Co-authored-by: bc-svc-local <bc-svc-local@users.noreply.github.com> Co-authored-by: Jorge Moya <jorge.moya@bigcommerce.com> * Use min and max purchase quantity to set bounds of quantity number input (#2474) * chore: update ci to include @bigcommerce/catalyst (#2463) * chore: update deps mostly related to packages/cli (#2461) * chore: use @commander-js/extra-typings as devDep (#2462) * feat: render scripts from Script Manager (#2477) * chore: hoist eslint plugins for ide support (#2460) * feat: recursively copy cwd into temp folder (#2479) * feat(cli): scaffold deploy command and generate bundle zip (#2481) * feat(cli): scaffold deploy command and generate bundle zip * feat: remove archiver and only use adm-zip * feat: add extra checks for build files * refactor: move checks around * fix: use .bigcommerce/dist as build path * refactor: split mkTempDir to own lib file and update tests * fix: remove file * fix: set default value for prefix * fix: remove extra-typings * feat: install and build all deps required to bundle catalyst (#2486) * chore: bump opennextjs-cloudflare version (#2487) * feat(cli): generate upload signature and upload bundle.zip (#2484) * feat(cli): generate upload signature and upload bundle.zip * feat: read from env variables * feat: use zod to validate response * refactor: parse * feat: read api host from env * refactor: infer option types in deploy command action (#2490) * feat: copy templates from cli to catalyst build tmpdir (#2489) * Version Packages (`canary`) (#2466) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Nathan Booker <bookernath@users.noreply.github.com> Co-authored-by: Matthew Volk <matt.volk@bigcommerce.com> Co-authored-by: Jorge Moya <jorge.moya@bigcommerce.com> Co-authored-by: bc-svc-local <102379007+bc-svc-local@users.noreply.github.com> Co-authored-by: bc-svc-local <bc-svc-local@users.noreply.github.com>

matthewvolk requested a review from a team July 16, 2025 15:29

matthewvolk force-pushed the CATALYST-1386-copy-to-temp branch from ec4395d to 92f5785 Compare July 16, 2025 15:32

vercel Bot deployed to Preview – catalyst-canary July 16, 2025 15:34 View deployment

jorgemoya approved these changes Jul 16, 2025

View reviewed changes

feat: recursively copy cwd into temp folder

91d0d22

matthewvolk force-pushed the CATALYST-1386-copy-to-temp branch from 92f5785 to 91d0d22 Compare July 16, 2025 18:07

vercel Bot deployed to Preview – catalyst-canary July 16, 2025 18:09 View deployment

matthewvolk added this pull request to the merge queue Jul 16, 2025

Merged via the queue into canary with commit 778bd21 Jul 16, 2025
12 checks passed

matthewvolk deleted the CATALYST-1386-copy-to-temp branch July 16, 2025 18:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: recursively copy cwd into temp folder#2479

feat: recursively copy cwd into temp folder#2479
matthewvolk merged 1 commit into
canaryfrom
CATALYST-1386-copy-to-temp

matthewvolk commented Jul 16, 2025

Uh oh!

changeset-bot Bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

vercel Bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

jorgemoya left a comment

Uh oh!

jorgemoya Jul 16, 2025

Uh oh!

matthewvolk Jul 16, 2025

Uh oh!

jorgemoya Jul 16, 2025

Uh oh!

matthewvolk Jul 16, 2025

Uh oh!

jorgemoya Jul 16, 2025

Uh oh!

matthewvolk Jul 16, 2025

Uh oh!

jorgemoya Jul 16, 2025 •

edited

Loading

Uh oh!

matthewvolk Jul 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		import { createFilter, mkTempDir } from '../../src/commands/build';

		describe('mkTempDir', () => {

Uh oh!

Conversation

matthewvolk commented Jul 16, 2025

What/Why?

Testing

Migration

Uh oh!

changeset-bot Bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel Bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jorgemoya left a comment

Choose a reason for hiding this comment

Uh oh!

jorgemoya Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

matthewvolk Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

jorgemoya Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

matthewvolk Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

jorgemoya Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

matthewvolk Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

jorgemoya Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthewvolk Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented Jul 16, 2025 •

edited

Loading

vercel Bot commented Jul 16, 2025 •

edited

Loading

jorgemoya Jul 16, 2025 •

edited

Loading