ci(prettier): add Prettier code formatting checks

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

Author: tiborsimko

.github/workflows/ci.yml

@@ -54,6 +54,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-commons/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-commons/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

@@ -13,6 +13,8 @@ include *.yml
 include .dockerignore
 include .editorconfig
 include .flake8
+include .prettierignore
+include .prettierrc.yaml
 include LICENSE
 include pytest.ini
 include tox.ini

README.md

@@ -11,8 +11,8 @@
 ## About
 
 REANA-Commons is a component of the [REANA](http://www.reana.io/) reusable and
-reproducible research data analysis platform. It provides common utilities and schemas
-shared by the REANA cluster components.
+reproducible research data analysis platform. It provides common utilities and
+schemas shared by the REANA cluster components.
 
 ## Features
 

reana_commons/openapi_specifications/reana_job_controller.json

@@ -171,9 +171,7 @@
             "type": "string"
           }
         ],
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "200": {
             "description": "Request succeeded. Returns boolean depicting if job is in cache.",
@@ -198,9 +196,7 @@
       "get": {
         "description": "This resource is not expecting parameters and it will return a list representing all active jobs in JSON format.",
         "operationId": "get_jobs",
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "200": {
             "description": "Request succeeded. The response contains the list of all active jobs.",
@@ -209,10 +205,7 @@
                 "jobs": {
                   "1612a779-f3fa-4344-8819-3d12fa9b9d90": {
                     "cmd": "date",
-                    "cvmfs_mounts": [
-                      "atlas.cern.ch",
-                      "atlas-condb.cern.ch"
-                    ],
+                    "cvmfs_mounts": ["atlas.cern.ch", "atlas-condb.cern.ch"],
                     "docker_img": "docker.io/library/busybox",
                     "job_id": "1612a779-f3fa-4344-8819-3d12fa9b9d90",
                     "max_restart_count": 3,
@@ -221,10 +214,7 @@
                   },
                   "2e4bbc1d-db5e-4ee0-9701-6e2b1ba55c20": {
                     "cmd": "date",
-                    "cvmfs_mounts": [
-                      "atlas.cern.ch",
-                      "atlas-condb.cern.ch"
-                    ],
+                    "cvmfs_mounts": ["atlas.cern.ch", "atlas-condb.cern.ch"],
                     "docker_img": "docker.io/library/busybox",
                     "job_id": "2e4bbc1d-db5e-4ee0-9701-6e2b1ba55c20",
                     "max_restart_count": 3,
@@ -245,9 +235,7 @@
         "summary": "Returns list of all active jobs."
       },
       "post": {
-        "consumes": [
-          "application/json"
-        ],
+        "consumes": ["application/json"],
         "description": "This resource is expecting JSON data with all the necessary information of a new job.",
         "operationId": "create_job",
         "parameters": [
@@ -261,9 +249,7 @@
             }
           }
         ],
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "201": {
             "description": "Request succeeded. The job has been launched.",
@@ -304,20 +290,15 @@
             "type": "string"
           }
         ],
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "200": {
             "description": "Request succeeded. The response contains details about the given job ID.",
             "examples": {
               "application/json": {
                 "job": {
                   "cmd": "date",
-                  "cvmfs_mounts": [
-                    "atlas.cern.ch",
-                    "atlas-condb.cern.ch"
-                  ],
+                  "cvmfs_mounts": ["atlas.cern.ch", "atlas-condb.cern.ch"],
                   "docker_img": "docker.io/library/busybox",
                   "job_id": "cdcf48b1-c2f3-4693-8230-b066e088c6ac",
                   "max_restart_count": 3,
@@ -344,9 +325,7 @@
     },
     "/jobs/{job_id}/": {
       "delete": {
-        "consumes": [
-          "application/json"
-        ],
+        "consumes": ["application/json"],
         "description": "This resource expects the `job_id` of the job to be deleted.",
         "operationId": "delete_job",
         "parameters": [
@@ -365,9 +344,7 @@
             "type": "string"
           }
         ],
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "204": {
             "description": "Request accepted. A request to delete the job has been sent to the\n  compute backend."
@@ -405,9 +382,7 @@
             "type": "string"
           }
         ],
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "200": {
             "description": "Request succeeded. The response contains the logs for the given job.",
@@ -431,14 +406,10 @@
     },
     "/shutdown": {
       "delete": {
-        "consumes": [
-          "application/json"
-        ],
+        "consumes": ["application/json"],
         "description": "All running jobs will be stopped and no more jobs will be scheduled. Kubernetes will call this endpoint before stopping the pod (PreStop hook).",
         "operationId": "shutdown",
-        "produces": [
-          "application/json"
-        ],
+        "produces": ["application/json"],
         "responses": {
           "200": {
             "description": "Request successful. All jobs were stopped.",