fix: eject command with no component specified (#1709)

Redocly · Sep 5, 2024 · 8240c78 · 8240c78 · github-actions · Sep 5, 2024
1 parent 81a1eca
commit 8240c78
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/.changeset/wicked-birds-jam.md b/.changeset/wicked-birds-jam.md
@@ -0,0 +1,5 @@
+---
+"@redocly/cli": patch
+---
+
+Added the ability to run the `eject` command without specifying components, which displays a selectable list of all available components.
diff --git a/packages/cli/src/commands/eject.ts b/packages/cli/src/commands/eject.ts
@@ -5,7 +5,7 @@ import type { VerifyConfigOptions } from '../types';
 
 export type EjectOptions = {
   type: 'component';
-  path: string;
+  path?: string;
   'project-dir'?: string;
   force: boolean;
 } & VerifyConfigOptions;
@@ -20,7 +20,7 @@ export const handleEject = async ({ argv }: CommandArgs<EjectOptions>) => {
       '@redocly/realm',
       'eject',
       `${argv.type}`,
-      `${argv.path}`,
+      `${argv.path ?? ''}`,
       `-d=${argv['project-dir']}`,
       argv.force ? `--force=${argv.force}` : '',
     ],

diff --git a/packages/cli/src/commands/preview-project/index.ts b/packages/cli/src/commands/preview-project/index.ts
@@ -26,7 +26,7 @@ export const previewProject = async ({ argv }: CommandArgs<PreviewProjectOptions
 
   spawn(
     npxExecutableName,
-    ['-y', packageName, 'develop', `--plan=${plan}`, `--port=${port || 4000}`],
+    ['-y', packageName, 'preview', `--plan=${plan}`, `--port=${port || 4000}`],
     {
       stdio: 'inherit',
       cwd: projectDir,

diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -817,7 +817,7 @@ yargs
     }
   )
   .command(
-    'eject <type> <path>',
+    'eject <type> [path]',
     'Helper function to eject project elements for customization.',
     (yargs) =>
       yargs
@@ -830,7 +830,6 @@ yargs
         .positional('path', {
           description: 'Filepath to a component or filepath with glob pattern.',
           type: 'string',
-          demandOption: true,
         })
         .options({
           'project-dir': {
St.^❔	Category	Percentage	Covered / Total
🟡	Statements	78.05%	4872/6242
🟡	Branches	66.39%	2007/3023
🟡	Functions	72.52%	805/1110
🟡	Lines	78.34%	4593/5863