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

Author: tiborsimko

.github/workflows/ci.yml

@@ -90,6 +90,20 @@ jobs:
       - name: Check Python code formatting
         run: ./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:
@@ -167,20 +181,6 @@ jobs:
           npm install jsonlint --global
           ./run-tests.sh --lint-jsonlint
 
-  lint-markdownlint:
-    runs-on: ubuntu-24.04
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-
-      - name: Lint Markdown files
-        run: |
-          npm install markdownlint-cli2 --global
-          ./run-tests.sh --lint-markdownlint
-
   lint-manifest:
     runs-on: ubuntu-24.04
     steps:
@@ -197,6 +197,20 @@ jobs:
       - name: Check Python manifest completeness
         run: ./run-tests.sh --lint-manifest
 
+  lint-markdownlint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+
+      - name: Lint Markdown files
+        run: |
+          npm install markdownlint-cli2 --global
+          ./run-tests.sh --lint-markdownlint
+
   lint-pydocstyle:
     runs-on: ubuntu-24.04
     steps:
@@ -285,22 +299,22 @@ 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:
       - docker-build
       - docs-cli-api
       - docs-cli-commands
       - docs-sphinx
       - format-black
+      - format-prettier
       - format-shfmt
       - lint-commitlint
       - lint-flake8
       - lint-hadolint
       - lint-jsonlint
-      - lint-markdownlint
       - lint-manifest
+      - lint-markdownlint
       - lint-pydocstyle
       - lint-shellcheck
       - lint-yamllint

.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

.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-client/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/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 *.yaml
 include *.yml
 include .editorconfig
 include .flake8
+include .prettierignore
+include .prettierrc.yaml
 include .yamllint.yaml
 include Dockerfile
 include LICENSE

README.md

@@ -11,8 +11,8 @@
 ## About
 
 REANA-Client 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
+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

docs/index.md

@@ -2,8 +2,8 @@
 <!-- markdownlint-disable MD033 -->
 
 % The title is set to `REANA-Client docs` instead of `REANA-Client` 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
+% 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-Client docs
 

run-tests.sh

@@ -90,22 +90,22 @@ lint_flake8() {
     flake8 .
 }
 
-lint_jsonlint() {
-    find . -name "*.json" -exec jsonlint -q {} \+
-}
-
 lint_hadolint() {
     docker run -i --rm docker.io/hadolint/hadolint:v2.12.0 <Dockerfile
 }
 
-lint_markdownlint() {
-    markdownlint-cli2 "**/*.md"
+lint_jsonlint() {
+    find . -name "*.json" -exec jsonlint -q {} \+
 }
 
 lint_manifest() {
     check-manifest
 }
 
+lint_markdownlint() {
+    markdownlint-cli2 "**/*.md"
+}
+
 lint_pydocstyle() {
     pydocstyle reana_client
 }
@@ -129,13 +129,14 @@ all() {
     docs_cli_commands
     docs_sphinx
     format_black
+    format_prettier
     format_shfmt
     lint_commitlint
     lint_flake8
     lint_hadolint
     lint_jsonlint
-    lint_markdownlint
     lint_manifest
+    lint_markdownlint
     lint_pydocstyle
     lint_shellcheck
     lint_yamllint
@@ -152,14 +153,15 @@ help() {
     echo "  --docs-cli-commands    Check CLI commands list"
     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"
     echo "  --lint-flake8          Check linting of Python code"
     echo "  --lint-hadolint        Check linting of Dockerfiles"
     echo "  --lint-jsonlint        Check linting of JSON files"
-    echo "  --lint-markdownlint    Check linting of Markdown files"
     echo "  --lint-manifest        Check linting of Python manifest"
+    echo "  --lint-markdownlint    Check linting of Markdown files"
     echo "  --lint-pydocstyle      Check linting of Python docstrings"
     echo "  --lint-shellcheck      Check linting of shell scripts"
     echo "  --lint-yamllint        Check linting of YAML files"
@@ -181,13 +183,14 @@ case $arg in
 --docs-cli-commands) docs_cli_commands ;;
 --docs-sphinx) docs_sphinx ;;
 --format-black) format_black ;;
+--format-prettier) format_prettier ;;
 --format-shfmt) format_shfmt ;;
 --lint-commitlint) lint_commitlint "$@" ;;
 --lint-flake8) lint_flake8 ;;
 --lint-hadolint) lint_hadolint ;;
 --lint-jsonlint) lint_jsonlint ;;
---lint-markdownlint) lint_markdownlint ;;
 --lint-manifest) lint_manifest ;;
+--lint-markdownlint) lint_markdownlint ;;
 --lint-pydocstyle) lint_pydocstyle ;;
 --lint-shellcheck) lint_shellcheck ;;
 --lint-yamllint) lint_yamllint ;;