Merge pull request #315 from google/esm

Convert the project to ECMAScript modules

Author: ChadKillingsworth

.github/workflows/build.yml

@@ -61,14 +61,19 @@ jobs:
         run: yarn install --colors=always
       - name: Build jar
         # unset ANDROID_HOME to prevent bazel from trying to use the Android SDK
-        run: unset ANDROID_HOME && ./build-scripts/build_compiler.js
+        run: unset ANDROID_HOME && ./build-scripts/build-compiler.js
       - name: Tests
-        run: node_modules/.bin/mocha --colors
+        run: yarn test:root --color
       - name: Upload contrib folder
         uses: actions/upload-artifact@v4
         with:
           name: Contrib folder
           path: compiler/contrib
+      - name: Upload externs folder
+        uses: actions/upload-artifact@v4
+        with:
+          name: Externs folder
+          path: compiler/externs
       - name: Upload compiler jar
         uses: actions/upload-artifact@v4
         with:
@@ -120,6 +125,11 @@ jobs:
         with:
           name: Contrib folder
           path: packages/google-closure-compiler/contrib
+      - name: Download externs folder
+        uses: actions/download-artifact@v4
+        with:
+          name: Externs folder
+          path: packages/google-closure-compiler/externs
       - name: Get yarn cache directory path
         run: echo "yarn_cache_dir=$(yarn cache dir)" >> $GITHUB_ENV
       - name: Cache yarn
@@ -139,7 +149,7 @@ jobs:
           yarn run build
           upx compiler
       - name: Tests
-        run: yarn workspaces run test --colors
+        run: yarn workspaces run test --color
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -191,6 +201,11 @@ jobs:
         with:
           name: Contrib folder
           path: packages/google-closure-compiler/contrib
+      - name: Download externs folder
+        uses: actions/download-artifact@v4
+        with:
+          name: Externs folder
+          path: packages/google-closure-compiler/externs
       - name: Get yarn cache directory path
         run: echo "yarn_cache_dir=$(yarn cache dir)" >> $GITHUB_ENV
       - name: Cache yarn
@@ -210,7 +225,7 @@ jobs:
           yarn run build
           upx compiler
       - name: Tests
-        run: yarn workspaces run test --colors
+        run: yarn workspaces run test --color
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -257,6 +272,11 @@ jobs:
         with:
           name: Contrib folder
           path: packages/google-closure-compiler/contrib
+      - name: Download externs folder
+        uses: actions/download-artifact@v4
+        with:
+          name: Externs folder
+          path: packages/google-closure-compiler/externs
       - name: Get yarn cache directory path
         run: echo "yarn_cache_dir=$(yarn cache dir)" >> $GITHUB_ENV
       - name: Cache yarn
@@ -276,7 +296,7 @@ jobs:
           yarn run build
 #          upx compiler
       - name: Tests
-        run: yarn workspaces run test --colors
+        run: yarn workspaces run test --color
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -320,6 +340,11 @@ jobs:
         with:
           name: Contrib folder
           path: packages/google-closure-compiler/contrib
+      - name: Download externs folder
+        uses: actions/download-artifact@v4
+        with:
+          name: Externs folder
+          path: packages/google-closure-compiler/externs
       - name: Get yarn cache directory path
         # See https://stackoverflow.com/a/66737579/1211524
         run: echo "yarn_cache_dir=$(yarn cache dir)" >> $env:GITHUB_ENV
@@ -342,7 +367,7 @@ jobs:
         shell: cmd
         run: |
           echo "Running Tests"
-          yarn workspaces run test --colors
+          yarn workspaces run test --color
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -401,6 +426,11 @@ jobs:
         with:
           name: Contrib folder
           path: packages/google-closure-compiler/contrib
+      - name: Download externs folder
+        uses: actions/download-artifact@v4
+        with:
+          name: Externs folder
+          path: packages/google-closure-compiler/externs
       - name: Mark binaries executable
         run: |
           chmod 755 packages/google-closure-compiler-linux/compiler

.github/workflows/release.yml

@@ -49,7 +49,7 @@ jobs:
       - name: Install packages
         run: yarn install --colors=always
       - name: Build jar
-        run: ./build-scripts/build_compiler.js
+        run: ./build-scripts/build-compiler.js
       - name: Create release commit and tag
         run: |
           git config --global user.email "github-bot@github.com"

.gitignore

@@ -3,6 +3,7 @@ npm-debug.log
 yarn-error.log
 /lerna-debug.log
 /packages/google-closure-compiler/contrib/
+/packages/google-closure-compiler/externs/
 /packages/google-closure-compiler-java/compiler.jar
 /packages/google-closure-compiler-linux/compiler.jar
 /packages/google-closure-compiler-linux/compiler

README.md

@@ -21,7 +21,8 @@ Bare bones distributions intended for developers who want to author against a sp
 
  - Java build: [google-closure-compiler-java](https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler-java)
  - Native Linux build: [google-closure-compiler-linux](https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler-linux)
- - Native OSX build: [google-closure-compiler-osx](https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler-osx)
+ - Native Linux (arm64) build: [google-closure-compiler-linux-arm64](https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler-linux-arm64)
+ - Native MacOS build: [google-closure-compiler-macos](https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler-macos)
  - Native Windows build: [google-closure-compiler-windows](https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler-windows)
 
 ## License

build-scripts/add-os-restrictions.js

@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-'use strict';
 /**
  * @fileoverview
  *
@@ -23,8 +22,11 @@
  * Also set correct architectures. In order to execute `yarn install` in the main package, the current architecture
  */
 
-const fs = require('fs');
-const path = require('path');
+import fs from 'node:fs';
+import path from 'node:path';
+import {fileURLToPath, URL} from 'node:url';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 // Maps of the os marketing name to the platform name used in package.json os restriction fields
 const osRestrictions = new Map([

build-scripts/build_compiler.js renamed to build-scripts/build-compiler.js

@@ -29,12 +29,15 @@
  * commit. This is for regular integration testing of the compiler with the various tests in this repo's packages.
  * In this case the compiler will be built as a SNAPSHOT.
  */
-"use strict";
+import fs from 'node:fs';
+import path from 'node:path';
+import {fileURLToPath, URL} from 'node:url';
+import ncp from 'ncp';
+import semver from 'semver';
+import runCommand from './run-command.js';
 
-const ncp = require("ncp");
-const runCommand = require("./run-command");
-const packageInfo = require("../package.json");
-const semver = require("semver");
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
+const packageInfo = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf-8'));
 
 /**
  * The compiler version that will be built.
@@ -44,7 +47,7 @@ const semver = require("semver");
  *
  * @type {string}
  */
-const compilerVersion = process.env.COMPILER_NIGHTLY == 'true'
+const compilerVersion = process.env.COMPILER_NIGHTLY === 'true'
     ? 'SNAPSHOT-1.0'
     : `v${semver.major(packageInfo.version)}`;
 

build-scripts/build.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 # Run the build commands and fail the script if any of them failed
-./build-scripts/build_compiler.js "$@" && yarn workspaces run build "$@"
+./build-scripts/build-compiler.js "$@" && yarn workspaces run build "$@"

build-scripts/colors.js

@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 
-const fs = require('fs');
-const colors = require('./colors');
+import fs from 'node:fs';
+import chalk from 'chalk';
 
 if (!fs.existsSync(process.argv[2])) {
-  process.stderr.write(`${colors.RED}${process.argv[2]} file is missing${colors.RESET}\n`);
+  process.stderr.write(chalk.red(`${process.argv[2]} file is missing\n`));
   process.exitCode = 1;
 }

build-scripts/ensure-file-exists.js

@@ -14,16 +14,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-'use strict';
 /**
  * @fileoverview
  *
  * Build the graal native compiler image for the current OS.
  * Intended to be run with a working directory of the intended package.
  */
 
-const path = require('path');
-const runCommand = require('./run-command');
+import path from 'node:path';
+import {fileURLToPath, URL} from 'node:url';
+import runCommand from './run-command.js';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 // This script should catch and handle all rejected promises.
 // If it ever fails to do so, report that and exit immediately.