chore(ci): add prettier formatter (#2570)

MikeMcC399 · web-flow · commit ebca93391dd6 · 2026-07-21T17:43:13.000+02:00
Add prettier workflow
Reformat files js, mjs, json, md &amp; yml

Remove eclint workflow

Exclude auto-generated TOC contents
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -11,10 +11,10 @@ Please fill in as much of the template below as you're able.
 
 ## Environment
 
-* **Platform**:
-* **Docker Version**:
-* **Node.js Version**:
-* **Image Tag**:
+- **Platform**:
+- **Docker Version**:
+- **Node.js Version**:
+- **Image Tag**:
 
 ## Expected Behavior
 
@@ -45,4 +45,3 @@ Tell us about the steps you took to encounter this bug with the image.
 <!--
 Tell us anything else you think we should know.
 -->
-
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -26,4 +26,3 @@ Please describe the desired behavior.
 <!--
 Please describe alternative solutions or features you have considered.
 -->
-
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -51,4 +51,3 @@ If you're unsure about any of these, don't hesitate to ask. We're here to help!
 - [ ] I have updated the documentation accordingly.
 - [ ] I have read the **CONTRIBUTING.md** document.
 - [ ] All new and existing tests passed.
-
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,7 +1,7 @@
 version: 2
 updates:
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
diff --git a/.github/workflows/automatic-updates.yml b/.github/workflows/automatic-updates.yml
@@ -3,7 +3,7 @@ name: Automatically update Docker image versions
 on:
   workflow_dispatch:
   schedule:
-    - cron: "*/15 * * * *"
+    - cron: '*/15 * * * *'
 
 jobs:
   build:
@@ -29,11 +29,11 @@ jobs:
         uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
         with:
           token: ${{ secrets.GH_API_TOKEN }}
-          author: "Node.js GitHub Bot <nodejs-github-bot@users.noreply.github.com>"
+          author: 'Node.js GitHub Bot <nodejs-github-bot@users.noreply.github.com>'
           branch: update-branch
           base: main
-          commit-message: "feat: Node.js ${{ steps.updt.outputs.result }}"
-          title: "feat: Node.js ${{ steps.updt.outputs.result }}"
+          commit-message: 'feat: Node.js ${{ steps.updt.outputs.result }}'
+          title: 'feat: Node.js ${{ steps.updt.outputs.result }}'
           delete-branch: true
           team-reviewers: |
             nodejs/docker
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -3,17 +3,17 @@ name: build-test
 on:
   push:
     paths:
-      - "**/Dockerfile"
-      - "**/docker-entrypoint.sh"
+      - '**/Dockerfile'
+      - '**/docker-entrypoint.sh'
       - genMatrix.js
-      - ".github/workflows/build-test.yml"
+      - '.github/workflows/build-test.yml'
 
   pull_request:
     paths:
-      - "**/Dockerfile"
-      - "**/docker-entrypoint.sh"
+      - '**/Dockerfile'
+      - '**/docker-entrypoint.sh'
       - genMatrix.js
-      - ".github/workflows/build-test.yml"
+      - '.github/workflows/build-test.yml'
 
 jobs:
   gen-matrix:
diff --git a/.github/workflows/doctoc.yml b/.github/workflows/doctoc.yml
@@ -3,9 +3,9 @@ name: Check generated TOCs
 on:
   pull_request:
     paths:
-      - "README.md"
-      - "docs/BestPractices.md"
-      - ".github/workflows/doctoc.yml"
+      - 'README.md'
+      - 'docs/BestPractices.md'
+      - '.github/workflows/doctoc.yml'
 
 permissions:
   contents: read
diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml
@@ -3,9 +3,9 @@ name: Check Markdown links
 on:
   pull_request:
     paths:
-      - "**/*.md"
-      - "markdown_link_check_config.json"
-      - ".github/workflows/markdown-link-check.yml"
+      - '**/*.md'
+      - 'markdown_link_check_config.json'
+      - '.github/workflows/markdown-link-check.yml'
 
 permissions:
   contents: read
diff --git a/.github/workflows/missing-checksum.yml b/.github/workflows/missing-checksum.yml
@@ -3,8 +3,8 @@ name: Check Alpine CHECKSUM
 on:
   pull_request:
     paths:
-      - ".github/workflows/missing-checksum.yml"
-      - "**/alpine*/Dockerfile"
+      - '.github/workflows/missing-checksum.yml'
+      - '**/alpine*/Dockerfile'
 
 permissions:
   contents: read
diff --git a/.github/workflows/official-pr.yml b/.github/workflows/official-pr.yml
@@ -6,11 +6,11 @@ on:
       - closed
 
     paths:
-      - ".github/workflows/official-pr.yml"
-      - "**/Dockerfile"
-      - "**/docker-entrypoint.sh"
-      - "versions.json"
-      - "stackbrew.js"
+      - '.github/workflows/official-pr.yml'
+      - '**/Dockerfile'
+      - '**/docker-entrypoint.sh'
+      - 'versions.json'
+      - 'stackbrew.js'
 
 jobs:
   pr:
@@ -46,8 +46,8 @@ jobs:
           push-to-fork: nodejs/official-images
           path: official-images
           branch: node
-          commit-message: "Node: ${{ github.event.pull_request.title }}"
-          title: "Node: ${{ github.event.pull_request.title }}"
+          commit-message: 'Node: ${{ github.event.pull_request.title }}'
+          title: 'Node: ${{ github.event.pull_request.title }}'
           body: |
             Pull Request: ${{ github.event.pull_request.html_url }}
             @PeterDaveHello @SimenB @nschonni @rafaelgss @mcollina
diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml
@@ -1,17 +1,16 @@
-name: Test Whitespace and line endings
+name: Check Prettier formatting
 
 on: [pull_request]
 
 permissions:
   contents: read
 
 jobs:
-  eclint:
+  prettier:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
         with:
           node-version: 'lts/*'
-      - run: npm i -g eclint
-      - run: eclint check
+      - run: npx prettier@3.9.5 --check .
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -12,7 +12,7 @@ on:
   schedule:
     - cron: '30 12 * * 6'
   push:
-    branches: [ "main" ]
+    branches: ['main']
 
 # Declare default permissions as read only.
 permissions: read-all
@@ -31,12 +31,12 @@ jobs:
       # actions: read
 
     steps:
-      - name: "Checkout code"
+      - name: 'Checkout code'
         uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
 
-      - name: "Run analysis"
+      - name: 'Run analysis'
         uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
         with:
           results_file: results.sarif
@@ -58,7 +58,7 @@ jobs:
 
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
-      - name: "Upload artifact"
+      - name: 'Upload artifact'
         uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: SARIF file
@@ -67,7 +67,7 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
-      - name: "Upload to code-scanning"
+      - name: 'Upload to code-scanning'
         uses: github/codeql-action/upload-sarif@7188fc363630916deb702c7fdcf4e481b751f97a # v4.37.1
         with:
           sarif_file: results.sarif
diff --git a/.github/workflows/shfmt.yml b/.github/workflows/shfmt.yml
@@ -3,8 +3,8 @@ name: Check Shell scripts
 on:
   pull_request:
     paths:
-      - "**/*.sh"
-      - ".github/workflows/shfmt.yml"
+      - '**/*.sh'
+      - '.github/workflows/shfmt.yml'
 
 permissions:
   contents: read
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,11 @@
+{
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": "versions.json",
+      "options": {
+        "printWidth": 38
+      }
+    }
+  ]
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,6 +16,7 @@ the Node.js TSC as final arbiter.
 ## Discussion Areas
 
 <!-- markdown-link-check-disable -->
+
 You can use Node.js channels (prefixed by `#nodejs-`) in the [OpenJSF Slack](https://slack-invite.openjsf.org/) workspace for discussions.
 <!-- markdown-link-check-enable -->
 
@@ -73,4 +74,4 @@ This task is undertaken by members of the repo team above.
 
 ## Adding dependencies to the base images
 
-NodeJS is a big ecosystem with a variety of different use cases. The docker images for node are designed to provide the minimum for running core node.  Additional dependencies (including dependencies for npm or yarn such as git) will not be included in these base images and will need to be included in descendent image.
+NodeJS is a big ecosystem with a variety of different use cases. The docker images for node are designed to provide the minimum for running core node. Additional dependencies (including dependencies for npm or yarn such as git) will not be included in these base images and will need to be included in descendent image.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -54,7 +54,7 @@ For governance, membership, major policy, or contentious technical changes:
 1. Open an issue or PR describing the decision and proposed outcome.
 2. Allow time for async feedback (normally at least 5 days).
 3. If no unresolved objections remain, a maintainer may merge/close with a
-    summary.
+   summary.
 
 If a final decision cannot be made using Consensus Seeking, the issue should be
 escalated to the Node.js TSC (for example by requesting `tsc-agenda`).
diff --git a/README.md b/README.md
@@ -2,11 +2,12 @@
 
 [**node - Docker Official Images on Docker Hub**](https://hub.docker.com/_/node)
 
-[![GitHub issues](https://img.shields.io/github/issues/nodejs/docker-node.svg "GitHub issues")](https://github.com/nodejs/docker-node)
-[![GitHub stars](https://img.shields.io/github/stars/nodejs/docker-node.svg "GitHub stars")](https://github.com/nodejs/docker-node)
+[![GitHub issues](https://img.shields.io/github/issues/nodejs/docker-node.svg 'GitHub issues')](https://github.com/nodejs/docker-node)
+[![GitHub stars](https://img.shields.io/github/stars/nodejs/docker-node.svg 'GitHub stars')](https://github.com/nodejs/docker-node)
 
 The official Node.js docker image, made with love by the node community.
 
+<!-- prettier-ignore-start -->
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 ## Table of Contents
@@ -42,6 +43,7 @@ The official Node.js docker image, made with love by the node community.
   - [Emeritus](#emeritus)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- prettier-ignore-end -->
 
 ## What is Node.js?
 
@@ -75,16 +77,16 @@ If you prefer Docker Compose:
 ```yml
 services:
   node:
-    image: "node:24"
-    user: "node"
+    image: 'node:24'
+    user: 'node'
     working_dir: /home/node/app
     environment:
       - NODE_ENV=production
     volumes:
       - ./:/home/node/app
     ports: # use if it is necessary to expose the container to the host machine
-      - "8888:8888"
-    command: ["npm", "start"]
+      - '8888:8888'
+    command: ['npm', 'start']
 ```
 
 You can then run using Docker Compose:
@@ -230,7 +232,7 @@ This image is based on version 13 of
 
 This image does not contain the common packages contained in the default tag and
 only contains the minimal packages needed to run `node`. Unless you are working
-in an environment where *only* the Node.js image will be deployed and you have
+in an environment where _only_ the Node.js image will be deployed and you have
 space constraints, we highly recommend using the default image of this
 repository.
 
diff --git a/build-automation.mjs b/build-automation.mjs
diff --git a/docs/BestPractices.md b/docs/BestPractices.md
diff --git a/genMatrix.js b/genMatrix.js
diff --git a/stackbrew.js b/stackbrew.js

-Original file line number
+Diff line change
 <!--
 Please describe alternative solutions or features you have considered.
 -->
+-