feat(themes): add themes:export command#383
Open
luis-almeida wants to merge 2 commits into
Open
Conversation
Add zcli themes:export to create a Help Center theme export job, poll it to completion, and download the resulting zip to a target directory (default: cwd) as theme_<themeId>.zip.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds a zcli themes:export command to export a Help Center theme by creating an async export job, polling until completion, and downloading the resulting zip for local storage (enabling backups and round-trips).
Changes:
- Introduces
themes:exportoclif command (create export job → poll → download zip). - Adds supporting lib helpers for job creation and package download.
- Adds functional/unit tests and CLI docs for the new command.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/zcli-themes/tests/functional/export.test.ts | Functional coverage for themes:export success and failure paths. |
| packages/zcli-themes/src/types.ts | Adds ExportJob typing for export-job creation response. |
| packages/zcli-themes/src/lib/downloadThemePackage.ts | Downloads zip from presigned URL and writes it to disk. |
| packages/zcli-themes/src/lib/downloadThemePackage.test.ts | Unit tests for download/write and error behavior. |
| packages/zcli-themes/src/lib/createThemeExportJob.ts | Creates the export job via theming jobs API. |
| packages/zcli-themes/src/lib/createThemeExportJob.test.ts | Unit tests validating payload and error handling. |
| packages/zcli-themes/src/commands/themes/export.ts | New themes:export command implementation. |
| docs/themes.md | Documents the new themes:export command usage/options. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Address PR review: themes:export now creates the destination directory (recursive) before writing, so exporting to a not-yet-existing path no longer fails with ENOENT. Failure-path tests now use a sentinel throw so they can't silently pass when no error is raised.
Comment on lines
+17
to
+19
| static args = [ | ||
| { name: 'themeDirectory', required: true, default: '.' } | ||
| ] |
Comment on lines
+29
to
+30
| let { flags: { themeId }, argv: [themeDirectory] } = await this.parse(Export) | ||
| const destination = path.resolve(themeDirectory) |
| @@ -0,0 +1,188 @@ | |||
| import type { ExportJob } from '../../../zcli-themes/src/types' | |||
Comment on lines
+84
to
+87
| .it('should display success message when the theme is exported successfully', async ctx => { | ||
| await ExportCommand.run(['--themeId', '1234']) | ||
| expect(ctx.stdout).to.contain('Theme exported successfully theme ID: 1234') | ||
| }) |
| export default async function downloadThemePackage (downloadUrl: string, themeId: string, destination: string): Promise<string> { | ||
| CliUx.ux.action.start('Downloading theme package') | ||
|
|
||
| const filePath = path.join(destination, `theme_${themeId}.zip`) |
Comment on lines
+21
to
+22
| fs.mkdirSync(destination, { recursive: true }) | ||
| fs.writeFileSync(filePath, Buffer.from(response.data)) |
Comment on lines
+21
to
+22
| fs.mkdirSync(destination, { recursive: true }) | ||
| fs.writeFileSync(filePath, Buffer.from(response.data)) |
Comment on lines
+28
to
+30
| } catch (error) { | ||
| handleThemeApiError(error as AxiosError) | ||
| } |
melzreal
approved these changes
Jul 10, 2026
| // waits for the export to finish (the completed job's `data` is null). | ||
| const downloadUrl = job.data.download.url | ||
|
|
||
| await pollJobStatus(destination, job.id) |
There was a problem hiding this comment.
nit: pollJobStatus says it receives themePath as an argument so probably would make sense to call it that instead of destination
BrunoBFerreira
left a comment
BrunoBFerreira
left a comment
Contributor
There was a problem hiding this comment.
Left two comments but overall looks really good.
Thank you for addressing this 🙏
|
|
||
| beforeEach(() => { | ||
| fetchStub = sinon.stub(global, 'fetch') | ||
| writeFileStub = sinon.stub(fs, 'writeFileSync') |
Contributor
There was a problem hiding this comment.
Should we also stub mkdirSync?
| } | ||
| }) | ||
| }) | ||
| }) |
Contributor
There was a problem hiding this comment.
Should we also add a test with the --themeId missing? I believe that path is not covered.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
zcli-themeswraps the Help Center theming endpoints (import/update/publish/delete/list) but had no way to pull a theme back down. This addszcli themes:export, closing that gap so users can retrieve a theme as a zip — enabling round-trips (export → edit → re-import) and backups without leaving the CLI.de0cda3feat(themes): add themes:export commandAdd zcli themes:export to create a Help Center theme export job, poll it
to completion, and download the resulting zip to a target directory
(default: cwd) as theme_.zip.
8ca6093fix(themes): create export destination dir and harden failure testsAddress PR review: themes:export now creates the destination directory
(recursive) before writing, so exporting to a not-yet-existing path no
longer fails with ENOENT. Failure-path tests now use a sentinel throw so
they can't silently pass when no error is raised.
Detail
Wraps the async theme export job API: create job (
POST .../jobs/themes/exports) → poll to completion → download the zip from the presigned URL in the created job.The theme is written to the optional
[THEMEDIRECTORY]arg (default: cwd) astheme_<themeId>.zip.themeIdis prompted for when the flag is omitted, mirroringthemes:publish/themes:delete.Checklist