@jspsych/config 2.0.1 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @jspsych/config
 
+## 3.0.0
+
+### Major Changes
+
+- [#2858](https://github.com/jspsych/jsPsych/pull/2858) [`76e75080`](https://github.com/jspsych/jsPsych/commit/76e75080247e936c6ae8a8227517fb95ce74974b) Thanks [@bjoluc](https://github.com/bjoluc)! - Activate TypeScript's `isolatedModules` flag in the root `tsconfig.json` file. If you are facing any TypeScript errors due to `isolatedModules`, please update your code according to the error messages.
+
+- [#2858](https://github.com/jspsych/jsPsych/pull/2858) [`810ed7a3`](https://github.com/jspsych/jsPsych/commit/810ed7a3d1d9181cf25a9cb11ddd37914cd97483) Thanks [@bjoluc](https://github.com/bjoluc)! - Migrate the build chain from TypeScript, Babel, and Terser to [esbuild](https://esbuild.github.io/). Babel and Terser are no longer included as dependencies and the Babel configuration at `@jspsych/config/babel` has been removed. The minified browser builds are only transpiled down to [ES2015](https://caniuse.com/es6) now.
+
+## 2.0.2
+
+### Patch Changes
+
+- [#3293](https://github.com/jspsych/jsPsych/pull/3293) [`7bcd4e0a`](https://github.com/jspsych/jsPsych/commit/7bcd4e0a25b46e2cf384f6b747092e75fabce00f) Thanks [@becky-gilbert](https://github.com/becky-gilbert)! - This fixes an error in the gulp task that creates the dist archive for a release, which was causing the dist archive to fail.
+
 ## 2.0.1
 
 ### Patch Changes

package/gulp.js

@@ -83,7 +83,7 @@ export const createCoreDistArchive = () =>
     src("packages/jspsych/css/jspsych.css").pipe(rename("/dist/jspsych.css")),
 
     // survey.css
-    src("packages/survey/css/survey.css").pipe(rename("/dist/survey.css")),
+    src("packages/plugin-survey/css/survey.css").pipe(rename("/dist/survey.css")),
 
     // Examples
     src("examples/**/*", { base: "." })

package/jest.cjs

@@ -8,6 +8,7 @@ module.exports.makePackageConfig = (dirname) => {
   return {
     transform: { "\\.(js|jsx|ts|tsx)$": "@sucrase/jest-plugin" },
     moduleNameMapper: hq.load(dirname + "/tsconfig.json").get("jest"),
+
     testEnvironment: "jsdom",
     testEnvironmentOptions: {
       fetchExternalResources: true,

package/package.json

@@ -1,13 +1,9 @@
 {
   "name": "@jspsych/config",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Shared (build) configuration for jsPsych packages",
   "type": "module",
   "exports": {
-    "./babel": {
-      "import": null,
-      "require": "./babel.cjs"
-    },
     "./gulp": {
       "import": "./gulp.js",
       "require": null
@@ -39,33 +35,27 @@
   },
   "homepage": "https://www.jspsych.org/latest/developers/configuration",
   "dependencies": {
-    "@babel/cli": "7.23.0",
-    "@babel/core": "7.23.3",
-    "@babel/preset-env": "7.23.3",
-    "@rollup/plugin-babel": "6.0.4",
     "@rollup/plugin-commonjs": "25.0.7",
-    "@rollup/plugin-json": "6.0.1",
     "@rollup/plugin-node-resolve": "15.2.3",
-    "@rollup/plugin-replace": "5.0.5",
-    "@rollup/plugin-terser": "0.4.4",
     "@sucrase/jest-plugin": "3.0.0",
     "@types/gulp": "4.0.17",
     "@types/jest": "29.5.8",
     "alias-hq": "6.2.3",
-    "babel-preset-minify": "0.5.2",
     "canvas": "^2.11.2",
+    "esbuild": "0.15.14",
     "gulp": "4.0.2",
     "gulp-cli": "2.3.0",
-    "gulp-file": "^0.4.0",
+    "gulp-file": "0.4.0",
     "gulp-rename": "2.0.0",
     "gulp-replace": "1.1.4",
     "gulp-zip": "6.0.0",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
     "merge-stream": "2.0.0",
-    "regenerator-runtime": "0.14.0",
     "rollup": "4.3.0",
-    "rollup-plugin-typescript2": "0.36.0",
+    "rollup-plugin-dts": "5.0.0",
+    "rollup-plugin-esbuild": "5.0.0",
+    "rollup-plugin-node-externals": "5.0.2",
     "sucrase": "3.34.0",
     "tslib": "2.6.2",
     "typescript": "^5.2.2"

package/rollup.js

@@ -1,16 +1,23 @@
 import { readFileSync } from "node:fs";
+import path from "path";
 
-import { DEFAULT_EXTENSIONS as babelDefaultExtensions } from "@babel/core";
-import { babel } from "@rollup/plugin-babel";
 import commonjs from "@rollup/plugin-commonjs";
-import json from "@rollup/plugin-json";
 import resolve from "@rollup/plugin-node-resolve";
-import replace from "@rollup/plugin-replace";
-import terser from "@rollup/plugin-terser";
 import { defineConfig } from "rollup";
-import typescript from "rollup-plugin-typescript2";
+import dts from "rollup-plugin-dts";
+import esbuild from "rollup-plugin-esbuild";
+import externals from "rollup-plugin-node-externals";
 import ts from "typescript";
 
+const getTsCompilerOptions = () => {
+  const cwd = process.cwd();
+  return ts.parseJsonConfigFileContent(
+    ts.readConfigFile(path.join(cwd, "tsconfig.json"), ts.sys.readFile).config,
+    ts.sys,
+    cwd
+  ).options;
+};
+
 const getPackageInfo = () => {
   const { name, version } = JSON.parse(readFileSync("./package.json"));
   return { name, version };
@@ -22,7 +29,7 @@ const makeConfig = ({
   iifeOutputOptions = {},
   isNodeOnlyBuild = false,
 }) => {
-  const source = "src/index";
+  const input = "src/index.ts";
   const destinationDirectory = "dist";
   const destination = `${destinationDirectory}/index`;
 
@@ -31,100 +38,94 @@ const makeConfig = ({
     ...outputOptions,
   };
 
-  const commonConfig = defineConfig({
-    input: `${source}.ts`,
-    plugins: [
-      resolve({ preferBuiltins: isNodeOnlyBuild }),
-      typescript({
-        typescript: ts,
-        tsconfigDefaults: {
-          exclude: ["./tests", "**/*.spec.ts", "**/*.test.ts", "./dist"],
-        },
-        tsconfigOverride: {
+  /** @type{import("rollup-plugin-esbuild").Options} */
+  const esBuildPluginOptions = {
+    loaders: { ".json": "json" },
+  };
+
+  /** @type{import("@rollup/plugin-commonjs").RollupCommonJSOptions} */
+  const commonjsPluginOptions = {
+    extensions: [".js", ".json"],
+  };
+
+  // Non-babel builds
+  const config = defineConfig([
+    // Type definitions (bundled as a single .d.ts file)
+    {
+      input,
+      output: [{ file: `${destination}.d.ts`, format: "es" }],
+      plugins: [
+        dts({
           compilerOptions: {
-            rootDir: "./src",
-            outDir: "./dist",
+            ...getTsCompilerOptions(),
+            noEmit: false,
             paths: {}, // Do not include files referenced via `paths`
           },
-        },
-      }),
-      json(),
-      commonjs(),
-    ],
-    ...globalOptions,
-  });
-
-  /** @type {import("rollup").OutputOptions} */
-  const output = [
-    {
-      // Build file to be used as an ES import
-      file: `${destination}.js`,
-      format: "esm",
-      ...outputOptions,
+        }),
+      ],
     },
+
+    // Module builds
     {
-      // Build commonjs module (for tools that do not fully support ES6 modules)
-      file: `${destination}.cjs`,
-      format: "cjs",
-      ...outputOptions,
+      ...globalOptions,
+      input,
+      plugins: [
+        externals(),
+        esbuild({ ...esBuildPluginOptions, target: "node18" }),
+        commonjs(commonjsPluginOptions),
+      ],
+      output: [
+        { file: `${destination}.js`, format: "esm", ...outputOptions },
+        { file: `${destination}.cjs`, format: "cjs", ...outputOptions },
+      ],
     },
-  ];
+  ]);
 
-  let sourcemapBaseUrl;
   if (!isNodeOnlyBuild) {
     // In builds that are published to NPM (potentially every CI build), point to sourcemaps via the
     // package's canonical unpkg URL
+    let sourcemapBaseUrl;
     if (process.env.CI) {
       const { name, version } = getPackageInfo();
       sourcemapBaseUrl = `https://unpkg.com/${name}@${version}/${destinationDirectory}/`;
     }
 
-    output.push({
-      // Build file to be used for tinkering in modern browsers
-      file: `${destination}.browser.js`,
-      format: "iife",
-      sourcemapBaseUrl,
-      ...outputOptions,
-      ...iifeOutputOptions,
+    // IIFE build for tinkering in modern browsers
+    config.push({
+      ...globalOptions,
+      input,
+      plugins: [
+        externals({ deps: false }),
+        resolve({ preferBuiltins: false }),
+        esbuild({ ...esBuildPluginOptions, target: "esnext" }),
+        commonjs(commonjsPluginOptions),
+      ],
+      output: {
+        file: `${destination}.browser.js`,
+        format: "iife",
+        sourcemapBaseUrl,
+        ...outputOptions,
+        ...iifeOutputOptions,
+      },
     });
-  }
 
-  // Non-babel builds
-  const config = defineConfig([{ ...commonConfig, output }]);
-
-  if (!isNodeOnlyBuild) {
-    // Babel build
+    // Minified production IIFE build
     config.push({
-      ...commonConfig,
+      ...globalOptions,
+      input,
       plugins: [
-        // Import `regenerator-runtime` if requested:
-        replace({
-          values: {
-            "// __rollup-babel-import-regenerator-runtime__":
-              'import "regenerator-runtime/runtime.js";',
-          },
-          delimiters: ["", ""],
-          preventAssignment: true,
-        }),
-        ...commonConfig.plugins,
-        babel({
-          babelHelpers: "bundled",
-          extends: "@jspsych/config/babel",
-          // https://github.com/ezolenko/rollup-plugin-typescript2#rollupplugin-babel
-          extensions: [...babelDefaultExtensions, ".ts"],
-        }),
-      ],
-      output: [
-        {
-          // Minified production build file
-          file: `${destination}.browser.min.js`,
-          format: "iife",
-          plugins: [terser()],
-          sourcemapBaseUrl,
-          ...outputOptions,
-          ...iifeOutputOptions,
-        },
+        externals({ deps: false }),
+        resolve({ preferBuiltins: false }),
+        esbuild({ ...esBuildPluginOptions, target: "es2015", minify: true }),
+        commonjs(commonjsPluginOptions),
       ],
+      output: {
+        file: `${destination}.browser.min.js`,
+        format: "iife",
+        sourcemapBaseUrl,
+        ...outputOptions,
+        ...iifeOutputOptions,
+      },
     });
   }
 

package/tsconfig.core.json

@@ -7,8 +7,7 @@
       "jspsych": ["../jspsych/src"],
       "@jspsych/*": ["../*/src"]
     },
-    // allow resolving json modules in tests (needed for transitive imports of jspsych in tests;
-    // the jspsych package itself uses https://stackoverflow.com/a/61426303 instead)
+    // allow resolving json modules in tests (needed for transitive imports of jspsych)
     "resolveJsonModule": true
   }
 }

package/tsconfig.json

@@ -1,33 +1,21 @@
 {
-  // shared base tsconfig for all jsPsych packages
-  // based on https://github.com/formium/tsdx/blob/462af2d002987f985695b98400e0344b8f2754b7/templates/basic/tsconfig.json
-  // see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
   "compilerOptions": {
     "target": "ES6",
     "module": "ESNext",
     "lib": ["dom", "esnext"],
     "importHelpers": true,
-    // output .d.ts declaration files for consumers
     "declaration": true,
-    // output .js.map sourcemap files for consumers
     "sourceMap": true,
-    // stricter type-checking for stronger correctness. Recommended by TS
     "strict": false, // should be enabled one lucky day
-    // linter checks for common issues
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
-    // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
     "noUnusedLocals": false, // should be enabled one lucky day
     "noUnusedParameters": false, // should be enabled one lucky day
-    // use Node's module resolution algorithm, instead of the legacy TS one
     "moduleResolution": "node",
-    // interop between ESM and CJS modules. Recommended by TS
     "esModuleInterop": true,
-    // significant perf increase by skipping checking .d.ts files, particularly those in node_modules. Recommended by TS
     "skipLibCheck": true,
-    // error out if import and file system have a casing mismatch. Recommended by TS
     "forceConsistentCasingInFileNames": true,
-    // do not emit build output when running `tsc`
-    "noEmit": true
+    "noEmit": true,
+    "isolatedModules": true // required by Sucrase
   }
 }

package/babel.cjs

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: ["@babel/preset-env"],
-};