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.

Sign up for GitHub

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

Jump to bottom

Add pre-commit hook to format shell scripts #847

Closed
dhruvkb opened this issue Mar 6, 2023 · 1 comment · Fixed by #1128
Closed

Add pre-commit hook to format shell scripts #847

dhruvkb opened this issue Mar 6, 2023 · 1 comment · Fixed by #1128
Assignees
@msolorio
Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: mgmt Related to repo management and automations

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Mar 6, 2023

Problem

We have quite a lot of shell scripts in the codebase. Prettier doesn't format them.

Description

shfmt is a tool for formatting shell programs. It is available as a pre-commit hook and can be readily integrated with our linting setup.

Additional context

This will undoubted cause our existing scripts to be slightly changed to match the style guide. It might be worth discussing if the changes are worth it.
@dhruvkb dhruvkb added good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Mar 6, 2023
@msolorio
Copy link
Contributor

msolorio commented Apr 3, 2023

Hi @WordPress/openverse-maintainers! I would like to pick this up if that is alright.

@msolorio msolorio mentioned this issue Apr 3, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@msolorio msolorio

Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: mgmt Related to repo management and automations
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add sh fmt pre commit hook msolorio/openverse
2 participants
@msolorio @dhruvkb