chore: run Prettier on commit + fix existing issues (#1511)

Signed-off-by: MattIPv4 <me@mattcowley.co.uk>

Author: MattIPv4

.eslintrc.json

@@ -2,7 +2,7 @@
   "root": true,
   "ignorePatterns": ["**/*"],
   "plugins": ["@nx"],
-  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
+  "extends": ["eslint:recommended", "prettier"],
   "overrides": [
     {
       "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
@@ -64,7 +64,17 @@
             "checkObsoleteDependencies": true,
             "checkVersionMismatches": true,
             "ignoredDependencies": ["jest-cucumber", "jest"],
-            "ignoredFiles": ["**/test/**", "**/tests/**", "**/e2e/**", "**/spec/**", "**/*.spec.ts", "**/*.spec.js", "**/*.test.ts", "**/*.test.js", "**/jest.*"]
+            "ignoredFiles": [
+              "**/test/**",
+              "**/tests/**",
+              "**/e2e/**",
+              "**/spec/**",
+              "**/*.spec.ts",
+              "**/*.spec.js",
+              "**/*.test.ts",
+              "**/*.test.js",
+              "**/jest.*"
+            ]
           }
         ]
       }

.github/ISSUE_TEMPLATE/add-hook.md

@@ -4,7 +4,6 @@ about: Add provider template
 title: Add {my-behavior} hook
 labels: enhancement
 assignees: ''
-
 ---
 
 # Add {my-behavior} hook
@@ -13,7 +12,7 @@ assignees: ''
 
 I want to add a hook which performs {my-behavior}.
 
-- it would be great if {my-behavior} could be included in some flag evaluations 
+- it would be great if {my-behavior} could be included in some flag evaluations
 - {my-behavior} would enable developers to be more productive!
 - other reasons!
 

.github/ISSUE_TEMPLATE/add-provider.md

@@ -4,7 +4,6 @@ about: Add provider template
 title: Add {my-system} provider
 labels: enhancement
 assignees: ''
-
 ---
 
 # Add {my-system} provider

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
     branches: ['main']
 
 jobs:
-  lint-test-build:
+  test-build:
     # Needed for nx-set-shas when run on the main branch
     permissions:
       actions: read
@@ -30,26 +30,48 @@ jobs:
       # This line is needed for nx affected to work when CI is running on a PR
       - run: git branch --track main origin/main || true
 
-      - run: if ! npx nx format:check ; then echo "Format check failed. Please run 'npx nx format:write'."; fi
-      - run: npx nx affected --base=origin/main --target=lint --parallel=3 --exclude=js-sdk-contrib
       - run: npx nx affected --base=origin/main --target=test --parallel=3 --ci --code-coverage --exclude=js-sdk-contrib
       - run: npx nx affected --base=origin/main --target=build --parallel=3 --exclude=js-sdk-contrib
 
+  format-lint:
+    # Needed for nx-set-shas when run on the main branch
+    permissions:
+      actions: read
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - run: npm ci
+      - uses: nrwl/nx-set-shas@v3
+      # This line is needed for nx affected to work when CI is running on a PR
+      - run: git branch --track main origin/main || true
+
+      - run: if ! npx nx format:check ; then echo "Format check failed. Please run 'npx nx format:write'."; fi
+      - run: npx nx affected --base=origin/main --target=lint --parallel=3 --exclude=js-sdk-contrib
+
   e2e:
-      runs-on: ubuntu-latest
-
-      steps:
-        - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-          with:
-            fetch-depth: 0
-            submodules: recursive
-        - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
-          with:
-            node-version-file: '.nvmrc'
-            cache: 'npm'
-
-        - name: Install
-          run: npm ci
-
-        - name: e2e
-          run: npm run e2e
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install
+        run: npm ci
+
+      - name: e2e
+        run: npm run e2e

.github/workflows/component-owners.yml

@@ -3,9 +3,9 @@ on:
   pull_request_target:
 
 permissions:
-  contents: read          # to read changed files
-  issues: write           # to read/write issue assignees
-  pull-requests: write    # to read/write PR reviewers
+  contents: read # to read changed files
+  issues: write # to read/write issue assignees
+  pull-requests: write # to read/write PR reviewers
 
 jobs:
   run_self:

.github/workflows/lint-pr.yml

@@ -25,16 +25,16 @@ jobs:
           header: pr-title-lint-error
           message: |
             Hey there and thank you for opening this pull request! 👋🏼
-            
+
             We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
             Details:
-            
+
             ```
             ${{ steps.lint_pr_title.outputs.error_message }}
             ```
       # Delete a previous comment when the issue has been resolved
       - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
         uses: marocchino/sticky-pull-request-comment@52423e01640425a022ef5fd42c6fb5f633a02728 # v2
-        with:   
+        with:
           header: pr-title-lint-error
           delete: true

.github/workflows/release-please.yml

@@ -37,7 +37,7 @@ jobs:
         if: ${{ steps.release.outputs.releases_created }}
         with:
           node-version-file: '.nvmrc'
-          registry-url: "https://registry.npmjs.org"
+          registry-url: 'https://registry.npmjs.org'
           cache: 'npm'
       - name: Update npm (for OIDC auth)
         if: ${{ steps.release.outputs.releases_created }}

.husky/pre-commit

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

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*": "npx nx format:write --files"
+}