feat: switch to ESM

.eslintignore

@@ -1,2 +1,3 @@
 build
+*.cjs
 *.js

.github/workflows/check-toc.yml

@@ -24,6 +24,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile

.github/workflows/check.yml

@@ -19,6 +19,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile

.github/workflows/release-docs-and-schema.yml

@@ -26,6 +26,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile
@@ -61,6 +62,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Setup Pages
         uses: actions/configure-pages@v4

.github/workflows/test-docs.yml

@@ -20,6 +20,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile

.github/workflows/test.yml

@@ -19,6 +19,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile
@@ -43,6 +44,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile
@@ -82,6 +84,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: 'yarn'
+          node-version: current
 
       - name: Install Node dependencies
         run: yarn --frozen-lockfile

.vscode/launch.json

@@ -6,20 +6,30 @@
       "name": "vscode-jest-tests",
       "request": "launch",
       "program": "${workspaceFolder}/node_modules/jest/bin/jest",
-      "args": [
-        "--runInBand"
-      ],
+      "args": ["--runInBand"],
       "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen",
-      "disableOptimisticBPs": true
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "name": "Runtime Tests",
+      "request": "launch",
+      "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+      "env": {
+        "NODE_OPTIONS": "--experimental-vm-modules",
+        "TZ": "America/Los_Angeles"
+      },
+      "args": ["--runInBand", "--config", "test-runtime/jest-config.json"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
     },
     {
       "type": "node",
       "request": "attach",
       "name": "Attach",
-      "port": 9229,
-      "protocol": "inspector"
+      "port": 9229
     }
   ]
 }

babel.config.js → babel.config.cjs

@@ -10,5 +10,6 @@ module.exports = {
       }
     ],
     '@babel/preset-typescript'
-  ]
+  ],
+  plugins: ['@babel/plugin-syntax-import-attributes']
 };

bin/args.js

@@ -1,4 +1,6 @@
-module.exports = type => {
+import yargs from 'yargs/yargs';
+
+export default type => {
   const helpText = `${type === 'vega' ? 'Compile' : 'Render'} a Vega-Lite specification to ${
     type === 'vega' ? 'Vega' : type.toUpperCase()
   }.
@@ -10,7 +12,7 @@ To load data, you may need to set a base directory:
   For web retrieval, use '-b http://host/data/'.
   For files, use '-b file:///dir/data/' (absolute) or '-b data/' (relative).`;
 
-  const args = require('yargs').usage(helpText).demand(0);
+  const args = yargs(process.argv.slice(2)).usage(helpText).demand(0);
 
   args
     .string('b')
@@ -50,8 +52,7 @@ To load data, you may need to set a base directory:
 
   if (type === 'vega') {
     args.boolean('p').alias('p', 'pretty').describe('p', 'Output human readable/pretty spec.');
-  }
-  else if (type === 'png') {
+  } else if (type === 'png') {
     args.number('ppi').describe('ppi', 'Resolution in ppi.');
   }
 

bin/read.js

@@ -1,8 +1,8 @@
 // from vega-cli
 
-const {createReadStream} = require('fs');
+import {createReadStream} from 'fs';
 
-module.exports = file => {
+export default file => {
   return new Promise((resolve, reject) => {
     const input = file ? createReadStream(file) : process.stdin;
     let text = '';

bin/render.js

@@ -1,10 +1,10 @@
 // modified from vega-cli
 
-const vega = require('vega');
-const path = require('path');
-const args = require('./args');
-const read = require('./read');
-const vegaLite = require('..');
+import vega from 'vega';
+import path from 'path';
+import args from './args.js';
+import read from './read.js';
+import * as vegaLite from '../build/src/index.js';
 
 function load(file) {
   return require(path.resolve(file));
@@ -17,7 +17,7 @@ const Levels = {
   debug: vega.Debug
 };
 
-module.exports = (type, callback, opt) => {
+export default (type, callback, opt) => {
   // parse command line arguments
   const arg = args(type);
 
@@ -58,11 +58,14 @@ module.exports = (type, callback, opt) => {
       renderer: 'none' // no primary renderer needed
     }).finalize(); // clear any timers, etc
 
-    return (type === 'svg' ? view.toSVG(scale) : view.toCanvas(scale * ppi / 72, opt)).then(_ => callback(_, arg));
+    return (type === 'svg' ? view.toSVG(scale) : view.toCanvas((scale * ppi) / 72, opt)).then(_ => callback(_, arg));
   }
 
   // read input from file or stdin
   read(arg._[0] || null)
     .then(text => render(JSON.parse(text)))
-    .catch(err => { process.exitCode = 1; console.error(err); }); // eslint-disable-line no-console
+    .catch(err => {
+      process.exitCode = 1;
+      console.error(err);
+    }); // eslint-disable-line no-console
 };

bin/vl2pdf

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
 // Render a Vega-Lite specification to PDF, using node canvas
-const {createWriteStream} = require('fs');
-const render = require('./render');
+import {createWriteStream} from 'fs';
+import render from './render.js';
 
 render(
   'pdf',
-  function (canvas, arg) {
+  (canvas, arg) => {
     const file = arg._[1] || null;
     const out = file ? createWriteStream(file) : process.stdout;
     const stream = canvas.createPDFStream();
@@ -16,4 +16,3 @@ render(
   },
   {type: 'pdf', context: {textDrawingMode: 'glyph'}}
 );
-

bin/vl2png

@@ -1,12 +1,14 @@
 #!/usr/bin/env node
 
 // Render a Vega-Lite specification to PNG, using node canvas
-const {createWriteStream} = require('fs');
-const render = require('./render');
+import {createWriteStream} from 'fs';
+import render from './render.js';
 
-render('png', function(canvas, arg) {
+render('png', (canvas, arg) => {
   const file = arg._[1] || null;
   const out = file ? createWriteStream(file) : process.stdout;
-  const stream = canvas.createPNGStream({ resolution: arg.ppi || undefined });
-  stream.on('data', chunk => { out.write(chunk); });
+  const stream = canvas.createPNGStream({resolution: arg.ppi || undefined});
+  stream.on('data', chunk => {
+    out.write(chunk);
+  });
 });

bin/vl2svg

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 // Render a Vega-Lite specification to SVG
-const {writeFile} = require('fs');
-const render = require('./render');
+import {writeFile} from 'fs';
+import render from './render.js';
 
 const svgHeader =
   '<?xml version="1.0" encoding="utf-8"?>\n' +

bin/vl2vg

@@ -2,11 +2,11 @@
 
 // Compile a Vega-Lite spec to Vega
 
-const {createWriteStream} = require('fs');
-const vegaLite = require('..');
-const compactStringify = require('json-stringify-pretty-compact');
-const read = require('./read');
-const args = require('./args');
+import {createWriteStream} from 'fs';
+import * as vegaLite from '../build/src/index.js';
+import compactStringify from 'json-stringify-pretty-compact';
+import read from './read.js';
+import args from './args.js';
 
 const arg = args('vega');
 

examples/examples.test.ts

@@ -1,15 +1,19 @@
-import Ajv, {ErrorObject} from 'ajv';
-import addFormats from 'ajv-formats';
+import _Ajv, {ErrorObject} from 'ajv';
+import _addFormats from 'ajv-formats';
 import draft6Schema from 'ajv/lib/refs/json-schema-draft-06.json';
 import fs from 'fs';
 import path from 'path';
 import {Spec as VgSpec} from 'vega';
 import vgSchema from 'vega/build/vega-schema.json';
 import vlSchema from '../build/vega-lite-schema.json';
-import {compile} from '../src/compile/compile';
-import * as log from '../src/log';
-import {TopLevelSpec} from '../src/spec';
-import {duplicate} from '../src/util';
+import {compile} from '../src/compile/compile.js';
+import * as log from '../src/log/index.js';
+import {TopLevelSpec} from '../src/spec/index.js';
+import {duplicate} from '../src/util.js';
+
+// https://github.com/ajv-validator/ajv/issues/2132
+const Ajv = _Ajv as unknown as typeof _Ajv.default;
+const addFormats = _addFormats as unknown as typeof _addFormats.default;
 
 // import {inspect} from 'util';
 

examples/schema.test.ts

@@ -1,7 +1,10 @@
-import Ajv from 'ajv';
+import _Ajv from 'ajv';
 import {inspect} from 'util';
 import specSchema from '../build/vega-lite-schema.json';
 
+// https://github.com/ajv-validator/ajv/issues/2132
+const Ajv = _Ajv as unknown as typeof _Ajv.default;
+
 describe('Schema', () => {
   it('should be valid', () => {
     const ajv = new Ajv();

jest.config.js

@@ -1,16 +1,20 @@
 /** @type {import('jest').Config} */
-const config = {
+export default {
   preset: 'ts-jest/presets/default-esm',
   testPathIgnorePatterns: ['<rootDir>/node_modules', '<rootDir>/build', '<rootDir>/_site', '<rootDir>/src'],
   coverageDirectory: './coverage/',
   collectCoverage: false,
   setupFiles: ['./test/jest.overrides.ts'],
-  globals: {
-    'ts-jest': {
-      diagnostics: false,
-      useESM: true
-    }
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        diagnostics: false,
+        useESM: true
+      }
+    ]
+  },
+  moduleNameMapper: {
+    '(.+)\\.js': '$1'
   }
 };
-
-module.exports = config;