Skip to content
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

Jump to bottom

Improve CLI errors handling. #591

Merged
merged 4 commits into from
Feb 23, 2024
Merged

Improve CLI errors handling. #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
34606e7
Improve CLI errors handling.
shimkiv Feb 22, 2024
b8540c5
Changelog update.
shimkiv Feb 22, 2024
c8cb478
Rearrange comments.
shimkiv Feb 22, 2024
846d1c7
Updated comments.
shimkiv Feb 23, 2024
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## Unreleased

### Changed

- Improve CLI error handling. [#591](https://github.com/o1-labs/zkapp-cli/pull/591)

## [0.17.2](https://github.com/o1-labs/zkapp-cli/compare/v17.1...v17.2) - 2024-02-19

### Changed
Expand Down
215 changes: 136 additions & 79 deletions src/bin/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,33 +41,38 @@ yargs(hideBin(process.argv))
.usage('Usage: $0 <command> [options]')
.strictCommands()
.strictOptions()

// https://github.com/yargs/yargs/issues/199
// https://github.com/yargs/yargs/blob/master/locales/en.json
.updateStrings({
'Missing required argument: %s': {
one: chalk.red('Missing required argument: %s'),
},
'Unknown argument: %s': {
one: chalk.red('Unknown argument: %s'),
},
'Unknown command: %s': {
one: chalk.red('Unknown command: %s'),
},
'Invalid values:': chalk.red('Invalid values:'),
'Argument: %s, Given: %s, Choices: %s': chalk.red(
`%s was %s. Must be one of: %s.`
),
'Not enough non-option arguments: %s': {
one: chalk.red('Not enough non-option arguments: %s'),
},
})
.updateStrings(getCustomizedStrings())
.demandCommand(1, chalk.red('Please provide a command.'))
.command(projectCli())
.command(fileCli())
.command(configCli())
.command(deployCli())
.command(exampleCli())
.command(systemCli())
.command(lightnetCli())
.version(
fs.readJsonSync(path.join(__dirname, '..', '..', 'package.json')).version
)
.alias('h', 'help')
.alias('v', 'version')
.epilog(
// chalk.reset is a hack to force the terminal to retain a line break below
chalk.reset(
`

█▄ ▄█ █ █▄ █ ▄▀▄
█ ▀ █ █ █ ▀█ █▀█

Mina Protocol
`
)
).argv;

.command(
['project [name]', 'proj [name]', 'p [name]'],
'Create a new project',
{
function projectCli() {
return {
command: ['project [name]', 'proj [name]', 'p [name]'],
describe: 'Create a new project',
builder: {
name: { demand: true, string: true, hidden: true },
ui: {
demand: false,
Expand All @@ -77,18 +82,24 @@ yargs(hideBin(process.argv))
description: 'Creates an accompanying UI',
},
},
async (argv) => await project(argv)
)
.command(
['file [name]', 'f [name]'],
'Create a file and generate the corresponding test file',
{ name: { demand: true, string: true, hidden: true } },
async (argv) => await file(argv.name)
)
.command(
['config [list] [lightnet]'],
'List or add a new deploy alias',
{
handler: async (argv) => await project(argv),
};
}

function fileCli() {
return {
command: ['file [name]', 'f [name]'],
describe: 'Create a file and generate the corresponding test file',
builder: { name: { demand: true, string: true, hidden: true } },
handler: async (argv) => await file(argv.name),
};
}

function configCli() {
return {
command: ['config [list] [lightnet]'],
describe: 'List or add a new deploy alias',
builder: {
list: {
alias: 'l',
demand: false,
Expand All @@ -108,12 +119,15 @@ yargs(hideBin(process.argv))
'Whether to automatically configure the deploy alias compatible with the lightweight Mina blockchain network.',
shimkiv marked this conversation as resolved.
Show resolved Hide resolved
},
},
async (argv) => await config(argv)
)
.command(
['deploy [alias]'],
'Deploy or redeploy a zkApp',
{
handler: async (argv) => await config(argv),
};
}

function deployCli() {
return {
command: ['deploy [alias]'],
describe: 'Deploy or redeploy a zkApp',
builder: {
alias: { demand: false, string: true, hidden: true },
y: {
alias: 'yes',
Expand All @@ -124,26 +138,41 @@ yargs(hideBin(process.argv))
'Respond `yes` to all confirmation prompts.\nAllows running non-interactively within a script.',
},
},
async (argv) => await deploy(argv)
)
.command(
['example [name]', 'e [name]'],
'Create an example project',
{
handler: async (argv) => await deploy(argv),
};
}

function exampleCli() {
return {
command: ['example [name]', 'e [name]'],
describe: 'Create an example project',
shimkiv marked this conversation as resolved.
Show resolved Hide resolved
builder: {
name: {
demand: false,
string: true,
hidden: false,
choices: Constants.exampleTypes,
},
},
async (argv) => await example(argv.name)
)
.command(['system', 'sys', 's'], 'Show system info', {}, () => system())
.command(
['lightnet <sub-command> [options]'],
'Manage the lightweight Mina blockchain network for zkApps development and testing purposes.\nMore information can be found at:\nhttps://docs.minaprotocol.com/zkapps/testing-zkapps-lightnet',
(yargs) => {
handler: async (argv) => await example(argv.name),
};
}

function systemCli() {
return {
command: ['system', 'sys', 's'],
describe: 'Show system info',
builder: {},
handler: () => system(),
};
}

function lightnetCli() {
return {
command: ['lightnet <sub-command> [options]'],
describe:
'Manage the lightweight Mina blockchain network for zkApps development and testing purposes.\nMore information can be found at:\nhttps://docs.minaprotocol.com/zkapps/testing-zkapps-lightnet',
shimkiv marked this conversation as resolved.
Show resolved Hide resolved
builder: (yargs) => {
yargs
.command(
[
Expand Down Expand Up @@ -300,8 +329,7 @@ yargs(hideBin(process.argv))
...commonOptions,
},
async (argv) => await lightnetFollowLogs(argv)
)
.demandCommand();
);
}
)
.command(
Expand Down Expand Up @@ -329,25 +357,54 @@ yargs(hideBin(process.argv))
...commonOptions,
},
async (argv) => await lightnetExplorer(argv)
)
.demandCommand();
}
)
.version(
fs.readJsonSync(path.join(__dirname, '..', '..', 'package.json')).version
)
.alias('h', 'help')
.alias('v', 'version')

.epilog(
// chalk.reset is a hack to force the terminal to retain a line break below
chalk.reset(
`

█▄ ▄█ █ █▄ █ ▄▀▄
█ ▀ █ █ █ ▀█ █▀█
);
},
};
}

Mina Protocol
`
)
).argv;
function getCustomizedStrings() {
// Overridden messages source can be found here:
// https://github.com/yargs/yargs/blob/master/locales/en.json
return {
'Not enough non-option arguments: got %s, need at least %s': {
shimkiv marked this conversation as resolved.
Show resolved Hide resolved
one: chalk.red(
'Not enough non-option arguments: got %s, need at least %s'
shimkiv marked this conversation as resolved.
Show resolved Hide resolved
),
other: chalk.red(
'Not enough non-option arguments: got %s, need at least %s'
),
},
'Too many non-option arguments: got %s, maximum of %s': {
one: chalk.red('Too many non-option arguments: got %s, maximum of %s'),
other: chalk.red('Too many non-option arguments: got %s, maximum of %s'),
},
'Missing argument value: %s': {
one: chalk.red('Missing argument value: %s'),
other: chalk.red('Missing argument values: %s'),
},
'Missing required argument: %s': {
one: chalk.red('Missing required argument: %s'),
other: chalk.red('Missing required arguments: %s'),
},
'Unknown argument: %s': {
one: chalk.red('Unknown argument: %s'),
other: chalk.red('Unknown arguments: %s'),
},
'Unknown command: %s': {
one: chalk.red('Unknown command: %s'),
other: chalk.red('Unknown commands: %s'),
},
'Invalid values:': chalk.red('Invalid values:'),
'Argument check failed: %s': chalk.red('Argument check failed: %s'),
'Implications failed:': chalk.red('Missing dependent arguments:'),
'Not enough arguments following: %s': chalk.red(
'Not enough arguments following: %s'
),
'Invalid JSON config file: %s': chalk.red('Invalid JSON config file: %s'),
'Arguments %s and %s are mutually exclusive': chalk.yellow(
'Arguments %s and %s are mutually exclusive'
),
deprecated: chalk.yellow('deprecated'),
'deprecated: %s': chalk.yellow('deprecated: %s'),
};
}
Loading