@jspsych/config 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,8 +1,13 @@
 # @jspsych/config
 
-## 1.0.0
-### Major Changes
+## 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,56 @@ import merge from "merge-stream";
 
 const { dest, src } = gulp;
 
+const readJsonFile = (filename) => JSON.parse(readFileSync(filename, "utf8"));
+
+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 (
+        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,
+            };
+          })
+
+          // 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
@@ -44,6 +97,9 @@ export const createCoreDistArchive = () =>
         )
       ),
 
+    // VERSION.md
+    file("VERSION.md", getVersionFileContents(), { src: true }),
+
     // Other files
     src(["*.md", "license.txt"])
   )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jspsych/config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Shared (build) configuration for jsPsych packages",
   "type": "module",
   "exports": {
@@ -56,6 +56,7 @@
     "canvas": "2.8.0",
     "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",