ci: enable Prettier formatting (#1311)

## This PR

Enables Prettier for the repository, adding scripts to the root package
for checking + applying formatting. Adds a new CI job to check
formatting on PRs (and also moves the lint to there, as I don't think
lint needs to run across the Node.js version matrix).

I've also added husky + lint-staged to automatically run Prettier
against files being committed locally, but happy to pull that back out
if folks would prefer not to have that.

### Related Issues

Resolves #1302 

### Notes

I'd recommend reviewing the commits individually, except the last
commit, which was just the result of actually running Prettier.

---------

Signed-off-by: MattIPv4 <[email protected]>
Co-authored-by: Lukas Reining <[email protected]>

Author: MattIPv4

.github/ISSUE_TEMPLATE/bug.yaml

@@ -1,23 +1,23 @@
 name: 🐞 Bug
 description: Found a bug? We are sorry about that! Let us know! 🐛
-title: "[BUG] "
+title: '[BUG] '
 labels: [bug, Needs Triage]
 body:
-- type: textarea
-  attributes:
-    label: Observed behavior
-    description: What are you trying to do? Describe what you think went wrong during this.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Expected Behavior
-    description: A concise description of what you expected to happen.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Steps to reproduce
-    description: Describe as best you can the problem. Please provide us scenario file, logs or anything you have that can help us to understand.
-  validations:
-    required: false
+  - type: textarea
+    attributes:
+      label: Observed behavior
+      description: What are you trying to do? Describe what you think went wrong during this.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Describe as best you can the problem. Please provide us scenario file, logs or anything you have that can help us to understand.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/documentation.yaml

@@ -1,11 +1,11 @@
 name: 📓 Documentation
 description: Any documentation related issue/addition.
-title: "[DOC] "
+title: '[DOC] '
 labels: [documentation, Needs Triage]
 body:
-- type: textarea
-  attributes:
-    label: Change in the documentation
-    description: What should we add/remove/update in the documentation?
-  validations:
-    required: false
+  - type: textarea
+    attributes:
+      label: Change in the documentation
+      description: What should we add/remove/update in the documentation?
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature.yaml

@@ -1,14 +1,14 @@
 name: 💡 Feature
 description: Add new functionality to the project.
-title: "[FEATURE] "
+title: '[FEATURE] '
 labels: [enhancement, Needs Triage]
 body:
-- type: textarea
-  attributes:
-    label: Requirements
-    description: |
-      Ask us what you want! Please provide as many details as possible and describe how it should work.
+  - type: textarea
+    attributes:
+      label: Requirements
+      description: |
+        Ask us what you want! Please provide as many details as possible and describe how it should work.
 
-      Note: Spec and architecture changes require an [OFEP](https://github.com/open-feature/ofep).
-  validations:
-    required: false
+        Note: Spec and architecture changes require an [OFEP](https://github.com/open-feature/ofep).
+    validations:
+      required: false

.github/workflows/audit-pending-releases.yml

@@ -1,7 +1,7 @@
 on:
   push:
     branches:
-      - "release-please**"
+      - 'release-please**'
 
 env:
   CORE_PACKAGE: core
@@ -29,6 +29,6 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
-          registry-url: "https://registry.npmjs.org"
-          cache: "npm"
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'

.github/workflows/coverage.yml

@@ -15,9 +15,9 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          registry-url: "https://registry.npmjs.org"
-          node-version-file: ".nvmrc"
-          cache: "npm"
+          registry-url: 'https://registry.npmjs.org'
+          node-version-file: '.nvmrc'
+          cache: 'npm'
 
       - name: Install
         run: npm ci

.github/workflows/dco-merge-group.yml

@@ -9,4 +9,4 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.actor != 'renovate[bot]' }}
     steps:
-      - run: echo "dummy DCO workflow (it won't run any check actually) to trigger by merge_group in order to enable merge queue"
+      - run: echo "dummy DCO workflow (it won't run any check actually) to trigger by merge_group in order to enable merge queue"

.github/workflows/pr-checks.yaml

@@ -11,7 +11,7 @@ on:
   merge_group:
 
 jobs:
-  build-test-lint:
+  build-test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -26,32 +26,48 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          cache: 'npm'
 
       - name: Install
         run: npm ci
 
       - name: Build
         run: npm run build
 
-      - name: Lint
-        run: npm run lint
-
       - name: Test Jest Projects
         run: npm run test:jest
 
       - name: Test Angular SDK
         run: npm run test:angular
 
+  format-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install
+        run: npm ci
+
+      - name: Format
+        run: npm run format
+
+      - name: Lint
+        run: npm run lint
+
   codecov-and-docs:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
-          cache: "npm"
+          node-version-file: '.nvmrc'
+          cache: 'npm'
 
       - name: Install
         run: npm ci
@@ -72,8 +88,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
-          cache: "npm"
+          node-version-file: '.nvmrc'
+          cache: 'npm'
 
       - name: Install
         run: npm ci

.github/workflows/release-please.yml

@@ -17,7 +17,7 @@ jobs:
           command: manifest
           token: ${{secrets.RELEASE_PLEASE_ACTION_TOKEN}}
           default-branch: main
-          signoff: "OpenFeature Bot <[email protected]>"
+          signoff: 'OpenFeature Bot <[email protected]>'
     outputs:
       release_created: ${{ steps.release.outputs.releases_created }}
       all: ${{ toJSON(steps.release.outputs) }}
@@ -42,7 +42,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
+          node-version-file: '.nvmrc'
       - name: Update npm to >=11.5.1 (for OIDC support)
         run: npm install -g npm@^11.5.1
       - name: Install dependencies
@@ -70,9 +70,9 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
-          registry-url: "https://registry.npmjs.org"
-          cache: "npm"
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
       - name: Update npm (for OIDC auth)
         run: npm install -g npm@^11.5.1
       - name: Build Packages

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*": "npx prettier --write --ignore-unknown"
+}