ci(prettier): add Prettier code formatting checks (reanahub#491)

Author: CameronMcClymont

.github/workflows/ci.yml

@@ -168,6 +168,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 formatting
+        run: |
+          npm install prettier --global
+          ./run-tests.sh --check-prettier
+
   docs-sphinx:
     runs-on: ubuntu-24.04
     steps:
@@ -251,8 +265,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-job-controller/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-job-controller/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

@@ -34,3 +34,5 @@ recursive-include etc *.yaml
 recursive-include etc *.sh
 include etc/ngbauth-submit
 include krb5/Dockerfile
+exclude .editorconfig
+exclude .prettierignore

README.md

@@ -10,8 +10,8 @@
 ## About
 
 REANA-Job-Controller is a component of the [REANA](http://www.reana.io/)
-reusable and reproducible research data analysis platform. It takes care
-of executing and managing jobs on compute clouds.
+reusable and reproducible research data analysis platform. It takes care of
+executing and managing jobs on compute clouds.
 
 ## Features
 

docs/index.md

@@ -23,6 +23,7 @@ compute backends.
 ```
 
 ```{image} /_static/reana-job-manager.png
+
 ```
 
 ### Kubernetes
@@ -32,10 +33,8 @@ compute backends.
    :members:
 ```
 
-:::{note}
-REANA-Job-Controller supports the Kubernetes job manager by default, no need
-to pass any build argument.
-:::
+Note that REANA-Job-Controller supports the Kubernetes job manager by default,
+no need to pass any build argument.
 
 ### HTCondor
 
@@ -44,45 +43,36 @@ to pass any build argument.
    :members:
 ```
 
-:::{note}
-To build REANA-Job-Controller Docker image with HTCondor dependencies use build
-argument `COMPUTE_BACKENDS=kubernetes,htcondorcern`.
+Note that in order to build REANA-Job-Controller Docker image with HTCondor
+dependencies, you need to use a build argument
+`COMPUTE_BACKENDS=kubernetes,htcondorcern`:
 
 ```console
 $ reana-dev docker-build -c reana-job-controller \
   -b COMPUTE_BACKENDS=kubernetes,htcondorcern
 ```
 
-:::
-
 ### Slurm
 
 ```{eval-rst}
 .. automodule:: reana_job_controller.slurmcern_job_manager
    :members:
 ```
 
-:::{note}
-To build REANA-Job-Controller Docker image with Slum dependencies use build
-argument `COMPUTE_BACKENDS=kubernetes,slurmcern`.
+Note that in order to build REANA-Job-Controller Docker image with Slurm
+dependencies, you need to use a build argument
+`COMPUTE_BACKENDS=kubernetes,slurmcern`:
 
 ```console
 $ reana-dev docker-build -c reana-job-controller \
   -b COMPUTE_BACKENDS=kubernetes,slurmcern
 ```
 
-:::
-
-:::{note}
-Please note that CERN Slurm cluster access is not granted by
-[default](https://batchdocs.web.cern.ch/linuxhpc/access.html).
-:::
-
 ## REST API
 
 The REANA Job Controller API offers different endpoints to create, manage and
-monitor jobs.
-Detailed REST API documentation can be found <a href="_static/api.html">here</a>.
+monitor jobs. Detailed REST API documentation can be found
+<a href="_static/api.html">here</a>.
 
 ```{eval-rst}
 .. automodule:: reana_job_controller.rest

run-tests.sh

@@ -131,6 +131,10 @@ check_markdownlint() {
     markdownlint-cli2 "**/*.md" -i "node_modules/**"
 }
 
+check_prettier() {
+    prettier -c .
+}
+
 check_pytest() {
     clean_old_db_container
     start_db_container
@@ -164,6 +168,7 @@ check_all() {
     check_shfmt
     check_jsonlint
     check_markdownlint
+    check_prettier
 }
 
 check_all_darwin() {
@@ -215,6 +220,7 @@ case $arg in
 --check-jsonlint) check_jsonlint ;;
 --check-pytest) check_pytest ;;
 --check-shfmt) check_shfmt ;;
+--check-prettier) check_prettier ;;
 --check-markdownlint) check_markdownlint ;;
 --check-yamllint) check_yamllint ;;
 --check-all) check_all ;;