Test the the exports of the built package.

This gives us more confidence that they can be imported from the published package by runtimes/bundlers.

Author: lgarron

.github/workflows/CI.yaml

@@ -34,3 +34,4 @@ jobs:
       - run: make clean lint-ts-biome
       - run: make clean lint-ts-tsc
       - run: make clean bun-test
+      - run: make clean test-exports

Makefile

@@ -22,12 +22,22 @@ setup:
 	bun install --frozen-lockfile
 
 .PHONY: test
-test: lint bun-test
+test: test-bun test-exports lint
 
-.PHONY: bun-test
-bun-test:
+.PHONY: test-bun
+test-bun:
 	bun test
 
+.PHONY: test-exports
+test-exports: build-lib-js
+	# Yes, this is a lot of test cases: https://github.com/cubing/icons/pull/200#issuecomment-3182362760
+	node -- 'test/exports/test-legacy-export.js'
+	bun run -- 'test/exports/test-legacy-export.js'
+	bun run -- 'test/exports/test-legacy-export.ts'
+	node -- 'test/exports/test-package-export.js'
+	bun run -- 'test/exports/test-package-export.js'
+	bun run -- 'test/exports/test-package-export.ts'
+
 .PHONY: lint
 lint: setup lint-ts-biome lint-ts-tsc
 
@@ -38,6 +48,7 @@ lint-ts-biome: build-lib-js
 .PHONY: lint-ts-tsc
 lint-ts-tsc: build-lib-types
 	bun x tsc --noEmit --project .
+	bun x tsc --noEmit --project ./test/exports/tsconfig.json
 
 .PHONY: format
 format: setup

test/exports/test-legacy-export.js

@@ -0,0 +1,5 @@
+import { default as assert } from "node:assert";
+import { CubingIcons } from "../../js/index.js";
+
+assert(typeof CubingIcons === "object");
+console.log("OK");

test/exports/test-legacy-export.ts

@@ -0,0 +1,16 @@
+import { default as assert } from "node:assert";
+
+let capturedConsoleErrorMessage: string | undefined;
+console.error = (s) => {
+  capturedConsoleErrorMessage = s;
+};
+
+// This must be a dynamic import to avoid being hoisted above the `console.error` modification.
+const { CubingIcons } = await import("../../ts");
+
+assert(typeof CubingIcons === "object");
+assert.equal(
+  capturedConsoleErrorMessage,
+  "Using `@cubing/icons/ts` is deprecated. Please use `@cubing/icons/js` for the same functionality.",
+);
+console.log("OK");

test/exports/test-package-export.js

@@ -0,0 +1,5 @@
+import { default as assert } from "node:assert";
+import { CubingIcons } from "@cubing/icons/js";
+
+assert(typeof CubingIcons === "object");
+console.log("OK");

test/exports/test-package-export.ts

@@ -0,0 +1,16 @@
+import { default as assert } from "node:assert";
+
+let capturedConsoleErrorMessage: string | undefined;
+console.error = (s) => {
+  capturedConsoleErrorMessage = s;
+};
+
+// This must be a dynamic import to avoid being hoisted above the `console.error` modification.
+const { CubingIcons } = await import("@cubing/icons/ts");
+
+assert(typeof CubingIcons === "object");
+assert.equal(
+  capturedConsoleErrorMessage,
+  "Using `@cubing/icons/ts` is deprecated. Please use `@cubing/icons/js` for the same functionality.",
+);
+console.log("OK");

test/exports/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../node_modules/@cubing/dev-config/ts/es2022-types/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "../../",
+    "paths": {
+      "@cubing/icons": ["../"]
+    }
+  },
+  "include": ["**/*"]
+}

tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src/js/",
+    "outDir": "./dist/lib/@cubing/icons/js/"
+  },
+  "include": ["./src/js/index.ts"]
+}

tsconfig.json

@@ -1,5 +1,8 @@
 {
   "extends": "./node_modules/@cubing/dev-config/ts/es2022-types/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
   "include": ["**/*"],
-  "exclude": ["./.temp/", "./dist/"]
+  "exclude": ["./.temp/", "./dist/", "./test/exports/"]
 }