Skip to content

fix(cli): list eject command in help output #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/cli/src/commands/eject/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ interface PackageJson {
}

const TUTORIALKIT_VERSION = pkg.version;

const REQUIRED_DEPENDENCIES = [
'@tutorialkit/runtime',
'@webcontainer/api',
Expand Down Expand Up @@ -141,6 +142,8 @@ async function _eject(flags: EjectOptions) {
}
}
}

return 0;
}

function validateDestination(folder: string, force: boolean) {
Expand Down
4 changes: 4 additions & 0 deletions packages/cli/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ async function runCommand(cmd: CLICommand, flags: yargs.Arguments): Promise<numb
tables: {
Commands: [
['create', 'Create new tutorial app'],
[
'eject',
'Move all default pages and components into your project, providing full control over the Astro app',
],
['help', 'Show this help message'],
],
},
Expand Down
18 changes: 18 additions & 0 deletions packages/cli/tests/create-tutorial.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { tmpdir } from 'node:os';
import path from 'node:path';
import { execa } from 'execa';
import { afterAll, beforeAll, expect, test } from 'vitest';
import { version } from '../package.json';

// on CI on windows we want to make sure to use the same drive, so we use a custom logic
const tmpDir =
Expand Down Expand Up @@ -230,6 +231,23 @@ test('cannot eject on an astro project that is not using TutorialKit 2', async (
).rejects.toThrow(`Could not find import to '@tutorialkit/astro'`);
});

test('--help prints out message', async () => {
const { stdout } = await execa('node', [cli, '--help']);

expect(stdout.replace(version, '[version]')).toMatchInlineSnapshot(`
"
@tutorialkit/cli v[version] Create tutorial apps powered by WebContainer API

Usage: @tutorialkit/cli [command] [...options]
@tutorialkit/cli [ -h | --help | -v | --version ]

Commands:
create Create new tutorial app
eject Move all default pages and components into your project, providing full control over the Astro app
help Show this help message"
`);
});

function normaliseSlash(filePath: string) {
return filePath.replace(/\\/g, '/');
}
Expand Down