Migrate a few workspaces to "module" format (#424)

miorel · web-flow · commit 49347dc67d13 · 2024-09-15T12:48:34.000-07:00
Per https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c Note that trying to get `ts-node` to work was quite painful, but `tsx` came to the rescue. So I think I'm going to favor `tsx` going forward.
diff --git a/workspaces/download-leetcode-submissions/package.json b/workspaces/download-leetcode-submissions/package.json
@@ -12,24 +12,25 @@
     "name": "Miorel-Lucian Palii",
     "url": "https://github.com/miorel"
   },
+  "exports": "./src/main.ts",
   "scripts": {
     "format": "prettier --color --write .",
     "lint": "eslint --color --max-warnings=0 .",
-    "start": "ts-node src/main.ts",
+    "start": "tsx src/main.ts",
     "typecheck": "tsc --pretty --project ."
   },
   "dependencies": {
     "@code-chronicles/leetcode-api": "workspace:*",
     "@code-chronicles/util": "workspace:*",
     "nullthrows": "1.1.1",
-    "ts-node": "10.9.2",
     "zod": "3.23.8"
   },
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
     "@types/node": "22.5.5",
     "eslint": "9.10.0",
     "prettier": "3.3.3",
+    "tsx": "4.19.1",
     "typescript": "5.6.2"
   }
 }
diff --git a/workspaces/fetch-leetcode-problem-list/README.md b/workspaces/fetch-leetcode-problem-list/README.md
@@ -36,10 +36,10 @@ yarn
 yarn build
 
 # Run it with Node!
-node dist/fetch-leetcode-problem-list.js
+node dist/fetch-leetcode-problem-list.cjs
 
 # Or if your system can handle executable files, try running it directly:
-./dist/fetch-leetcode-problem-list.js
+./dist/fetch-leetcode-problem-list.cjs
 
 # Examine the output:
 cat problems.jsonl
diff --git a/workspaces/fetch-leetcode-problem-list/package.json b/workspaces/fetch-leetcode-problem-list/package.json
@@ -12,12 +12,13 @@
     "name": "Miorel-Lucian Palii",
     "url": "https://github.com/miorel"
   },
-  "main": "src/main.ts",
+  "type": "module",
+  "exports": "./src/main.ts",
   "scripts": {
-    "build": "webpack && chmod +x dist/fetch-leetcode-problem-list.js",
+    "build": "cross-env NODE_OPTIONS=\"--import tsx\" webpack && chmod +x dist/fetch-leetcode-problem-list.cjs",
     "format": "prettier --color --write .",
     "lint": "eslint --color --max-warnings=0 .",
-    "start": "ts-node src/main.ts",
+    "start": "tsx src/main.ts",
     "typecheck": "tsc --pretty --project ."
   },
   "dependencies": {
@@ -27,10 +28,11 @@
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
     "@types/node": "22.5.5",
+    "cross-env": "7.0.3",
     "eslint": "9.10.0",
     "prettier": "3.3.3",
     "ts-loader": "9.5.1",
-    "ts-node": "10.9.2",
+    "tsx": "4.19.1",
     "typescript": "5.6.2",
     "webpack": "5.94.0",
     "webpack-cli": "5.1.4"
diff --git a/workspaces/fetch-leetcode-problem-list/webpack.config.ts b/workspaces/fetch-leetcode-problem-list/webpack.config.ts
@@ -9,13 +9,14 @@ import webpack, {
 import { stripPrefix } from "@code-chronicles/util/stripPrefix";
 import { stripPrefixOrThrow } from "@code-chronicles/util/stripPrefixOrThrow";
 
-import packageJson from "./package.json";
+import packageJson from "./package.json" with { type: "module" };
 
 const config: Configuration = {
   target: "node",
-  entry: path.resolve(__dirname, packageJson.main),
+  entry: path.resolve(__dirname, packageJson.exports),
   output: {
-    filename: stripPrefixOrThrow(packageJson.name, "@code-chronicles/") + ".js",
+    filename:
+      stripPrefixOrThrow(packageJson.name, "@code-chronicles/") + ".cjs",
     path: path.resolve(__dirname, "dist"),
   },
 
@@ -40,6 +41,9 @@ const config: Configuration = {
 
   resolve: {
     extensions: [".tsx", ".ts", "..."],
+    extensionAlias: {
+      ".js": [".ts", ".tsx", ".js"],
+    },
   },
 
   externalsType: "commonjs",
diff --git a/workspaces/fetch-recent-accepted-leetcode-submissions/README.md b/workspaces/fetch-recent-accepted-leetcode-submissions/README.md
@@ -31,10 +31,10 @@ yarn
 yarn build
 
 # Run it with Node!
-node dist/fetch-recent-accepted-leetcode-submissions.js elimanzo VehicleOfPuzzle
+node dist/fetch-recent-accepted-leetcode-submissions.cjs elimanzo VehicleOfPuzzle
 
 # Or if your system can handle executable files, try running it directly:
-./dist/fetch-recent-accepted-leetcode-submissions.js elimanzo VehicleOfPuzzle
+./dist/fetch-recent-accepted-leetcode-submissions.cjs elimanzo VehicleOfPuzzle
 ```
 
 The output is JSON and will look something like:
diff --git a/workspaces/fetch-recent-accepted-leetcode-submissions/package.json b/workspaces/fetch-recent-accepted-leetcode-submissions/package.json
@@ -12,12 +12,13 @@
     "name": "Miorel-Lucian Palii",
     "url": "https://github.com/miorel"
   },
-  "main": "src/main.ts",
+  "type": "module",
+  "exports": "./src/main.ts",
   "scripts": {
-    "build": "webpack && chmod +x dist/fetch-recent-accepted-leetcode-submissions.js",
+    "build": "cross-env NODE_OPTIONS=\"--import tsx\" webpack && chmod +x dist/fetch-recent-accepted-leetcode-submissions.cjs",
     "format": "prettier --color --write .",
     "lint": "eslint --color --max-warnings=0 .",
-    "start": "ts-node src/main.ts",
+    "start": "tsx src/main.ts",
     "typecheck": "tsc --pretty --project ."
   },
   "dependencies": {
@@ -27,10 +28,11 @@
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
     "@types/node": "22.5.5",
+    "cross-env": "7.0.3",
     "eslint": "9.10.0",
     "prettier": "3.3.3",
     "ts-loader": "9.5.1",
-    "ts-node": "10.9.2",
+    "tsx": "4.19.1",
     "typescript": "5.6.2",
     "webpack": "5.94.0",
     "webpack-cli": "5.1.4"
diff --git a/workspaces/fetch-recent-accepted-leetcode-submissions/webpack.config.ts b/workspaces/fetch-recent-accepted-leetcode-submissions/webpack.config.ts
@@ -9,13 +9,14 @@ import webpack, {
 import { stripPrefix } from "@code-chronicles/util/stripPrefix";
 import { stripPrefixOrThrow } from "@code-chronicles/util/stripPrefixOrThrow";
 
-import packageJson from "./package.json";
+import packageJson from "./package.json" with { type: "module" };
 
 const config: Configuration = {
   target: "node",
-  entry: path.resolve(__dirname, packageJson.main),
+  entry: path.resolve(__dirname, packageJson.exports),
   output: {
-    filename: stripPrefixOrThrow(packageJson.name, "@code-chronicles/") + ".js",
+    filename:
+      stripPrefixOrThrow(packageJson.name, "@code-chronicles/") + ".cjs",
     path: path.resolve(__dirname, "dist"),
   },
 
@@ -40,6 +41,9 @@ const config: Configuration = {
 
   resolve: {
     extensions: [".tsx", ".ts", "..."],
+    extensionAlias: {
+      ".js": [".ts", ".tsx", ".js"],
+    },
   },
 
   externalsType: "commonjs",
diff --git a/workspaces/post-leetcode-potd-to-discord/README.md b/workspaces/post-leetcode-potd-to-discord/README.md
@@ -48,10 +48,10 @@ To use:
    yarn build
 
    # Run it with Node!
-   node dist/post-leetcode-potd-to-discord.js
+   node dist/post-leetcode-potd-to-discord.cjs
 
    # Or if your system can handle executable files, try running it directly:
-   ./dist/post-leetcode-potd-to-discord.js
+   ./dist/post-leetcode-potd-to-discord.cjs
    ```
 
    Here's an example message:
diff --git a/workspaces/post-leetcode-potd-to-discord/package.json b/workspaces/post-leetcode-potd-to-discord/package.json
@@ -12,12 +12,13 @@
     "name": "Miorel-Lucian Palii",
     "url": "https://github.com/miorel"
   },
-  "main": "src/main.ts",
+  "type": "module",
+  "exports": "./src/main.ts",
   "scripts": {
-    "build": "webpack && chmod +x dist/post-leetcode-potd-to-discord.js",
+    "build": "cross-env NODE_OPTIONS=\"--import tsx\" webpack && chmod +x dist/post-leetcode-potd-to-discord.cjs",
     "format": "prettier --color --write .",
     "lint": "eslint --color --max-warnings=0 .",
-    "start": "ts-node src/main.ts",
+    "start": "tsx src/main.ts",
     "typecheck": "tsc --pretty --project ."
   },
   "dependencies": {
@@ -34,9 +35,10 @@
     "@code-chronicles/eslint-config": "workspace:*",
     "@types/invariant": "2.2.37",
     "@types/node": "22.5.5",
+    "cross-env": "7.0.3",
     "eslint": "9.10.0",
     "prettier": "3.3.3",
-    "ts-node": "10.9.2",
+    "tsx": "4.19.1",
     "typescript": "5.6.2",
     "webpack": "5.94.0",
     "webpack-cli": "5.1.4"
diff --git a/workspaces/post-leetcode-potd-to-discord/src/getPotdMessage.ts b/workspaces/post-leetcode-potd-to-discord/src/getPotdMessage.ts
@@ -1,7 +1,8 @@
 import type { ActiveDailyCodingChallengeQuestion } from "@code-chronicles/leetcode-api";
-import { formatTimestampForDiscord } from "./formatTimestampForDiscord";
-import { yearMonthDayToTimestampInSeconds } from "@code-chronicles/util/yearMonthDayToTimestampInSeconds";
 import { SEC_IN_DAY } from "@code-chronicles/util/timeConstants";
+import { yearMonthDayToTimestampInSeconds } from "@code-chronicles/util/yearMonthDayToTimestampInSeconds";
+
+import { formatTimestampForDiscord } from "./formatTimestampForDiscord.js";
 
 export function getPotdMessage({
   date,
diff --git a/workspaces/post-leetcode-potd-to-discord/src/main.ts b/workspaces/post-leetcode-potd-to-discord/src/main.ts
@@ -11,11 +11,11 @@ import {
 import { whileReturnsTrueAsync } from "@code-chronicles/util/whileReturnsTrueAsync";
 import { yearMonthDayToTimestampInSeconds } from "@code-chronicles/util/yearMonthDayToTimestampInSeconds";
 
-import { getPotdMessage } from "./getPotdMessage";
-import { readScriptData } from "./readScriptData";
-import { readSecrets } from "./readSecrets";
-import { sendDiscordMessage } from "./sendDiscordMessage";
-import { writeScriptData } from "./writeScriptData";
+import { getPotdMessage } from "./getPotdMessage.js";
+import { readScriptData } from "./readScriptData.js";
+import { readSecrets } from "./readSecrets.js";
+import { sendDiscordMessage } from "./sendDiscordMessage.js";
+import { writeScriptData } from "./writeScriptData.js";
 
 async function main(): Promise<void> {
   // TODO: maybe create the file from a template if it doesn't exist
diff --git a/workspaces/post-leetcode-potd-to-discord/src/sendDiscordMessage.ts b/workspaces/post-leetcode-potd-to-discord/src/sendDiscordMessage.ts
@@ -1,7 +1,7 @@
 import { ChannelType, Client, GatewayIntentBits } from "discord.js";
 import invariant from "invariant";
 
-import type { Secrets } from "./readSecrets";
+import type { Secrets } from "./readSecrets.js";
 
 export async function sendDiscordMessage(
   { discordChannelID, discordToken }: Secrets,
diff --git a/workspaces/post-leetcode-potd-to-discord/src/writeScriptData.ts b/workspaces/post-leetcode-potd-to-discord/src/writeScriptData.ts
@@ -1,6 +1,6 @@
 import { writeFile } from "node:fs/promises";
 
-import { DATA_FILE, type Data } from "./readScriptData";
+import { DATA_FILE, type Data } from "./readScriptData.js";
 
 export async function writeScriptData(data: Data): Promise<void> {
   await writeFile(DATA_FILE, JSON.stringify(data), {
diff --git a/workspaces/post-leetcode-potd-to-discord/webpack.config.ts b/workspaces/post-leetcode-potd-to-discord/webpack.config.ts
@@ -9,13 +9,14 @@ import webpack, {
 import { stripPrefix } from "@code-chronicles/util/stripPrefix";
 import { stripPrefixOrThrow } from "@code-chronicles/util/stripPrefixOrThrow";
 
-import packageJson from "./package.json";
+import packageJson from "./package.json" with { type: "module" };
 
 const config: Configuration = {
   target: "node",
-  entry: path.resolve(__dirname, packageJson.main),
+  entry: path.resolve(__dirname, packageJson.exports),
   output: {
-    filename: stripPrefixOrThrow(packageJson.name, "@code-chronicles/") + ".js",
+    filename:
+      stripPrefixOrThrow(packageJson.name, "@code-chronicles/") + ".cjs",
     path: path.resolve(__dirname, "dist"),
   },
 
@@ -40,6 +41,9 @@ const config: Configuration = {
 
   resolve: {
     extensions: [".tsx", ".ts", "..."],
+    extensionAlias: {
+      ".js": [".ts", ".tsx", ".js"],
+    },
   },
 
   externalsType: "commonjs",
diff --git a/yarn.lock b/yarn.lock
