@jspsych/config 1.0.0 → 1.3.0

package/CHANGELOG.md

@@ -1,8 +1,35 @@
 # @jspsych/config
 
-## 1.0.0
-### Major Changes
+## 1.3.0
+
+### Minor Changes
+
+- [`3463e977`](https://github.com/jspsych/jsPsych/commit/3463e9778f3c2787b9c75c0f9bd7d19cc79798b3) Thanks [@becky-gilbert](https://github.com/becky-gilbert)! - Add the updatePluginVersions gulp task. This task looks at each of the docs/plugins markdown files, finds the page title and "Current version" string, adds the current version number (from the package.json file), and uses the package name as the page title.
+
+### Patch Changes
+
+- [#2631](https://github.com/jspsych/jsPsych/pull/2631) [`e77371e9`](https://github.com/jspsych/jsPsych/commit/e77371e94b3496361138d681c16840829f4c5cd2) Thanks [@bjoluc](https://github.com/bjoluc)! - Update dependencies, including Jest v27 to v28. The changelogs have been carefully checked and no breaking changes are to be expected in packages using `@jspsych/config`. Check out the [Jest 28 blog post](https://jestjs.io/blog/2022/04/25/jest-28) for a summary of the changes in Jest.
+
+* [#2632](https://github.com/jspsych/jsPsych/pull/2632) [`a17f423f`](https://github.com/jspsych/jsPsych/commit/a17f423f18df24c73baeb06d4079f9f2f9211386) Thanks [@bjoluc](https://github.com/bjoluc)! - Apply Babel Rollup plugin to `.ts` files in the `index.browser.min.js` build. It was erroneously ignoring transpiled `.ts` files before.
+
+## 1.2.0
+
+### Minor Changes
 
+- [#2431](https://github.com/jspsych/jsPsych/pull/2431) [`87f332f9`](https://github.com/jspsych/jsPsych/commit/87f332f92540eef028bbed7284e30c1cf614cc96) Thanks [@bjoluc](https://github.com/bjoluc)! - Implement an `updateUnpkgLinks` Gulp task to update each unpkg link with a precise version number to the corresponding package's current version as defined in the package's `package.json`.
 
+### Patch Changes
+
+- [#2505](https://github.com/jspsych/jsPsych/pull/2505) [`9486bc50`](https://github.com/jspsych/jsPsych/commit/9486bc509f8fe4b4ac4b93510ddd8fd17e5f1b05) Thanks [@bjoluc](https://github.com/bjoluc)! - Fix css path rewriting in `createCoreDistArchive` Gulp task when `link` tags do not end in `/>`
+
+## 1.1.0
+
+### Minor Changes
+
+- [#2357](https://github.com/jspsych/jsPsych/pull/2357) [`c44ac202`](https://github.com/jspsych/jsPsych/commit/c44ac2024ae51cf14efa60ca285bb2e4dc0ebef7) Thanks [@bjoluc](https://github.com/bjoluc)! - Add a VERSION.md file to the release archive created by the `createCoreDistArchive` Gulp task
+
+## 1.0.0
+
+### Major Changes
 
 - [`bc058590`](https://github.com/jspsych/jsPsych/commit/bc058590950285e52116f809e4ccc57bae5a67f5) Thanks [@bjoluc](https://github.com/bjoluc)! - Initial release

package/gulp.js

@@ -1,6 +1,9 @@
+import { readFileSync } from "fs";
 import { sep as pathSeparator } from "path";
 
+import glob from "glob";
 import gulp from "gulp";
+import file from "gulp-file";
 import rename from "gulp-rename";
 import replace from "gulp-replace";
 import zip from "gulp-zip";
@@ -8,6 +11,58 @@ import merge from "merge-stream";
 
 const { dest, src } = gulp;
 
+const readJsonFile = (filename) => JSON.parse(readFileSync(filename, "utf8"));
+
+const getAllPackages = () =>
+  glob
+    // Get an array of all package.json filenames
+    .sync("packages/*/package.json")
+
+    // Map file names to package details
+    .map((filename) => {
+      const packageJson = readJsonFile(filename);
+      return {
+        name: packageJson.name,
+        version: packageJson.version,
+      };
+    });
+
+const getVersionFileContents = () =>
+  [
+    "Included in this release:\n",
+    "Package|Version|Documentation",
+    "--- | --- | ---",
+    ...(() => {
+      const docsBaseUrl =
+        "https://www.jspsych.org/" +
+        readJsonFile("packages/jspsych/package.json").version.split(".").slice(0, -1).join(".") +
+        "/";
+
+      return (
+        getAllPackages()
+          // Filter packages that should not be listed
+          .filter(({ name }) => !["@jspsych/config", "@jspsych/test-utils"].includes(name))
+
+          // Move the core package to the top of the list
+          .sort(({ name: n1 }, { name: n2 }) => (n1 === "jspsych" ? -1 : n2 === "jspsych" ? 1 : 0))
+
+          // Map package details to MarkDown table row strings
+          .map(({ name, version }) => {
+            return `${name.replace("@jspsych/", "")}|${version}|${
+              name === "jspsych"
+                ? docsBaseUrl
+                : name.startsWith("@jspsych/plugin-")
+                ? docsBaseUrl + "plugins/" + name.replace("@jspsych/plugin-", "")
+                : name.startsWith("@jspsych/extension-")
+                ? docsBaseUrl + "extensions/" + name.replace("@jspsych/extension-", "")
+                : ""
+            }`;
+          })
+      );
+    })(),
+    "",
+  ].join("\n");
+
 export const createCoreDistArchive = () =>
   merge(
     // index.browser.js files
@@ -32,20 +87,66 @@ export const createCoreDistArchive = () =>
       // Rewrite script source paths
       .pipe(
         replace(
-          /<script src="(.*)\/packages\/(.*)\/dist\/index\.browser\.js"><\/script>/g,
-          '<script src="$1/dist/$2.js"></script>'
+          /<script src="(.*)\/packages\/(.*)\/dist\/index\.browser\.js"/g,
+          '<script src="$1/dist/$2.js"'
         )
       )
       // Rewrite jspsych css source paths
       .pipe(
         replace(
-          /<link rel="stylesheet" href="(.*)\/packages\/jspsych\/css\/(.*)" \/>/g,
-          '<link rel="stylesheet" href="$1/dist/$2" />'
+          /<link rel="stylesheet" href="(.*)\/packages\/jspsych\/css\/(.*)"/g,
+          '<link rel="stylesheet" href="$1/dist/$2"'
         )
       ),
 
+    // VERSION.md
+    file("VERSION.md", getVersionFileContents(), { src: true }),
+
     // Other files
     src(["*.md", "license.txt"])
   )
     .pipe(zip("dist.zip"))
     .pipe(dest("."));
+
+/**
+ * Updates each unpkg link with a precise version number to the corresponding package's current
+ * version as defined in the package's `package.json`. Only considers `.md` and `.html` files.
+ */
+export const updateUnpkgLinks = () => {
+  const packageVersions = new Map(getAllPackages().map(({ name, version }) => [name, version]));
+
+  return src(["./**/*.{md,html}"])
+    .pipe(
+      replace(
+        /"https:\/\/unpkg\.com\/(@?.*)@(\d+.\d+.\d+)(\/[^"]*)?"/g,
+        (url, packageName, currentVersion, path) => {
+          const latestVersion = packageVersions.get(packageName) ?? currentVersion;
+          return `"https://unpkg.com/${packageName}@${latestVersion}${path ?? ""}"`;
+        }
+      )
+    )
+    .pipe(dest("./"));
+};
+
+/**
+ * Substitutes the string "current-plugin-version" or version number that follows the text "Current version: "
+ * in the plugin docs pages with the package's current version, as defined in the package's `package.json`.
+ * Only considers `.md` files in `docs/plugins` folder.
+ * Gets the package name from the docs page title (i.e. following "# "), ignoring the string " plugin" in the title.
+ */
+export const updatePluginVersions = () => {
+  const packageVersions = new Map(getAllPackages().map(({ name, version }) => [name, version]));
+
+  return src(["././docs/plugins/*.md"])
+    .pipe(
+      replace(
+        /\# (.+?)(?: plugin)?[\s]*?[\n]*Current version: (\d+.\d+.\d+|current-plugin-version)\./gi,
+        (match_str, packageName, currentVersionText) => {
+          const fullPackageName = "@jspsych/plugin-" + packageName;
+          const latestVersion = packageVersions.get(fullPackageName) ?? currentVersionText;
+          return `# ${packageName}\n\nCurrent version: ${latestVersion}.`;
+        }
+      )
+    )
+    .pipe(dest("./docs/plugins"));
+};

package/jest.cjs

@@ -1,6 +1,7 @@
 const ts = require("typescript");
-const { pathsToModuleNameMapper } = require("ts-jest/utils");
+const { pathsToModuleNameMapper } = require("ts-jest");
 
+/** @type { (dirname: string) => import('@jest/types').Config.InitialOptions } */
 module.exports.makePackageConfig = (dirname) => {
   const packageJson = require(dirname + "/package.json");
   const packageBaseName = packageJson.name.replace("@jspsych/", "");
@@ -14,15 +15,13 @@ module.exports.makePackageConfig = (dirname) => {
 
   return {
     preset: "ts-jest",
-    moduleNameMapper: pathsToModuleNameMapper(tsCompilerOptions.paths, {
-      prefix: "<rootDir>/",
-    }),
+    moduleNameMapper: pathsToModuleNameMapper(tsCompilerOptions.paths, { prefix: "<rootDir>/" }),
     testEnvironment: "jsdom",
     testEnvironmentOptions: {
       fetchExternalResources: true,
       pretendToBeVisual: true,
+      url: "http://localhost/",
     },
-    testURL: "http://localhost/",
     displayName: {
       name: packageBaseName,
       color: packageBaseName === "jspsych" ? "white" : "cyanBright",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jspsych/config",
-  "version": "1.0.0",
+  "version": "1.3.0",
   "description": "Shared (build) configuration for jsPsych packages",
   "type": "module",
   "exports": {
@@ -27,10 +27,6 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "scripts": {
-    "build": "",
-    "tsc": ""
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jspsych/jsPsych.git",
@@ -43,30 +39,31 @@
   },
   "homepage": "https://www.jspsych.org/latest/developers/configuration",
   "dependencies": {
-    "@babel/cli": "7.15.7",
-    "@babel/core": "7.15.5",
-    "@babel/preset-env": "7.15.6",
-    "@rollup/plugin-babel": "5.3.0",
-    "@rollup/plugin-commonjs": "19.0.0",
+    "@babel/cli": "7.17.10",
+    "@babel/core": "7.17.10",
+    "@babel/preset-env": "7.17.10",
+    "@rollup/plugin-babel": "5.3.1",
+    "@rollup/plugin-commonjs": "22.0.0",
     "@rollup/plugin-json": "4.1.0",
-    "@rollup/plugin-node-resolve": "13.0.5",
+    "@rollup/plugin-node-resolve": "13.3.0",
     "@types/gulp": "4.0.9",
-    "@types/jest": "27.0.2",
-    "babel-preset-minify": "0.5.1",
-    "canvas": "2.8.0",
+    "@types/jest": "27.5.1",
+    "babel-preset-minify": "0.5.2",
+    "canvas": "2.9.1",
     "gulp": "4.0.2",
     "gulp-cli": "2.3.0",
+    "gulp-file": "^0.4.0",
     "gulp-rename": "2.0.0",
     "gulp-replace": "1.1.3",
     "gulp-zip": "5.1.0",
-    "jest": "27.2.4",
-    "jest-environment-jsdom": "27.2.4",
+    "jest": "28.1.0",
+    "jest-environment-jsdom": "28.1.0",
     "merge-stream": "2.0.0",
-    "rollup": "2.58.0",
+    "rollup": "2.73.0",
     "rollup-plugin-terser": "7.0.2",
-    "rollup-plugin-typescript2": "0.30.0",
-    "ts-jest": "27.0.5",
-    "tslib": "2.3.1",
-    "typescript": "4.4.3"
+    "rollup-plugin-typescript2": "0.31.2",
+    "ts-jest": "28.0.2",
+    "tslib": "2.4.0",
+    "typescript": "^4.6.4"
   }
 }

package/rollup.js

@@ -1,3 +1,4 @@
+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";
@@ -81,6 +82,8 @@ const makeConfig = ({
         babel({
           babelHelpers: "bundled",
           extends: "@jspsych/config/babel",
+          // https://github.com/ezolenko/rollup-plugin-typescript2#rollupplugin-babel
+          extensions: [...babelDefaultExtensions, ".ts"],
         })
       ),
       output: [