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

Make --version and --help commands work without a project #115

Open
wants to merge 3 commits into
base: cudos-dev
Choose a base branch
from
Open

Make --version and --help commands work without a project #115

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e031b9
Make --version and --help commands work without a project
diogofferreira Oct 24, 2022
aba7dd2
Fix wrong identation
diogofferreira Oct 24, 2022
9472745
Add new approach based on exception handling
diogofferreira Oct 25, 2022
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
65 changes: 35 additions & 30 deletions packages/blast-core/cmd/blast-cmd.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,42 @@ const { customTasks } = require('../utilities/task')
const { getConfig } = require('../utilities/config-utils')

async function main() {
if (hideBin(process.argv)[0] !== 'init') {
getConfig()
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, removing the getConfig alone is sufficient! Any command which requires blast.config.js also calls getConfig itself. (getConfig doesn't store the config it loads anywhere, it just returns it. So anything which actually wants the config must call it again.)

It looks like getConfig is only called here to make blast fail immediately if there isn't a config, but it will always fail later if a command tries to actually use the config.

As it stands, putting getConfig inside a try block is actually the same as not doing it, because the only effect getConfig has here is to throw an immediately ignored exception if the config isn't there, and do nothing if it is.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is true for everything but the custom task command. Custom tasks were implemented in a different way from all other commands, with no entry points nor config loading (even though it needs it). The getConfig on main was in fact the only way custom tasks were getting the config, and simply transferring it to the task class won't work (at least with no exception handling or refactoring), as it will trigger a "config file now found" exception when out of a project folder.

try {
// load blast config
if (hideBin(process.argv)[0] !== 'init') {
getConfig()
}
} finally {
// load blast commands nevertheless, to enable usage
// of --version and --help globally
await yargs(hideBin(process.argv))
.scriptName('blast')
.usage('Usage: $0 <command> [arguments] [command options]')
.command(commands.initInfo)
.command(commands.compileInfo)
.command(commands.testInfo)
.command(commands.rustTestInfo)
.command(commands.nodeInfo)
.command(commands.runInfo)
.command(commands.keysInfo)
.command(customTasks)
.demandCommand(1, 'No command specified!') // user must specify atleast one command
.recommendCommands()
.strict() // checks if the command or optional parameters are specified, if not - user friendly error
.showHelpOnFail(true) // show help automatically
.help()
.fail((message, error) => {
// yargs error message goes here so this is a way to check if error is from yargs
if (message) {
yargs.showHelp()
console.error(message)
} else {
return setImmediate(() => { throw error })
}
process.exit(1)
})
.argv
}

await yargs(hideBin(process.argv))
.scriptName('blast')
.usage('Usage: $0 <command> [arguments] [command options]')
.command(commands.initInfo)
.command(commands.compileInfo)
.command(commands.testInfo)
.command(commands.rustTestInfo)
.command(commands.nodeInfo)
.command(commands.runInfo)
.command(commands.keysInfo)
.command(customTasks)
.demandCommand(1, 'No command specified!') // user must specify atleast one command
.recommendCommands()
.strict() // checks if the command or optional parameters are specified, if not - user friendly error
.showHelpOnFail(true) // show help automatically
.help()
.fail((message, error) => {
// yargs error message goes here so this is a way to check if error is from yargs
if (message) {
yargs.showHelp()
console.error(message)
} else {
return setImmediate(() => { throw error })
}
process.exit(1)
})
.argv
}

main()
Expand Down