feat!: convert to ESM and vitest (#1230)

.eslintrc.cjs

@@ -2,13 +2,13 @@ const { overrides } = require('@netlify/eslint-config-node')
 
 module.exports = {
   extends: '@netlify/eslint-config-node',
+  parserOptions: {
+    sourceType: 'module',
+  },
   rules: {
     'import/extensions': ['error', 'ignorePackages'],
     'n/no-missing-import': 'off',
-    // This is disabled because TypeScript transpiles some features currently
-    // unsupported by Node 12, i.e. optional chaining
-    // TODO: re-enable after dropping support for Node 12
-    'n/no-unsupported-features/es-syntax': 'off',
+    'no-magic-numbers': 'off',
     // This rule enforces using Buffers with `JSON.parse()`. However, TypeScript
     // does not recognize yet that `JSON.parse()` accepts Buffers as argument.
     'unicorn/prefer-json-parse-buffer': 'off',
@@ -37,19 +37,15 @@ module.exports = {
       },
     },
     {
-      files: 'tests/**/*.js',
+      files: 'tests/**/*.ts',
       rules: {
         'import/max-dependencies': 'off',
         'max-lines-per-function': 'off',
+        'max-nested-callbacks': 'off',
         'max-statements': 'off',
-        'no-magic-numbers': 'off',
         'padding-line-between-statements': 'off',
-      },
-    },
-    {
-      files: '*.md/*.js',
-      parserOptions: {
-        sourceType: 'module',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
       },
     },
   ],

.github/workflows/release-please.yml

@@ -17,7 +17,7 @@ jobs:
         with:
           token: ${{ steps.get-token.outputs.token }}
           release-type: node
-          package-name: '@netlify/@netlify/zip-it-and-ship-it'
+          package-name: '@netlify/zip-it-and-ship-it'
       - uses: actions/checkout@v3
         if: ${{ steps.release.outputs.release_created }}
       - uses: actions/setup-node@v3

.github/workflows/workflow.yml

@@ -38,21 +38,28 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Linting
+        if: "${{ matrix.node-version == '*' }}"
         run: npm run format:ci
+      - name: Tests with coverage
         if: "${{ matrix.node-version == '*' }}"
+        run: npm run test:ci -- --coverage
+        env:
+          ZISI_TEST_RATE_LIMIT: 3
       - name: Tests
+        if: "${{ matrix.node-version != '*' }}"
         run: npm run test:ci
         env:
           ZISI_TEST_RATE_LIMIT: 3
       - name: Get test coverage flags
+        if: "${{ matrix.node-version == '*' }}"
         id: test-coverage-flags
         run: |-
           os=${{ matrix.os }}
-          node=${{ matrix.node-version }}
-          echo "::set-output name=os::${os/-latest/}"
-          echo "::set-output name=node::node_${node//[.*]/}"
+          node=$(node --version)
+          echo "os=${os/-latest/}" >> $GITHUB_OUTPUT
+          echo "node=node_${node/.*.*/}" >> $GITHUB_OUTPUT
         shell: bash
       - uses: codecov/codecov-action@v3
+        if: "${{ matrix.node-version == '*' }}"
         with:
-          file: coverage/coverage-final.json
           flags: ${{ steps.test-coverage-flags.outputs.os }},${{ steps.test-coverage-flags.outputs.node }}

.gitignore

@@ -12,5 +12,5 @@ node_modules
 !tests/fixtures/**/node_modules
 benchmarks/fixtures/*/package*.json
 benchmarks/output
-.delta-t.json
+.delta.*
 /dist

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+node_modules
+tests/fixtures/

benchmarks/esbuild.js

@@ -1,4 +1,5 @@
 import { join } from 'path'
+import process from 'process'
 
 import { zipFunctions } from '../dist/main.js'
 
@@ -19,4 +20,9 @@ const runBenchmarks = async function () {
   console.log(`${largeDepsEsbuild}ms`)
 }
 
-runBenchmarks()
+try {
+  await runBenchmarks()
+  process.stderr.write('ESBuild benchmark finished\n')
+} catch (error) {
+  console.error(error)
+}

benchmarks/helpers/main.js

@@ -3,30 +3,29 @@ import { fileURLToPath } from 'url'
 
 export const FIXTURES_DIR = fileURLToPath(new URL('../fixtures', import.meta.url))
 
-export const timeFunction = (func, runs = 1) =>
-  new Promise((resolve) => {
-    const finishedRuns = new Map()
+export const timeFunction = async (func, runs = 1) => {
+  const finishedRuns = new Map()
 
-    const observer = new PerformanceObserver((list) => {
-      const [entry] = list.getEntries()
+  const observer = new PerformanceObserver((list) => {
+    const [entry] = list.getEntries()
 
-      finishedRuns.set(entry.name, entry.duration)
-
-      if (finishedRuns.size === runs) {
-        const durations = [...finishedRuns.values()]
-        const average = durations.reduce((acc, duration) => duration + acc, 0) / runs
-
-        resolve(average)
-      }
-    })
+    finishedRuns.set(entry.name, entry.duration)
+  })
 
-    observer.observe({ entryTypes: ['measure'] })
+  observer.observe({ entryTypes: ['measure'] })
 
-    Array.from({ length: runs }).forEach(async (_, index) => {
+  await Promise.all(
+    Array.from({ length: runs }).map(async (_, index) => {
       performance.mark(`run-${index}-start`)
 
       await func(index)
 
       performance.measure(`run-${index}`, `run-${index}-start`)
-    })
-  })
+    }),
+  )
+
+  const durations = [...finishedRuns.values()]
+  const average = durations.reduce((acc, duration) => duration + acc, 0) / runs
+
+  return average
+}

benchmarks/nft.js

@@ -1,3 +1,5 @@
+import process from 'process'
+
 import { zipFunctions } from '../dist/main.js'
 
 import { timeFunction, FIXTURES_DIR } from './helpers/main.js'
@@ -17,4 +19,9 @@ const runBenchmarks = async function () {
   console.log(`${largeDepsNft}ms`)
 }
 
-runBenchmarks()
+try {
+  await runBenchmarks()
+  process.stderr.write('NFT benchmark finished\n')
+} catch (error) {
+  console.error(error)
+}

benchmarks/run.sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+set -exo pipefail
+
 npm ci --prefix benchmarks/fixtures
 npm run build
 node benchmarks/nft.js > .delta.largeDepsNft

benchmarks/zisi.js

@@ -1,3 +1,5 @@
+import process from 'process'
+
 import { zipFunctions } from '../dist/main.js'
 
 import { timeFunction, FIXTURES_DIR } from './helpers/main.js'
@@ -17,4 +19,9 @@ const runBenchmarks = async function () {
   console.log(`${largeDepsZisi}ms`)
 }
 
-runBenchmarks()
+try {
+  await runBenchmarks()
+  process.stderr.write('ZISI benchmark finished\n')
+} catch (error) {
+  console.error(error)
+}