Merge pull request #1691 from glimmerjs/fix-formatting

Fix Formatting, add verify step to CI that prevents accidentally git diffs from happening later
glimmerjs · Jan 23, 2025 · 54e65f9 · 54e65f9
2 parents 46e37c7 + 921cda6
commit 54e65f9
Show file tree

Hide file tree

Showing 42 changed files with 230 additions and 179 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -45,6 +45,23 @@ jobs:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
       - run: pnpm repo:lint:all
 
+  verify:
+    name: Verify
+    runs-on: ubuntu-latest
+    needs: ['install_dependencies']
+    timeout-minutes: 10
+
+    steps:
+      - uses: wyvox/action@v1
+        with:
+          pnpm-args: '--ignore-scripts'
+          node-version: 22.13.0
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - run: pnpm lint:fix
+      - run: pnpm repo:update:conventions
+      - run: pnpm repo:update:metadata
+      - uses: wyvox/action-no-git-diff@v1
+
   test-chrome:
     name: Chrome
     runs-on: ubuntu-latest

diff --git a/.meta-updater/main.mjs b/.meta-updater/main.mjs
@@ -22,6 +22,7 @@ export default () =>
 
         if (pkg) {
           const isPublished = !pkg.private;
+          const isRoot = pkg.name === 'glimmer-engine';
 
           const scripts = /** @type { JsonObject } */ (actual.scripts ??= {});
 
@@ -30,20 +31,35 @@ export default () =>
           // replaced with prepack
           delete scripts['test:types'];
 
-          if (isPublished) {
+          const updateRepo = () => {
             update(actual, 'repository', {
               type: 'git',
               url: 'git+https://github.com/glimmerjs/glimmer-vm.git',
-              directory: pkg.root,
+              ...(pkg.root
+                ? {
+                    directory: pkg.root,
+                  }
+                : {}),
             });
+          };
+
+          if (isPublished) {
+            updateRepo();
             update(publishConfig, 'access', 'public');
           } else if (pkg['repo-meta']?.built) {
             delete publishConfig['access'];
           } else {
             publishConfig = actual.publishConfig = {};
 
             update(actual, 'version', repo.workspace.version);
-            delete actual.repository;
+            /**
+             * Needed for release automation
+             */
+            if (isRoot) {
+              updateRepo();
+            } else {
+              delete actual.repository;
+            }
             delete scripts['test:publint'];
             cleanup(actual, 'publishConfig');
             return actual;

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -9,4 +9,4 @@
     "esbenp.prettier-vscode",
     "dnut.rewrap-revived"
   ]
-}
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,9 +10,7 @@
     },
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": false,
-    "editor.rulers": [
-      100
-    ]
+    "editor.rulers": [100]
   },
   "[json][jsonc][markdown][yaml]": {
     "editor.codeActionsOnSave": {
@@ -33,7 +31,7 @@
     {
       "color": "#aaaaaa66",
       "column": 80
-    },
+    }
   ],
   "eslint.codeAction.showDocumentation": {
     "enable": true
@@ -48,12 +46,7 @@
   "eslint.problems.shortenToSingleLine": true,
   "eslint.runtime": "node",
   "eslint.useFlatConfig": true,
-  "eslint.validate": [
-    "javascript",
-    "typescript",
-    "json",
-    "jsonc"
-  ],
+  "eslint.validate": ["javascript", "typescript", "json", "jsonc"],
   "eslint.workingDirectories": [
     {
       "pattern": "."
@@ -126,15 +119,9 @@
     }
   },
   "inline-bookmarks.expert.custom.words.mapping": {
-    "audit": [
-      "@audit(\\s|$)"
-    ],
-    "fixme": [
-      "@fixme(\\s|$)"
-    ],
-    "warn": [
-      "@premerge(\\s|$)"
-    ],
+    "audit": ["@audit(\\s|$)"],
+    "fixme": ["@fixme(\\s|$)"],
+    "warn": ["@premerge(\\s|$)"],
     "bandaid": [
       "@bandaid\\(until:[^)]+\\)(\\s|$)",
       "@bandaid(?=\\{@link [^}]+\\}(\\s|$))",
@@ -161,4 +148,4 @@
   "typescript.tsdk": "node_modules/typescript/lib",
   "typescript.updateImportsOnFileMove.enabled": "always",
   "typescript.reportStyleChecksAsWarnings": false
-}
+}
diff --git a/bin/update-package-json.mts b/bin/update-package-json.mts
@@ -1,4 +1,3 @@
-
 import { existsSync, readFileSync, writeFileSync } from 'node:fs';
 import { resolve } from 'node:path';
 

diff --git a/glimmer-vm.code-workspace b/glimmer-vm.code-workspace
@@ -2,184 +2,184 @@
   "folders": [
     {
       "name": "✨ glimmer-engine",
-      "path": "."
+      "path": ".",
     },
     {
       "name": "glimmer-benchmark",
-      "path": "benchmark"
+      "path": "benchmark",
     },
     {
       "name": "@glimmer-workspace/krausest",
-      "path": "benchmark/benchmarks/krausest"
+      "path": "benchmark/benchmarks/krausest",
     },
     {
       "name": "@glimmer-workspace/bin",
-      "path": "bin"
+      "path": "bin",
     },
     {
       "name": "📦 packages",
-      "path": "packages"
+      "path": "packages",
     },
     {
       "name": "📦 @glimmer-workspace/benchmark-env",
-      "path": "packages/@glimmer-workspace/benchmark-env"
+      "path": "packages/@glimmer-workspace/benchmark-env",
     },
     {
       "name": "📦 @glimmer-workspace/build-support",
-      "path": "packages/@glimmer-workspace/build"
+      "path": "packages/@glimmer-workspace/build",
     },
     {
       "name": "📦 @glimmer-workspace/eslint-plugin",
-      "path": "packages/@glimmer-workspace/eslint-plugin"
+      "path": "packages/@glimmer-workspace/eslint-plugin",
     },
     {
       "name": "📦 @glimmer-workspace/integration-tests",
-      "path": "packages/@glimmer-workspace/integration-tests"
+      "path": "packages/@glimmer-workspace/integration-tests",
     },
     {
       "name": "📦 @glimmer-workspace/test-utils",
-      "path": "packages/@glimmer-workspace/test-utils"
+      "path": "packages/@glimmer-workspace/test-utils",
     },
     {
       "name": "📦 @glimmer/compiler",
-      "path": "packages/@glimmer/compiler"
+      "path": "packages/@glimmer/compiler",
     },
     {
       "name": "📦 @glimmer-test/compiler",
-      "path": "packages/@glimmer/compiler/test"
+      "path": "packages/@glimmer/compiler/test",
     },
     {
       "name": "📦 @glimmer/debug",
-      "path": "packages/@glimmer/debug"
+      "path": "packages/@glimmer/debug",
     },
     {
       "name": "📦 @glimmer/destroyable",
-      "path": "packages/@glimmer/destroyable"
+      "path": "packages/@glimmer/destroyable",
     },
     {
       "name": "📦 @glimmer-test/destroyable",
-      "path": "packages/@glimmer/destroyable/test"
+      "path": "packages/@glimmer/destroyable/test",
     },
     {
       "name": "📦 @glimmer/dom-change-list",
-      "path": "packages/@glimmer/dom-change-list"
+      "path": "packages/@glimmer/dom-change-list",
     },
     {
       "name": "📦 @glimmer-test/dom-change-list",
-      "path": "packages/@glimmer/dom-change-list/test"
+      "path": "packages/@glimmer/dom-change-list/test",
     },
     {
       "name": "📦 @glimmer/encoder",
-      "path": "packages/@glimmer/encoder"
+      "path": "packages/@glimmer/encoder",
     },
     {
       "name": "📦 @glimmer/global-context",
-      "path": "packages/@glimmer/global-context"
+      "path": "packages/@glimmer/global-context",
     },
     {
       "name": "📦 @glimmer/interfaces",
-      "path": "packages/@glimmer/interfaces"
+      "path": "packages/@glimmer/interfaces",
     },
     {
       "name": "📦 @glimmer/local-debug-flags",
-      "path": "packages/@glimmer/local-debug-flags"
+      "path": "packages/@glimmer/local-debug-flags",
     },
     {
       "name": "📦 @glimmer/manager",
-      "path": "packages/@glimmer/manager"
+      "path": "packages/@glimmer/manager",
     },
     {
       "name": "📦 @glimmer-test/manager",
-      "path": "packages/@glimmer/manager/test"
+      "path": "packages/@glimmer/manager/test",
     },
     {
       "name": "📦 @glimmer/node",
-      "path": "packages/@glimmer/node"
+      "path": "packages/@glimmer/node",
     },
     {
       "name": "📦 @glimmer/opcode-compiler",
-      "path": "packages/@glimmer/opcode-compiler"
+      "path": "packages/@glimmer/opcode-compiler",
     },
     {
       "name": "📦 @glimmer/owner",
-      "path": "packages/@glimmer/owner"
+      "path": "packages/@glimmer/owner",
     },
     {
       "name": "📦 @glimmer-test/owner",
-      "path": "packages/@glimmer/owner/test"
+      "path": "packages/@glimmer/owner/test",
     },
     {
       "name": "📦 @glimmer/program",
-      "path": "packages/@glimmer/program"
+      "path": "packages/@glimmer/program",
     },
     {
       "name": "📦 @glimmer-test/program",
-      "path": "packages/@glimmer/program/test"
+      "path": "packages/@glimmer/program/test",
     },
     {
       "name": "📦 @glimmer/reference",
-      "path": "packages/@glimmer/reference"
+      "path": "packages/@glimmer/reference",
     },
     {
       "name": "📦 @glimmer-test/reference",
-      "path": "packages/@glimmer/reference/test"
+      "path": "packages/@glimmer/reference/test",
     },
     {
       "name": "📦 @glimmer/runtime",
-      "path": "packages/@glimmer/runtime"
+      "path": "packages/@glimmer/runtime",
     },
     {
       "name": "📦 @glimmer/syntax",
-      "path": "packages/@glimmer/syntax"
+      "path": "packages/@glimmer/syntax",
     },
     {
       "name": "📦 @glimmer-test/syntax",
-      "path": "packages/@glimmer/syntax/test"
+      "path": "packages/@glimmer/syntax/test",
     },
     {
       "name": "📦 @glimmer/util",
-      "path": "packages/@glimmer/util"
+      "path": "packages/@glimmer/util",
     },
     {
       "name": "📦 @glimmer-test/util",
-      "path": "packages/@glimmer/util/test"
+      "path": "packages/@glimmer/util/test",
     },
     {
       "name": "📦 @glimmer/validator",
-      "path": "packages/@glimmer/validator"
+      "path": "packages/@glimmer/validator",
     },
     {
       "name": "📦 @glimmer-test/validator",
-      "path": "packages/@glimmer/validator/test"
+      "path": "packages/@glimmer/validator/test",
     },
     {
       "name": "📦 @glimmer/vm",
-      "path": "packages/@glimmer/vm"
+      "path": "packages/@glimmer/vm",
     },
     {
       "name": "📦 @glimmer/vm-babel-plugins",
-      "path": "packages/@glimmer/vm-babel-plugins"
+      "path": "packages/@glimmer/vm-babel-plugins",
     },
     {
       "name": "📦 @glimmer/wire-format",
-      "path": "packages/@glimmer/wire-format"
+      "path": "packages/@glimmer/wire-format",
     },
     {
       "name": "📦 @types/js-reporters",
-      "path": "packages/@types/js-reporters"
+      "path": "packages/@types/js-reporters",
     },
     {
       "name": "📦 @types/puppeteer-chromium-resolver",
-      "path": "packages/@types/puppeteer-chromium-resolver"
+      "path": "packages/@types/puppeteer-chromium-resolver",
     },
     {
       "name": "📦 @types/qunit",
-      "path": "packages/@types/qunit"
-    }
+      "path": "packages/@types/qunit",
+    },
   ],
   "settings": {
     "typescript.tsc.autoDetect": "on",
     "typescript.tsdk": "node_modules/typescript/lib",
-    "typescript.tsserver.experimental.enableProjectDiagnostics": true
-  }
+    "typescript.tsserver.experimental.enableProjectDiagnostics": true,
+  },
 }
diff --git a/guides/workspace/vscode.md b/guides/workspace/vscode.md
@@ -73,8 +73,6 @@ See [Standard Annotations](./workspace-management.md#standard-annotations) in `w
 
 <kbd> ![fixme](./demos/fixme.png) </kbd>
 
-
-
 ### NPM Dependency Links (`herrmannplatz.npm-dependency-links`)
 
 This extension will turn your dependencies and devDependencies in your `package.json` into links to
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,4 +9,4 @@ @@
         "esbenp.prettier-vscode",
         "dnut.rewrap-revived"
       ]
-    }
+    }
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@

		import { existsSync, readFileSync, writeFileSync } from 'node:fs';
		import { resolve } from 'node:path';

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -73,8 +73,6 @@ See [Standard Annotations](./workspace-management.md#standard-annotations) in `w

		<kbd> ![fixme](./demos/fixme.png) </kbd>



		### NPM Dependency Links (`herrmannplatz.npm-dependency-links`)

		This extension will turn your dependencies and devDependencies in your `package.json` into links to
Expand Down