Skip to content

Conversation

@IamLRBA
Copy link

@IamLRBA IamLRBA commented May 20, 2025

Fixes

Description

This approach ensures consistent code formatting across environments without requiring contributors to install Prettier or Husky locally. The changes made are;

  • Added docker/run-prettier.sh to check code formatting inside a Node container
  • Added optional docker/format-prettier.sh script to automatically format the code
  • Introduced .prettierrc and .prettierignore to configure and exclude paths
  • Updated README.md with instructions for running Prettier via Docker

Technical details

This avoids inconsistencies in formatting between contributors' IDEs and enforces a standard style without requiring Node-based tools like Husky or lint-staged, which are not part of this Python-based project.

Tests

  • Run Prettier Check
    ./docker/run-prettier.sh

  • Auto-Format
    ./docker/format-prettier.sh

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@IamLRBA IamLRBA requested review from a team as code owners May 20, 2025 17:50
@IamLRBA IamLRBA requested review from Shafiya-Heena, TimidRobot and zackkrida and removed request for a team May 20, 2025 17:50
@netlify
Copy link

netlify bot commented May 20, 2025

Deploy Preview for creativecommons-chooser ready!

Name Link
🔨 Latest commit 4ed2c78
🔍 Latest deploy log https://app.netlify.com/projects/creativecommons-chooser/deploys/682cc0e0816ff20008aa8073
😎 Deploy Preview https://deploy-preview-573--creativecommons-chooser.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@cc-open-source-bot cc-open-source-bot moved this to In review in possumbilities May 20, 2025
@possumbilities possumbilities requested review from possumbilities and removed request for a team, Shafiya-Heena, TimidRobot and zackkrida June 4, 2025 16:19
@possumbilities
Copy link
Contributor

@IamLRBA Hi! I think we would want the implementation to better match what is happening in the Search Portal repository. So that the prettier + docker setups are all the same across repositories.

That's also mentioned in the original Issue as well in this comment:

@possumbilities
Copy link
Contributor

This was resolved by:

Closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

[Feature] enable Prettier to run automatically

2 participants