Update to working open, switch to ESM (#499)

Author: flying-sheep

.github/workflows/ci.yml

@@ -15,18 +15,19 @@ jobs:
         node-version: [18.x, 20.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
       - run: npm test
         env:
           CI: true
-
+      - name: Try CLI
+        run: node bin/cli.mjs -v
       - name: Coveralls Parallel
-        uses: coverallsapp/github-action@master
+        uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.github_token }}
           flag-name: run-${{ matrix.node-version }}
@@ -37,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Coveralls Finished
-        uses: coverallsapp/github-action@master
+        uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.github_token }}
           parallel-finished: true

README-ADMINS.md

@@ -21,10 +21,10 @@ cd /var/folders/l0/qtd9z14973s2tw81vmzwkyp00000gp/T/speedscope-test-installation
 
 Run this command, to switch to the test directory.
 
-Inside of here, run `bin/cli.js`. This should open a copy of speedscope in browser.
+Inside of here, run `bin/cli.mjs`. This should open a copy of speedscope in browser.
 Try importing a profile from disk via the browse button and make sure it works.
 
-Next, try running `bin/cli.js dist/release/perf-vertx*`. This should immediately open
+Next, try running `bin/cli.mjs dist/release/perf-vertx*`. This should immediately open
 speedscope in browser, and the perf-vertx file should load immediately.
 
 ## Create & publish the new release

bin/cli.js renamed to bin/cli.mjs

@@ -1,10 +1,14 @@
 #!/usr/bin/env node
-const path = require('path')
-const fs = require('fs')
-const os = require('os')
-const stream = require('stream')
+import path from 'node:path'
+import fs from 'node:fs'
+import os from 'node:os'
+import stream from 'node:stream'
+import { fileURLToPath } from 'node:url'
 
-const open = require('open')
+import open from 'open'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
 
 const helpString = `Usage: speedscope [filepath]
 
@@ -52,7 +56,9 @@ async function main() {
   }
 
   if (process.argv.includes('--version') || process.argv.includes('-v')) {
-    console.log('v' + require('../package.json').version)
+    const json = fs.readFileSync(path.resolve(__dirname, '../package.json'), { encoding: 'utf-8' })
+    const { version } = JSON.parse(json)
+    console.log(`v${version}`)
     return
   }
 
@@ -87,14 +93,16 @@ async function main() {
     fs.writeFileSync(jsPath, jsSource)
     urlToOpen += `#localProfilePath=${jsPath}`
 
-    // For some silly reason, the OS X open command ignores any query parameters or hash parameters
+    // For some silly reason, the macOS `open` and Windows `start` commands ignore hash parameters
     // passed as part of the URL. To get around this weird issue, we'll create a local HTML file
     // that just redirects.
-    const htmlPath = path.join(os.tmpdir(), `${filePrefix}.html`)
-    console.log(`Creating temp file ${htmlPath}`)
-    fs.writeFileSync(htmlPath, `<script>window.location=${JSON.stringify(urlToOpen)}</script>`)
+    if (process.platform === 'darwin' || process.platform === 'win32') {
+      const htmlPath = path.join(os.tmpdir(), `${filePrefix}.html`)
+      console.log(`Creating temp file ${htmlPath}`)
+      fs.writeFileSync(htmlPath, `<script>window.location=${JSON.stringify(urlToOpen)}</script>`)
 
-    urlToOpen = `file://${htmlPath}`
+      urlToOpen = `file://${htmlPath}`
+    }
   }
 
   console.log('Opening', urlToOpen, 'in your default browser')

package-lock.json

@@ -5,7 +5,7 @@
   "repository": "jlfwong/speedscope",
   "main": "index.js",
   "bin": {
-    "speedscope": "./bin/cli.js"
+    "speedscope": "./bin/cli.mjs"
   },
   "scripts": {
     "deploy": "./scripts/deploy.sh",
@@ -19,7 +19,7 @@
     "serve": "tsx scripts/dev-server.ts"
   },
   "files": [
-    "bin/cli.js",
+    "bin/cli.mjs",
     "dist/release/**",
     "!*.map"
   ],
@@ -78,6 +78,6 @@
     ]
   },
   "dependencies": {
-    "open": "7.2.0"
+    "open": "10.1.0"
   }
 }