[ENG-4579][scripts] convert to ESM (#1192)

dsokal · web-flow · commit 04a8b08f5981 · 2022-07-04T11:50:57.000+02:00
* upgrade typescript to 4.7.4

* [scripts] add extensions to imports

* [scripts] configure as ESM

* [scripts] fix after converting to ESM

* [scripts] fix lint

* [scripts] require node &gt;= 14.16

* [scripts] add node: protocol

* add scripts/build to .gitignore

* [scripts] add typecheck script

* add workflow for testing scripts

* address PR feedback
diff --git a/.github/workflows/test-scripts.yml b/.github/workflows/test-scripts.yml
@@ -0,0 +1,26 @@
+name: Test scripts
+
+defaults:
+  run:
+    working-directory: scripts
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'scripts/**'
+  pull_request:
+    paths:
+      - 'scripts/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18
+      - run: yarn install --frozen-lockfile --check-files
+      - run: yarn typecheck
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 packages/*/build
 packages/eas-cli/dist
 packages/eas-cli/tmp
+scripts/build
 
 # Code editors
 .idea
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
     "oclif": "3.0.1",
     "prettier": "2.6.2",
     "ts-jest": "28.0.2",
-    "typescript": "4.6.4"
+    "typescript": "4.7.4"
   },
   "volta": {
     "node": "18.2.0",
diff --git a/packages/eas-cli/package.json b/packages/eas-cli/package.json
@@ -103,7 +103,7 @@
     "nock": "13.2.4",
     "tempy": "0.7.0",
     "ts-deepmerge": "2.0.1",
-    "typescript": "4.6.4"
+    "typescript": "4.7.4"
   },
   "engines": {
     "node": ">=14.0.0"
diff --git a/packages/eas-json/package.json b/packages/eas-json/package.json
@@ -18,7 +18,7 @@
   "devDependencies": {
     "@types/fs-extra": "9.0.13",
     "memfs": "3.4.3",
-    "typescript": "4.6.4"
+    "typescript": "4.7.4"
   },
   "engines": {
     "node": ">=14.0.0"
diff --git a/scripts/.eslintrc.cjs b/scripts/.eslintrc.cjs
diff --git a/scripts/package.json b/scripts/package.json
@@ -1,33 +1,34 @@
 {
   "name": "scripts",
   "private": true,
+  "type": "module",
   "version": "0.31.0",
   "scripts": {
-    "changelog-entry": "ts-node src/changelogEntry.ts",
-    "release-changelog": "ts-node src/releaseChangelog.ts",
-    "update-local-plugin": "./src/updateLocalPlugin.sh"
+    "changelog-entry": "ts-node-esm src/changelogEntry.ts",
+    "release-changelog": "ts-node-esm src/releaseChangelog.ts",
+    "update-local-plugin": "./src/updateLocalPlugin.sh",
+    "typecheck": "tsc"
   },
   "author": "Expo <support@expo.dev>",
   "license": "MIT",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=14.16"
   },
   "dependencies": {
     "dateformat": "4.5.1",
     "fs-extra": "10.1.0",
-    "lodash": "4.17.21",
+    "lodash-es": "4.17.21",
     "marked": "3.0.4",
-    "nullthrows": "1.1.1",
     "semver": "7.3.7",
     "tslib": "2.4.0"
   },
   "devDependencies": {
     "@types/dateformat": "3.0.1",
     "@types/fs-extra": "9.0.13",
-    "@types/lodash": "4.14.182",
+    "@types/lodash-es": "4.17.6",
     "@types/node": "17.0.32",
     "@types/semver": "7.3.9",
     "ts-node": "10.7.0",
-    "typescript": "4.6.4"
+    "typescript": "4.7.4"
   }
 }
diff --git a/scripts/src/changelog/consts.ts b/scripts/src/changelog/consts.ts
@@ -1,4 +1,4 @@
-import path from 'path';
+import { URL } from 'node:url';
 
 export enum EntryCategory {
   BreakingChange = 'breaking-change',
@@ -7,7 +7,7 @@ export enum EntryCategory {
   Chore = 'chore',
 }
 
-export const CHANGELOG_PATH = path.join(__dirname, '../../../CHANGELOG.md');
+export const CHANGELOG_PATH = new URL('../../../CHANGELOG.md', import.meta.url);
 
 export const CATEGORY_HEADERS: Record<EntryCategory, string> = {
   [EntryCategory.BreakingChange]: '🛠 Breaking changes',
diff --git a/scripts/src/changelog/file.ts b/scripts/src/changelog/file.ts
@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 
-import * as markdown from '../markdown';
-import { CHANGELOG_PATH } from './consts';
+import * as markdown from '../markdown.js';
+import { CHANGELOG_PATH } from './consts.js';
 
 export async function readAndParseChangelogAsync(): Promise<markdown.Tokens> {
   const contents = await fs.readFile(CHANGELOG_PATH, 'utf8');
diff --git a/scripts/src/changelogEntry.ts b/scripts/src/changelogEntry.ts
@@ -1,8 +1,7 @@
-import nullthrows from 'nullthrows';
-
-import { CATEGORY_HEADERS, EntryCategory } from './changelog/consts';
-import { readAndParseChangelogAsync, writeChangelogAsync } from './changelog/file';
-import * as markdown from './markdown';
+import { CATEGORY_HEADERS, EntryCategory } from './changelog/consts.js';
+import { readAndParseChangelogAsync, writeChangelogAsync } from './changelog/file.js';
+import * as markdown from './markdown.js';
+import { nullthrows } from './nullthrows.js';
 
 const [rawCategory, ...rest] = process.argv.slice(2);
 const message = rest.join(' ');
diff --git a/scripts/src/markdown.ts b/scripts/src/markdown.ts
@@ -1,6 +1,6 @@
 // this is mostly copy-pasted from https://github.com/expo/expo/blob/master/tools/src/Markdown.ts
 
-import { unescape } from 'lodash';
+import { unescape } from 'lodash-es';
 import marked from 'marked';
 
 export enum TokenType {
diff --git a/scripts/src/nullthrows.ts b/scripts/src/nullthrows.ts
@@ -0,0 +1,9 @@
+export function nullthrows<T>(value: T | null | undefined, message?: string): T {
+  if (value !== null && value !== undefined) {
+    return value;
+  }
+
+  const error = new Error(message !== undefined ? message : `Got unexpected ${value}`);
+  (error as any).framesToPop = 1; // Skip nullthrows's own stack frame.
+  throw error;
+}
diff --git a/scripts/src/releaseChangelog.ts b/scripts/src/releaseChangelog.ts
@@ -1,9 +1,9 @@
 import dateFormat from 'dateformat';
 import semver from 'semver';
 
-import { CATEGORY_HEADERS } from './changelog/consts';
-import { readAndParseChangelogAsync, writeChangelogAsync } from './changelog/file';
-import * as markdown from './markdown';
+import { CATEGORY_HEADERS } from './changelog/consts.js';
+import { readAndParseChangelogAsync, writeChangelogAsync } from './changelog/file.js';
+import * as markdown from './markdown.js';
 
 const MAIN_CATEGORIES = Object.values(CATEGORY_HEADERS).map(text =>
   markdown.createHeadingToken(text, 3)
diff --git a/scripts/tsconfig.json b/scripts/tsconfig.json
@@ -1,12 +1,11 @@
 {
   "compilerOptions": {
     "declaration": true,
-    "importHelpers": true,
-    "module": "commonjs",
-    "esModuleInterop": true,
+    "module": "node16",
+    "moduleResolution": "node16",
     "noImplicitReturns": true,
     "strict": true,
-    "target": "ES2019",
+    "target": "ES2020",
     "outDir": "build",
     "rootDir": "src",
     "typeRoots": [
diff --git a/scripts/yarn.lock b/scripts/yarn.lock
diff --git a/yarn.lock b/yarn.lock
