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

shfmt and shellcheck kerl and bash completion scripts #463

Merged
merged 5 commits into from
Sep 26, 2023
Merged

shfmt and shellcheck kerl and bash completion scripts #463

merged 5 commits into from
Sep 26, 2023

Conversation

paulo-ferraz-oliveira
Copy link
Contributor

@paulo-ferraz-oliveira paulo-ferraz-oliveira commented Sep 24, 2023

Description

We add shfmt to CI, while formatting the bash completion, tool scripts and test files. We also run shellcheck on those and hopefully properly fix the issues. Many commits were issued to potentially ease review. The formatting ones and "just" the result of shfmt on the updated scripts, but will still be part of my self-review.

Motivation

This is basically a quality-of-life improvement, to have consistent formatting and (further) linting.

@paulo-ferraz-oliveira
Copy link
Contributor Author

@jadeallenx, I'm adding you as a reviewer with at least one CI ✅ for the builds...

@@ -52,6 +52,8 @@ and is repeatable in any way, should be tested, to guarantee backwards compatibl
- try not to introduce lines longer than 100 characters
- write small functions whenever possible, and use descriptive names for functions and variables
- comment tricky or non-obvious decisions made to explain their rationale
- the tool is linted with `shellcheck` and formatted with `shfmt`: make sure you run these locally
to avoid CI issues (their options are listed in `lint.yml`)
Copy link
Collaborator

Choose a reason for hiding this comment

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

whitespace issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Lemme check. I think it's just GitHub acting up 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see it like this, newline after the word locally

image

or did you mean something else?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In any case, since I got your approval, I'll go ahead and squash-merge to push more goodies. Feel free to reply to this and I'll act on it if there's something to change 😄
Thanks.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Nothing to change, just wanted to make sure you wanted the text that way

@paulo-ferraz-oliveira paulo-ferraz-oliveira merged commit a154f7a into kerl:master Sep 26, 2023
@paulo-ferraz-oliveira paulo-ferraz-oliveira deleted the feature/shfmt branch September 26, 2023 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants