Skip to content

feat: allow spaces in CLI name for help output #42

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.

Sign up for GitHub

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

Open
Rugvip wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: allow spaces in CLI name for help output #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ function cli<
throw new Error('Options is required');
}

if ('name' in options && (!options.name || !isValidScriptName(options.name))) {
if ('name' in options && (!options.name || options.name !== options.name.trim())) {
throw new Error(`Invalid script name: ${stringify(options.name)}`);
}

Expand Down
21 changes: 14 additions & 7 deletions tests/specs/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,25 @@ describe('cli', () => {
}).toThrow('Invalid script name: ""');
});

test('invalid name format', () => {
test('name with leading space', () => {
expect(() => {
cli({
name: 'a b',
name: ' a',
});
}).toThrow('Invalid script name: "a b"');
}).toThrow('Invalid script name: " a"');
});

test('allowed name format', () => {
cli({
name: 'a.b_',
});
test('name with trailing space', () => {
expect(() => {
cli({
name: 'a ',
});
}).toThrow('Invalid script name: "a "');
});

test('allowed name formats', () => {
cli({ name: 'a.b_' });
cli({ name: 'multiple parent commands' });
});
});

Expand Down