Set package as ESM-frist and add Publint to better monitor package.js…

…on correctness
evilmartians · Nov 28, 2024 · d3f6327 · d3f6327
1 parent f5ac09f
commit d3f6327
Show file tree

Hide file tree

Showing 10 changed files with 126 additions and 30 deletions.
diff --git a/.changeset/soft-balloons-serve.md b/.changeset/soft-balloons-serve.md
@@ -0,0 +1,5 @@
+---
+"@evilmartians/harmony": minor
+---
+
+set pacakge as ESM-first, prioritize ESM exports as `.js`, update CommonJS exports as `.cjs`, fix [publint](https://publint.dev/@evilmartians/[email protected]) recommendations
diff --git a/deno.json b/deno.json
@@ -1,6 +1,7 @@
 {
   "tasks": {
     "build": "deno run --allow-read --allow-write scripts/build.ts",
+    "publint": "deno run --allow-read --allow-env npm:publint",
     "test": "deno test --allow-read --allow-write",
     "update-snapshots": "deno test --allow-read --allow-write -- --update",
     "changesets": "deno run -A npm:@changesets/cli",

diff --git a/deno.lock b/deno.lock
diff --git a/package.json b/package.json
@@ -2,21 +2,23 @@
   "name": "@evilmartians/harmony",
   "version": "1.3.0",
   "scripts": {
-    "build": "deno task build",
+    "build": "deno task build && deno task publint",
     "prepublishOnly": "npm run build"
   },
-  "main": "dist/index.js",
+  "type": "module",
   "exports": {
     "./tailwind": {
+      "types": "./dist/tailwind/index.d.ts",
+      "require": "./dist/tailwind/index.cjs",
       "import": "./dist/tailwind/index.js",
-      "require": "./dist/tailwind/index.mjs",
-      "types": "./dist/tailwind/index.d.ts"
+      "default": "./dist/tailwind/index.js"
     },
     "./tailwind.css": "./dist/tailwind/index.css",
     "./base": {
-      "import": "./dist/base/index.mjs",
-      "require": "./dist/base/index.js",
-      "types": "./dist/base/index.d.ts"
+      "types": "./dist/base/index.d.ts",
+      "require": "./dist/base/index.cjs",
+      "import": "./dist/base/index.js",
+      "default": "./dist/base/index.js"
     },
     "./css/*": "./dist/css/*"
   },
@@ -30,7 +32,8 @@
   "license": "MIT",
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
-    "@changesets/cli": "^2.27.9"
+    "@changesets/cli": "^2.27.9",
+    "publint": "^0.2.12"
   },
   "devEngines": {
     "runtime": [

diff --git a/scripts/targets/__snapshots__/base_test.ts.snap b/scripts/targets/__snapshots__/base_test.ts.snap
@@ -1,8 +1,8 @@
 export const snapshot = {};
 
 snapshot[`base export 1`] = `
-\`'use strict';
-module.exports = {
+'
+  export default {
   "red": {
     "100": "oklch(0.966797 0.0171875 20)",
     "500": "oklch(0.742188 0.151562 20)"
@@ -11,13 +11,12 @@ module.exports = {
     "100": "oklch(0.966797 0.0171875 43.3333)"
   }
 };
-Object.defineProperty(exports, '__esModule', { value: true });
-\`
+'
 `;
 
 snapshot[`base export 2`] = `
-'
-  export default {
+\`'use strict';
+module.exports = {
   "red": {
     "100": "oklch(0.966797 0.0171875 20)",
     "500": "oklch(0.742188 0.151562 20)"
@@ -26,7 +25,8 @@ snapshot[`base export 2`] = `
     "100": "oklch(0.966797 0.0171875 43.3333)"
   }
 };
-'
+Object.defineProperty(exports, '__esModule', { value: true });
+\`
 `;
 
 snapshot[`base export 3`] = `

diff --git a/scripts/targets/__snapshots__/tailwind_test.ts.snap b/scripts/targets/__snapshots__/tailwind_test.ts.snap
@@ -1,8 +1,8 @@
 export const snapshot = {};
 
 snapshot[`Tailwind export target 1`] = `
-\`'use strict';
-module.exports = {
+'
+  export default {
   "inherit": "inherit",
   "current": "currentColor",
   "transparent": "transparent",
@@ -16,13 +16,12 @@ module.exports = {
     "100": "oklch(0.966797 0.0171875 43.3333 / <alpha-value>)"
   }
 };
-Object.defineProperty(exports, '__esModule', { value: true });
-\`
+'
 `;
 
 snapshot[`Tailwind export target 2`] = `
-'
-  export default {
+\`'use strict';
+module.exports = {
   "inherit": "inherit",
   "current": "currentColor",
   "transparent": "transparent",
@@ -36,7 +35,8 @@ snapshot[`Tailwind export target 2`] = `
     "100": "oklch(0.966797 0.0171875 43.3333 / <alpha-value>)"
   }
 };
-'
+Object.defineProperty(exports, '__esModule', { value: true });
+\`
 `;
 
 snapshot[`Tailwind export target 3`] = `

diff --git a/scripts/targets/base.ts b/scripts/targets/base.ts
@@ -12,9 +12,9 @@ export const buildBasicPalette: ExportTarget = async (
 ) => {
   const palette = simplifyPalette(paletteWithFallback);
   const content = generateCJS(palette);
-  await Deno.writeTextFile(path.join(targetDir, "index.js"), content);
+  await Deno.writeTextFile(path.join(targetDir, "index.cjs"), content);
   await Deno.writeTextFile(
-    path.join(targetDir, "index.mjs"),
+    path.join(targetDir, "index.js"),
     generateEsm(palette),
   );
   await Deno.writeTextFile(

diff --git a/scripts/targets/base_test.ts b/scripts/targets/base_test.ts
@@ -4,7 +4,7 @@ import { testExportTarget } from "./testUtils.ts";
 Deno.test("base export", async (t) => {
   await testExportTarget(t, buildBasicPalette, [
     "index.js",
-    "index.mjs",
+    "index.cjs",
     "index.d.ts",
   ]);
 });
diff --git a/scripts/targets/tailwind.ts b/scripts/targets/tailwind.ts
@@ -21,9 +21,9 @@ export const buildTailwindPalette: ExportTarget = async (
   };
 
   const content = generateCJS(twPalette);
-  await Deno.writeTextFile(path.join(targetDir, "index.js"), content);
+  await Deno.writeTextFile(path.join(targetDir, "index.cjs"), content);
   await Deno.writeTextFile(
-    path.join(targetDir, "index.mjs"),
+    path.join(targetDir, "index.js"),
     generateEsm(twPalette),
   );
   await Deno.writeTextFile(

diff --git a/scripts/targets/tailwind_test.ts b/scripts/targets/tailwind_test.ts
@@ -4,7 +4,7 @@ import { testExportTarget } from "./testUtils.ts";
 Deno.test("Tailwind export target", async (t) => {
   await testExportTarget(t, buildTailwindPalette, [
     "index.js",
-    "index.mjs",
+    "index.cjs",
     "index.d.ts",
   ]);
 });