Improve the build.sh script

designsecurity / progpilot

A static analysis tool for security

MIT License

332 stars 61 forks source link

Improve the build.sh script #19

Closed NicolasCARPi closed 4 years ago

NicolasCARPi commented 4 years ago

User /usr/bin/env instead of hardcoded path for bash
Check if command is in $PATH instead of hardcoding it in the script
Exit early if the command is not found
Use modern $() syntax instead of backticks
Group the cleanup commands together
Merge the mkdir commands in one with -p flag
Add -f to rm composer.lock command so it doesn't complain if file is not here
Script is now passing shellcheck with no errors
Add verbose flag to final move
Add phar builds to .gitignore

NicolasCARPi commented 4 years ago

Here is how I have it on my computer:

~/.bin and ./opt are in $PATH
~/.bin is for little script/programs I write
~/.opt is for userspace programs I download (like psalm, composer, hugo, terraform, ...)

I'd recommend doing the same for phar-composer.phar, adding it in .opt ;)

Also, I don't know if you're french, but in english, there is no space before :, ! or ?!

NicolasCARPi commented 4 years ago

I went with the change in the README because phar archives are (binary) artifacts that can be built from the source code and as such must not be commited to the repository.

See the commit message for the changes, and the generated README here.

I believe my changes make the installation/configuration/usage processes more clear to the average user.

Side note: before the Installation, a Description section would be welcome IMHO.

eric-therond commented 4 years ago

LGTM (I will take care of additional changes in the new README like formatting stuff like that).

Thank you a lot for this PR

PS: yes I am french ;)

Eric