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

feat: Add shfmt #50

Merged
merged 2 commits into from
Nov 6, 2024
Merged

feat: Add shfmt #50

merged 2 commits into from
Nov 6, 2024

Conversation

martimlobao
Copy link
Owner

@martimlobao martimlobao commented Nov 6, 2024

  • add shfmt to apps
  • format existing shell scripts
  • add shfmt to CI

Summary by Sourcery

Add shfmt to the project for shell script formatting and integrate it into the CI workflow.

New Features:

  • Integrate shfmt into the project to autoformat shell script source code.

CI:

  • Add shfmt to the CI workflow to ensure consistent shell script formatting.

- add shfmt to apps
- format existing shell scripts
- add shfmt to CI
Copy link
Contributor

sourcery-ai bot commented Nov 6, 2024

Reviewer's Guide by Sourcery

This PR adds shfmt, a shell script formatting tool, to the development toolchain. The implementation includes adding shfmt to the list of applications and configuring it in the CI pipeline alongside existing shell script analysis tools.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Add shfmt tool to the application list
  • Add shfmt as a Homebrew formula with description
apps.toml
Configure shfmt in CI workflow
  • Add new shfmt job in the lint workflow
  • Configure shfmt with simplified formatting option (-s)
  • Use luizm/action-sh-checker action for shell script formatting
.github/workflows/lint_pr.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @martimlobao - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider consolidating the shellcheck and shfmt steps using a single luizm/action-sh-checker action since it supports both tools, which would simplify the workflow.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@martimlobao martimlobao merged commit 5d79c26 into main Nov 6, 2024
4 of 5 checks passed
@martimlobao martimlobao deleted the feat/shfmt branch November 6, 2024 23:28
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.

1 participant