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

Author: tiborsimko

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.25.7'
+          go-version: "1.25.7"
 
       - name: Check shell completions are up-to-date
         run: ./run-tests.sh --docs-shell-completions
@@ -32,11 +32,25 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.25.7'
+          go-version: "1.25.7"
 
       - name: Check Go code formatting
         run: ./run-tests.sh --format-go
 
+  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:
@@ -57,7 +71,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.25.7'
+          go-version: "1.25.7"
 
       - name: Run Go test suite
         run: ./run-tests.sh --go-tests
@@ -102,7 +116,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.25.7'
+          go-version: "1.25.7"
 
       - name: Run Go audit checks
         run: ./run-tests.sh --lint-goaudit

.markdownlint.yaml

@@ -1,2 +1,2 @@
 # Allow prompt dollar sign in console examples without showing output
-MD014: false
+MD014: false

.prettierignore

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

.prettierrc.yaml

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

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-client-go/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-client-go/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

README.md

@@ -7,10 +7,10 @@
 
 ## About
 
-REANA-Client-Go is a component of the [REANA](https://www.reana.io/)
-reusable and reproducible research data analysis platform. It provides a
-command-line tool that allows researchers to submit, run, and manage
-their computational workflows.
+REANA-Client-Go is a component of the [REANA](https://www.reana.io/) reusable
+and reproducible research data analysis platform. It provides a command-line
+tool that allows researchers to submit, run, and manage their computational
+workflows.
 
 - seed workspace with input code and data
 - run computational workflows on remote compute clouds

run-tests.sh

@@ -115,6 +115,7 @@ lint_yamllint() {
 all() {
     docs_shell_completions
     format_go
+    format_prettier
     format_shfmt
     go_tests
     lint_commitlint
@@ -130,6 +131,7 @@ help() {
     echo "  --all                      Perform all checks [default]"
     echo "  --docs-shell-completions   Check shell completions are up-to-date"
     echo "  --format-go                Check formatting of Go code"
+    echo "  --format-prettier          Check formatting of Markdown etc files"
     echo "  --format-shfmt             Check formatting of shell scripts"
     echo "  --go-tests                 Check Go test suite"
     echo "  --help                     Display this help message"
@@ -151,6 +153,7 @@ case $arg in
 --help) help ;;
 --docs-shell-completions) docs_shell_completions ;;
 --format-go) format_go ;;
+--format-prettier) format_prettier ;;
 --format-shfmt) format_shfmt ;;
 --go-tests) go_tests ;;
 --lint-commitlint) lint_commitlint "$@" ;;

testdata/inputs/close_no_open.json

@@ -1,3 +1,3 @@
 {
   "message": "Workflow - my_workflow has no open interactive session."
-}
+}

testdata/inputs/common_empty.json

@@ -1 +1 @@
-{}
+{}

testdata/inputs/common_failed.json

@@ -4,4 +4,4 @@
   "user": "user",
   "workflow_id": "my_workflow_id",
   "workflow_name": "my_workflow"
-}
+}