Prevent #1688 (and other accidental prettier breakages) (#1689)

* Try to make a test to prevent #1688 (and other prettier breakages)

* Seems fine so far...

* Add node testing to CI

* delete unused file

* Remove mention of run-node-tests

* Why isn't linting working?

* As I feared, we have the build wrong

* idk man

* run pnpm repo:update:metadata

* Lints -- these are actually all correct

* Fix #1688

* Move test project into a real project, rather than tmp for easier poking around

* Set vitest conditions

* Curious

* Fix node smoke

* Remove extraneous test

* Why doesn't my local CLI env match CI

* lockfile

* different logging

* Now its working?

* Codify the requirements for running the types check

* More turbo progress

* omg it worked

* Maybe I just remove the local lint script

* Don't need that anymore

* Fix

* Updates

* fix

* last fix?

Author: NullVoxPopuli

.github/workflows/ci.yml

@@ -45,6 +45,7 @@ jobs:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
       - run: pnpm repo:lint:all
 
+
   verify:
     name: Verify
     runs-on: ubuntu-latest
@@ -62,6 +63,37 @@ jobs:
       - run: pnpm repo:update:metadata
       - uses: wyvox/action-no-git-diff@v1
 
+
+  test-node:
+    name: Node
+    runs-on: ubuntu-latest
+    needs: ['install_dependencies']
+    timeout-minutes: 5
+
+    steps:
+      - uses: wyvox/action@v1
+        with:
+          node-version: 22.13.0
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - run: pnpm test:node
+
+  test-smoke:
+    name: Smoke
+    runs-on: ubuntu-latest
+    needs: ['install_dependencies']
+    timeout-minutes: 5
+
+    steps:
+      - uses: wyvox/action@v1
+        with:
+          node-version: 22.13.0
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - working-directory: ./smoke-tests/node
+        run: |
+          pnpm test:setup
+          pnpm test:node
+
+
   test-chrome:
     name: Chrome
     runs-on: ubuntu-latest

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 /dist
 **/dist
 /control-dist/

.meta-updater/main.mjs

@@ -26,10 +26,9 @@ export default () =>
 
           const scripts = /** @type { JsonObject } */ (actual.scripts ??= {});
 
-          update(scripts, 'test:lint', 'eslint . --quiet');
-
           // replaced with prepack
           delete scripts['test:types'];
+          delete scripts['test:lint'];
 
           const updateRepo = () => {
             update(actual, 'repository', {
@@ -57,6 +56,7 @@ export default () =>
              */
             if (isRoot) {
               updateRepo();
+              update(scripts, 'test:lint', 'eslint . --quiet');
             } else {
               delete actual.repository;
             }

.meta-updater/package.json

@@ -6,9 +6,7 @@
   "keywords": [
     "node"
   ],
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@pnpm/find-workspace-dir": "^1000.0.1",
     "@pnpm/meta-updater": "^2.0.3",

bin/package.json

@@ -13,9 +13,7 @@
       "*"
     ]
   },
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer-workspace/repo-metadata": "workspace:*",
     "@pnpm/workspace.find-packages": "^1000.0.5",

bin/run-node-tests.mjs

@@ -25,19 +25,20 @@
     "lint:format": "prettier -c .",
     "postinstall": "node --disable-warning=ExperimentalWarning --experimental-strip-types ./bin/bench-packages.mts",
     "repo:lint:all": "turbo run lint:all",
-    "repo:lint:files": "turbo run test:lint",
+    "repo:lint:files": "turbo run //#test:lint",
     "repo:lint:fix": "turbo run test:lint -- --fix && prettier -w .",
     "repo:lint:pub": "turbo run test:publint",
-    "repo:lint:types": "tsc -b",
+    "repo:lint:types": "turbo run //#test:types",
     "repo:prepack": "turbo run prepack",
     "repo:update:conventions": "pnpm meta-updater",
     "repo:update:metadata": "node --experimental-strip-types --no-warnings ./repo-metadata/lib/update.ts",
+    "smoke:setup": "node --disable-warning=ExperimentalWarning --experimental-strip-types ./smoke-tests/node/setup.ts",
     "start": "vite",
     "test": "node bin/run-tests.mjs",
     "test:babel-plugins": "yarn workspace @glimmer/vm-babel-plugins test",
     "test:browserstack": "ember test --test-port=7774 --host 127.0.0.1 --config-file=testem-browserstack.js",
     "test:lint": "eslint . --quiet",
-    "test:node": "node bin/run-node-tests.mjs",
+    "test:node": "pnpm turbo test:node",
     "test:smoke": "SMOKE_TESTS=true ember test",
     "ts": "node --disable-warning=ExperimentalWarning --experimental-strip-types",
     "unlink:all": "esyes ./bin/unlink-all.mts"
@@ -54,8 +55,10 @@
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
     "@eslint/config-inspector": "^0.7.1",
     "@eslint/js": "9.17.0",
+    "@glimmer-workspace/benchmark-env": "workspace:*",
     "@glimmer-workspace/build-support": "workspace:*",
     "@glimmer-workspace/eslint-plugin": "workspace:*",
+    "@glimmer-workspace/integration-node-tests": "workspace:*",
     "@glimmer-workspace/integration-tests": "workspace:*",
     "@glimmer-workspace/repo-metadata": "workspace:*",
     "@glimmer/env": "0.1.7",
@@ -126,6 +129,7 @@
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.19.0",
     "vite": "^6.0.10",
+    "vitest": "^3.0.4",
     "zx": "^8.3.0"
   },
   "changelog": {

package.json

@@ -25,7 +25,6 @@
   ],
   "scripts": {
     "prepack": "rollup -c rollup.config.mjs",
-    "test:lint": "eslint . --quiet",
     "test:publint": "publint"
   },
   "dependencies": {

packages/@glimmer-workspace/benchmark-env/package.json

@@ -14,9 +14,7 @@
       "console"
     ]
   },
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/local-debug-babel-plugin": "workspace:*",
     "@rollup/plugin-commonjs": "^25.0.7",

packages/@glimmer-workspace/build/package.json

@@ -4,7 +4,5 @@
   "version": "0.92.0",
   "type": "module",
   "exports": "./index.d.ts",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  }
+  "scripts": {}
 }

packages/@glimmer-workspace/env/package.json

@@ -4,9 +4,7 @@
   "version": "0.92.0",
   "type": "module",
   "exports": "./index.js",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.18.0",

packages/@glimmer-workspace/eslint-plugin/package.json

@@ -0,0 +1,2 @@
+packages/
+pnpm-lock.yaml

packages/@glimmer-workspace/integration-node-tests/.gitignore

@@ -0,0 +1,21 @@
+{
+  "name": "@glimmer-workspace/integration-node-tests",
+  "version": "0.92.0",
+  "type": "module",
+  "private": true,
+  "repo-meta": {
+    "strictness": "loose"
+  },
+  "scripts": {
+    "test:node": "vitest --run"
+  },
+  "dependencies": {
+    "@glimmer/syntax": "workspace:*",
+    "execa": "^9.5.2",
+    "prettier": "^3.4.2"
+  },
+  "devDependencies": {
+    "@glimmer-workspace/repo-metadata": "workspace:*",
+    "vitest": "^3.0.4"
+  }
+}

packages/@glimmer-workspace/integration-node-tests/package.json

@@ -0,0 +1,41 @@
+import { createRequire } from 'node:module';
+
+import * as prettier from 'prettier';
+import { describe, expect, it } from 'vitest';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * See: https://github.com/glimmerjs/glimmer-vm/issues/1688
+ *
+ * Requires the root package.json#pnpm#overrides point at our internal
+ * copy of @glimmer/syntax, or else prettier brings its own already published
+ * copy of @glimmer/syntax
+ *
+ * NOTE: that this test alone is insufficient to test our built outputs.
+ *       the smoke-tests/* folders are for that purpose.
+ */
+describe('Prettier', () => {
+  it(`SMOKE: we've symlinked to the in-repo copy of @glimmer/syntax`, () => {
+    let workspacePath = require.resolve('@glimmer/syntax');
+    let prettierPath = require.resolve('prettier');
+    let prettierGlimmer = require.resolve('@glimmer/syntax', { paths: [prettierPath] });
+
+    expect(prettierGlimmer).toBe(workspacePath);
+  });
+
+  it('Underlynig preprocess API works', async () => {
+    let result = (await import('@glimmer/syntax')).preprocess('<h1></h1>');
+
+    expect(result, `It can be await import()'d, and doesn't error`).toBeTruthy();
+  });
+
+  it('Prettier can call preprocess', async () => {
+    let result = await prettier.format(`     <div>\n</div>`, { parser: 'glimmer' });
+
+    expect(result).toMatchInlineSnapshot(`
+      "<div>
+      </div>"
+    `);
+  });
+});

packages/@glimmer-workspace/integration-node-tests/test/prettier.test.ts

@@ -12,9 +12,7 @@
       "test/**/*"
     ]
   },
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer-workspace/test-utils": "workspace:*",
     "@glimmer/compiler": "workspace:*",

packages/@glimmer-workspace/integration-tests/package.json

@@ -2,9 +2,7 @@
   "private": true,
   "name": "@glimmer-test/integration-tests",
   "version": "0.92.0",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer-workspace/integration-tests": "workspace:*",
     "@glimmer-workspace/test-utils": "workspace:*",

packages/@glimmer-workspace/integration-tests/test/package.json

@@ -4,9 +4,7 @@
   "version": "0.92.0",
   "type": "module",
   "main": "index.ts",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/interfaces": "workspace:*",
     "@glimmer/util": "workspace:*"

packages/@glimmer-workspace/test-utils/package.json

@@ -27,7 +27,6 @@
   ],
   "scripts": {
     "prepack": "rollup -c rollup.config.mjs",
-    "test:lint": "eslint . --quiet",
     "test:publint": "publint"
   },
   "dependencies": {

packages/@glimmer/compiler/package.json

@@ -2,9 +2,7 @@
   "private": true,
   "name": "@glimmer-test/compiler",
   "version": "0.92.0",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/compiler": "workspace:*",
     "@glimmer/interfaces": "workspace:*",

packages/@glimmer/compiler/test/package.json

@@ -7,9 +7,7 @@
   "type": "module",
   "main": "index.ts",
   "types": "index.ts",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/interfaces": "workspace:*"
   },

packages/@glimmer/constants/package.json

@@ -2,9 +2,7 @@
   "private": true,
   "name": "@glimmer-test/constants",
   "version": "0.92.0",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/env": "0.1.7",
     "@glimmer/util": "workspace:*"

packages/@glimmer/constants/test/package.json

@@ -14,8 +14,8 @@ export function assertPresent<T>(value: T, message?: string): asserts value is P
   }
 }
 
-export function isPresentArray<T>(list: readonly T[]): list is PresentArray<T> {
-  return list.length > 0;
+export function isPresentArray<T>(list?: readonly T[]): list is PresentArray<T> {
+  return list ? list.length > 0 : false;
 }
 
 export function ifPresent<T, U, V>(

packages/@glimmer/debug-util/lib/present.ts

@@ -6,9 +6,7 @@
   "description": "Common utilities used in Glimmer with debug-specific behavior",
   "type": "module",
   "exports": "./index.ts",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/interfaces": "workspace:*"
   },

packages/@glimmer/debug-util/package.json

@@ -2,9 +2,7 @@
   "private": true,
   "name": "@glimmer-test/debug-util",
   "version": "0.92.0",
-  "scripts": {
-    "test:lint": "eslint . --quiet"
-  },
+  "scripts": {},
   "dependencies": {
     "@glimmer/env": "0.1.7",
     "@glimmer/util": "workspace:*"