Skip to content

Various improvements to check.sh #256

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 1 commit into from
May 2, 2023

Conversation

ttencate
Copy link
Contributor

@ttencate ttencate commented May 2, 2023

  • allow spaces and other funny characters in GODOT4_BIN value
  • add -h and help as aliases for --help
  • remove toolchain variable; add RUSTUP_TOOLCHAIN example (take note @lilizoey, I think you were using this one)
  • properly escape logged commands and arguments if they contain spaces

Non-functional improvements:

  • pass shellcheck
  • stop using sh'isms like [ ]

@Bromeon Bromeon added quality-of-life No new functionality, but improves ergonomics/internals c: tooling CI, automation, tools labels May 2, 2023
Copy link
Member

@Bromeon Bromeon left a comment

Choose a reason for hiding this comment

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

Very very nice, thanks so much!
It's great that someone actually capable in bash had look at this 🙂

-h | --help | help)
echo "$HELP_TEXT"
exit 0
Copy link
Member

Choose a reason for hiding this comment

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

Probably -h|--help should be enough, no? Just to streamline usage a bit.

Copy link
Contributor Author

@ttencate ttencate May 2, 2023

Choose a reason for hiding this comment

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

Plain help without any hyphens is a hidden feature, super simple to add and might save someone a few seconds if they try it as a guess. Documenting it would just clutter help output, since we'd also need to specify that it's mutually exclusive with other non-option commands.

Which reminds me, let me point at --help in the "Unrecognized argument" error message.

@ttencate ttencate force-pushed the feature/check.sh_improvements branch from 7334a7c to 3e7582a Compare May 2, 2023 10:06
Copy link
Member

@Bromeon Bromeon left a comment

Choose a reason for hiding this comment

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

Looks mostly good to me.

Once the color is reverted, feel free to bors r+ the PR as soon as you're ready.
Expect a bors deprecation message 😉

- allow spaces and other funny characters in GODOT4_BIN value
- add -h and help as aliases for --help
- remove toolchain variable; add RUSTUP_TOOLCHAIN example
- properly escape logged commands and arguments if they contain spaces

Non-functional improvements:

- pass shellcheck
- stop using sh'isms like [ ]
@ttencate ttencate force-pushed the feature/check.sh_improvements branch from 3e7582a to 9209da6 Compare May 2, 2023 11:34
@ttencate
Copy link
Contributor Author

ttencate commented May 2, 2023

bors r+

@bors
Copy link
Contributor

bors bot commented May 2, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit e27a69e into godot-rust:master May 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: tooling CI, automation, tools quality-of-life No new functionality, but improves ergonomics/internals
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants