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

Also add .prettierignore for ignored files and .prettierrc.yaml
for standard print width.

Author: Michael Buchar

.github/workflows/ci.yml

@@ -149,6 +149,20 @@ jobs:
           sudo apt-get install shfmt
           ./run-tests.sh --check-shfmt
 
+  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 fomatting
+        run: |
+          npm install prettier --global
+          ./run-tests.sh --check-prettier
+
   docs-sphinx:
     runs-on: ubuntu-24.04
     steps:
@@ -240,8 +254,7 @@ jobs:
   release-docker:
     runs-on: ubuntu-24.04
     if: >
-      vars.RELEASE_DOCKER == 'true' &&
-      github.event_name == 'push' &&
+      vars.RELEASE_DOCKER == 'true' && github.event_name == 'push' &&
       startsWith(github.ref, 'refs/tags/')
     needs:
       - docs-sphinx

.prettierignore

@@ -0,0 +1,3 @@
+.pytest_cache
+CHANGELOG.md
+docs/openapi.json

.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-server/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-server/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

@@ -29,4 +29,6 @@ recursive-include tests *.py
 recursive-include tests *.txt
 global-exclude *.py[co] .DS_Store
 exclude .editorconfig
+exclude .prettierrc.yaml
+exclude .prettierignore
 exclude .readthedocs.yaml

README.md

@@ -10,8 +10,8 @@
 ## About
 
 REANA-Server is a component of the [REANA](http://www.reana.io/) reusable and
-reproducible research data analysis platform. It implements the API Server
-that takes and performs REST API calls issued by REANA clients.
+reproducible research data analysis platform. It implements the API Server that
+takes and performs REST API calls issued by REANA clients.
 
 ## Features
 

docs/index.md

@@ -22,9 +22,9 @@
 
 ## REST API
 
-The REANA Server offers a REST API for management workloads
-(workflows, jobs, tasks, etc.) running on REANA Cloud.
-Detailed REST API documentation can be found <a href="_static/api.html">here</a>.
+The REANA Server offers a REST API for management workloads (workflows, jobs,
+tasks, etc.) running on REANA Cloud. Detailed REST API documentation can be
+found <a href="_static/api.html">here</a>.
 
 ```{eval-rst}
 .. automodule:: reana_server.rest.ping

run-tests.sh

@@ -143,6 +143,10 @@ check_shfmt() {
     shfmt -d .
 }
 
+check_prettier() {
+    prettier -c .
+}
+
 check_all() {
     check_commitlint
     check_shellcheck
@@ -159,6 +163,7 @@ check_all() {
     check_yamllint
     check_shfmt
     check_markdownlint
+    check_prettier
 }
 
 if [ $# -eq 0 ]; then
@@ -184,5 +189,6 @@ case $arg in
 --check-yamllint) check_yamllint ;;
 --check-shfmt) check_shfmt ;;
 --check-markdownlint) check_markdownlint ;;
+--check-prettier) check_prettier ;;
 *) echo "[ERROR] Invalid argument '$arg'. Exiting." && exit 1 ;;
 esac