Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: switch to ESM #9236

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
build
*.cjs
*.js
File renamed without changes.
2 changes: 1 addition & 1 deletion babel.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Only used for jest
module.exports = {
export default {
presets: [
[
'@babel/preset-env',
Expand Down
17 changes: 9 additions & 8 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
/** @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
}
]
}
};

module.exports = config;
28 changes: 14 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"jsdelivr": "build/vega-lite.min.js",
"module": "build/src/index",
"types": "build/src/index.d.ts",
"type": "module",
"bin": {
"vl2pdf": "./bin/vl2pdf",
"vl2png": "./bin/vl2png",
Expand Down Expand Up @@ -79,8 +80,8 @@
"url": "https://github.com/vega/vega-lite/issues"
},
"devDependencies": {
"@babel/core": "^7.23.6",
"@babel/preset-env": "^7.23.6",
"@babel/core": "^7.23.9",
"@babel/preset-env": "^7.23.9",
"@babel/preset-typescript": "^7.23.3",
"@release-it/conventional-changelog": "^8.0.1",
"@rollup/plugin-alias": "^5.1.0",
Expand All @@ -93,38 +94,37 @@
"@types/d3": "^7.4.3",
"@types/jest": "^29.5.11",
"@types/pako": "^2.0.3",
"@typescript-eslint/eslint-plugin": "^6.15.0",
"@typescript-eslint/parser": "^6.15.0",
"@typescript-eslint/eslint-plugin": "^6.20.0",
"@typescript-eslint/parser": "^6.20.0",
"ajv": "^8.12.0",
"ajv-formats": "^2.1.1",
"chai": "^4.3.10",
"chai": "^5.0.3",
"cheerio": "^1.0.0-rc.12",
"conventional-changelog-cli": "^4.1.0",
"d3": "^7.8.5",
"del-cli": "^5.1.0",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-jest": "^27.6.0",
"eslint-plugin-prettier": "^5.0.1",
"eslint-plugin-jest": "^27.6.3",
"eslint-plugin-prettier": "^5.1.3",
"fast-json-stable-stringify": "~2.1.0",
"highlight.js": "^11.9.0",
"jest": "^29.7.0",
"jest-dev-server": "^9.0.2",
"mkdirp": "^3.0.1",
"pako": "^2.1.0",
"prettier": "^3.1.1",
"prettier": "^3.2.4",
"puppeteer": "^15.0.0",
"release-it": "^17.0.1",
"rollup": "^4.9.1",
"release-it": "^17.0.3",
"rollup": "^4.9.6",
"rollup-plugin-bundle-size": "^1.0.3",
"rollup-plugin-sourcemaps": "^0.6.3",
"serve": "^14.2.1",
"terser": "^5.26.0",
"ts-jest": "^29.1.1",
"terser": "^5.27.0",
"ts-jest": "^29.1.2",
"ts-json-schema-generator": "^1.5.0",
"typescript": "~5.3.3",
"vega-cli": "^5.27.0",
"vega-datasets": "^2.7.0",
"vega-datasets": "^2.8.0",
"vega-embed": "^6.24.0",
"vega-tooltip": "^0.34.0",
"yaml-front-matter": "^4.1.1"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
16 changes: 7 additions & 9 deletions test-runtime/puppeteer_environment.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
const {readFile} = require('fs').promises;
const os = require('os');
const path = require('path');
const puppeteer = require('puppeteer');
const NodeEnvironment = require('jest-environment-node').TestEnvironment;
import {readFile} from 'fs/promises';
import os from 'os';
import path from 'path';
import {connect} from 'puppeteer';
import NodeEnvironment from 'jest-environment-node';

const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');

class PuppeteerEnvironment extends NodeEnvironment {
export default class PuppeteerEnvironment extends NodeEnvironment.TestEnvironment {
constructor(config) {
super(config);
}
Expand All @@ -20,7 +20,7 @@ class PuppeteerEnvironment extends NodeEnvironment {
}

// connect to puppeteer
this.global.__BROWSER_GLOBAL__ = await puppeteer.connect({
this.global.__BROWSER_GLOBAL__ = await connect({
browserWSEndpoint: wsEndpoint
});
}
Expand All @@ -36,5 +36,3 @@ class PuppeteerEnvironment extends NodeEnvironment {
return super.getVmContext();
}
}

module.exports = PuppeteerEnvironment;
26 changes: 14 additions & 12 deletions test-runtime/setup.js
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
const {mkdir, writeFile} = require('fs').promises;
const os = require('os');
const path = require('path');
const puppeteer = require('puppeteer');
const {setup: setupDevServer} = require('jest-dev-server');
const chalk = require('chalk');
import {mkdir, writeFile} from 'fs/promises';
import {tmpdir} from 'os';
import {join} from 'path';
import {launch} from 'puppeteer';
import {setup as setupDevServer} from 'jest-dev-server';
import chalk from 'chalk';

const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');
const {green} = chalk;

module.exports = async function () {
const DIR = join(tmpdir(), 'jest_puppeteer_global_setup');

export default async function () {
globalThis.servers = await setupDevServer({
command: `node ./node_modules/.bin/serve -l 8000`,
launchTimeout: 50000,
port: 8000
});

console.log(chalk.green('Setup Puppeteer'));
console.log(green('Setup Puppeteer'));

const browser = await puppeteer.launch();
const browser = await launch();
// store the browser instance so we can teardown it later
// this global is only available in the teardown but not in TestEnvironments
globalThis.__BROWSER_GLOBAL__ = browser;

// use the file system to expose the wsEndpoint for TestEnvironments
await mkdir(DIR, {recursive: true});
await writeFile(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint());
};
await writeFile(join(DIR, 'wsEndpoint'), browser.wsEndpoint());
}
14 changes: 7 additions & 7 deletions test-runtime/teardown.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
const fs = require('fs').promises;
const os = require('os');
const path = require('path');
const {teardown: teardownDevServer} = require('jest-dev-server');
import {rm} from 'fs/promises';
import os from 'os';
import path from 'path';
import {teardown as teardownDevServer} from 'jest-dev-server';

const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');

module.exports = async function () {
export default async function () {
await teardownDevServer(globalThis.servers);

// close the browser instance
await globalThis.__BROWSER_GLOBAL__.close();

// clean-up the wsEndpoint file
await fs.rm(DIR, {recursive: true, force: true});
};
await rm(DIR, {recursive: true, force: true});
}