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.

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

Update CLI help message to represent current options #243

Closed
nobkd opened this issue Mar 26, 2024 · 1 comment · Fixed by #246
Closed

Update CLI help message to represent current options #243

nobkd opened this issue Mar 26, 2024 · 1 comment · Fixed by #246
Assignees

Comments

@nobkd
Copy link
Collaborator

nobkd commented Mar 26, 2024

Options
-r or --root Source directory. Default "." (current working dir)
-p or --production Build production version / Show production stats
-e or --environment Read extra options to override defaults in site.yaml

Should contain all the stable options listed here:

if (['-p', '--production'].includes(arg)) args.is_prod = true
else if (['-v', '--version'].includes(arg) && !args.cmd) args.version = true
else if (['-n', '--dry-run'].includes(arg)) args.dryrun = true
else if (['-h', '--help'].includes(arg)) args.help = true
else if (['-v', '--verbose'].includes(arg)) args.verbose = true
else if (['-s', '--stats'].includes(arg)) args.stats = true
else if (['-b', '--esbuild'].includes(arg)) args.esbuild = true
else if (['-P', '--push'].includes(arg)) args.push = true
else if (['-I', '--init'].includes(arg)) args.init = true
// string values
else if (['-e', '--environment'].includes(arg)) opt = 'env'
else if (['-r', '--root'].includes(arg)) opt = 'root'

E.g. -I can be really great, when you want to force refresh your dist output. Or -s if you run a production build and want to print the stats with the same command.

(If you want to, I can try making a PR with updated options + descriptions. I would leave --push out for now, as I think it was for not-ready-deploy-stuff?)

@nobkd nobkd added the question Further information is requested label Mar 26, 2024
@tipiirai
Copy link
Contributor

This would be great and much appreciated. And --push should be left out as you mentioned. It is a mega-buggy beta and only works on my laptop ATM.

@nobkd nobkd self-assigned this Mar 27, 2024
@nobkd nobkd added improvement and removed question Further information is requested labels Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants