chore: add Docker-based Prettier integration #573
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Description
This approach ensures consistent code formatting across environments without requiring contributors to install Prettier or Husky locally. The changes made are;
docker/run-prettier.shto check code formatting inside a Node containerdocker/format-prettier.shscript to automatically format the code.prettierrcand.prettierignoreto configure and exclude pathsREADME.mdwith instructions for running Prettier via DockerTechnical 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.shAuto-Format
./docker/format-prettier.shChecklist
Update index.md).mainormaster).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