ci(prettier): add Prettier code formatting checks (#254)

Author: tiborsimko

.github/workflows/ci.yml

@@ -51,6 +51,20 @@ jobs:
           pip install black
           ./run-tests.sh --format-black
 
+  format-prettier:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+
+      - name: Check Prettier code formatting
+        run: |
+          npm install prettier --global
+          ./run-tests.sh --format-prettier
+
   format-shfmt:
     runs-on: ubuntu-24.04
     steps:

.prettierignore

@@ -0,0 +1,2 @@
+.pytest_cache
+CHANGELOG.md

.prettierrc.yaml

@@ -0,0 +1,2 @@
+printWidth: 80
+proseWrap: always

.release-please-config.json

@@ -5,9 +5,13 @@
     ".": {
       "changelog-sections": [
         { "type": "build", "section": "Build", "hidden": false },
-        { "type": "feat", "section": "Features", "hidden": false  },
+        { "type": "feat", "section": "Features", "hidden": false },
         { "type": "fix", "section": "Bug fixes", "hidden": false },
-        { "type": "perf", "section": "Performance improvements", "hidden": false },
+        {
+          "type": "perf",
+          "section": "Performance improvements",
+          "hidden": false
+        },
         { "type": "refactor", "section": "Code refactoring", "hidden": false },
         { "type": "style", "section": "Code style", "hidden": false },
         { "type": "test", "section": "Test suite", "hidden": false },

CONTRIBUTING.md

@@ -1,11 +1,12 @@
 # Contributing
 
-Bug reports, issues, feature requests, and other contributions are welcome.
-If you find a demonstrable problem that is caused by the REANA code, please:
+Bug reports, issues, feature requests, and other contributions are welcome. If
+you find a demonstrable problem that is caused by the REANA code, please:
 
-1. Search for [already reported problems](https://github.com/reanahub/reana-db/issues).
-2. Check if the issue has been fixed or is still reproducible on the
-   latest `master` branch.
+1. Search for
+   [already reported problems](https://github.com/reanahub/reana-db/issues).
+2. Check if the issue has been fixed or is still reproducible on the latest
+   `master` branch.
 3. Create an issue, ideally with **a test case**.
 
 If you create a pull request fixing a bug or implementing a feature, you can run

MANIFEST.in

@@ -11,6 +11,8 @@ include *.yaml
 include .dockerignore
 include .editorconfig
 include .flake8
+include .prettierignore
+include .prettierrc.yaml
 include LICENSE
 include pytest.ini
 exclude .readthedocs.yaml

README.md

@@ -10,8 +10,8 @@
 
 ## About
 
-REANA-DB is a component of the [REANA](http://www.reana.io/) reusable analysis platform.
-It contains REANA database models and utilities.
+REANA-DB is a component of the [REANA](http://www.reana.io/) reusable analysis
+platform. It contains REANA database models and utilities.
 
 ## Features
 

docs/index.md

@@ -1,9 +1,9 @@
 <!-- markdownlint-disable MD041 -->
 <!-- markdownlint-disable MD033 -->
 
-% The title is set to `REANA-DB docs` instead of `REANA-DB` as this is a
-% workaround to avoid having multiple HTML objects with the same id/anchor,
-% as the tile clashes with the CLI API documentation generated by sphinx_click
+% The title is set to `REANA-DB docs` instead of `REANA-DB` as this is a %
+workaround to avoid having multiple HTML objects with the same id/anchor, % as
+the tile clashes with the CLI API documentation generated by sphinx_click
 
 # REANA-DB docs
 

run-tests.sh

@@ -55,6 +55,10 @@ format_black() {
     black --check .
 }
 
+format_prettier() {
+    prettier -c .
+}
+
 format_shfmt() {
     shfmt -d .
 }
@@ -136,6 +140,7 @@ python_tests() {
 all() {
     docs_sphinx
     format_black
+    format_prettier
     format_shfmt
     lint_commitlint
     lint_flake8
@@ -154,6 +159,7 @@ help() {
     echo "  --all                Perform all checks [default]"
     echo "  --docs-sphinx        Check Sphinx docs build"
     echo "  --format-black       Check formatting of Python code"
+    echo "  --format-prettier    Check formatting of Markdown etc files"
     echo "  --format-shfmt       Check formatting of shell scripts"
     echo "  --help               Display this help message"
     echo "  --lint-commitlint    Check linting of commit messages"
@@ -178,6 +184,7 @@ case $arg in
 --help) help ;;
 --docs-sphinx) docs_sphinx ;;
 --format-black) format_black ;;
+--format-prettier) format_prettier ;;
 --format-shfmt) format_shfmt ;;
 --lint-commitlint) lint_commitlint "$@" ;;
 --lint-flake8) lint_flake8 ;;