@jspsych/config 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @jspsych/config
 
+## 3.2.0
+
+### Minor Changes
+
+- [#3385](https://github.com/jspsych/jsPsych/pull/3385) [`3948fdc0ac176584fe4b8fe0b9cca5ed6e8b3afc`](https://github.com/jspsych/jsPsych/commit/3948fdc0ac176584fe4b8fe0b9cca5ed6e8b3afc) Thanks [@cherriechang](https://github.com/cherriechang)! - Added citations property to info field of all plugins/extensions in two citation formats (apa, bibtex); added getCitations() as function in jsPsych package allowing user to generate citations by passing an array of plugins/extensions by name as first input and citation format as string as second input; changed template of plugins/extensions to contain citations field by default; citations for each plugin/extension are automatically generated from .cff file (if any) at its folder's root during build process; getCitations() prints out citations in the form of a string separating each citation with newline character, and always prints the jsPsych library citation first.
+
+### Patch Changes
+
+- [#3482](https://github.com/jspsych/jsPsych/pull/3482) [`a733fc685c8d1a3f1a9dea25bd4c70940885c6e9`](https://github.com/jspsych/jsPsych/commit/a733fc685c8d1a3f1a9dea25bd4c70940885c6e9) Thanks [@jodeleeuw](https://github.com/jodeleeuw)! - Fixes gulp build process that was attempting to use glob v10 by adding glob v7 as explicit dependency. glob v9+ changed the API and would require some rewrites and testing before implementing
+
 ## 3.1.1
 
 ### Patch Changes

package/generateCitations.js

@@ -0,0 +1,94 @@
+import "@citation-js/plugin-bibtex";
+import "@citation-js/plugin-software-formats";
+import "@citation-js/plugin-csl";
+
+import fs from "node:fs";
+import path from "node:path";
+
+import { Cite } from "@citation-js/core";
+import appRootPath from "app-root-path";
+import yaml from "yaml";
+
+/**
+ * Generate citation data from CITATION.cff file
+ * Currently supported formats: APA, BibTeX
+ *
+ * @returns {Object} - Object containing APA and BibTeX formatted citation data
+ */
+export default function generateCitations() {
+  let preferredCitation = false;
+
+  // Try to find CITATION.cff file and look for preferred-citation
+  const citationCff = (() => {
+    let rawCff;
+    const getCff = (path) => {
+      rawCff = fs.readFileSync(path, "utf-8").toString();
+      const cffData = yaml.parse(rawCff);
+      if (cffData["preferred-citation"]) {
+        preferredCitation = true;
+      }
+      return yaml.stringify(rawCff);
+    };
+
+    try {
+      // look for CITATION.cff in the current directory
+      return getCff("./CITATION.cff");
+    } catch (error) {
+      try {
+        // look for CITATION.cff in the root of the repository
+        return getCff(path.join(appRootPath.path, "CITATION.cff"));
+      } catch (error) {
+        console.warn(
+          `No CITATION.cff file found: ${error.message}. If you would like to include a citation, please create a CITATION.cff file in the root of your repository.`
+        );
+        return null;
+      }
+    }
+  })();
+
+  if (!citationCff) {
+    return { apa: "", bibtex: "" };
+  }
+
+  // Convert CITATION.cff to APA string
+  const citationApa = (() => {
+    try {
+      const apaCite = new Cite(citationCff);
+      apaCite["data"] = preferredCitation ? apaCite["data"].slice(1) : apaCite["data"];
+      const citationApa = apaCite.format("bibliography", {
+        format: "text",
+        template: "apa",
+        lang: "en-us",
+      });
+      return citationApa;
+    } catch (error) {
+      console.log(`Error converting CITATION.cff to APA string: ${error.message}`);
+      return "";
+    }
+  })();
+
+  // Convert CITATION.cff to BibTeX string
+  const citationBibtex = (() => {
+    try {
+      const bibtexCite = new Cite(citationCff);
+      bibtexCite["data"] = preferredCitation ? bibtexCite["data"].slice(1) : bibtexCite["data"];
+      const citationBibtex = bibtexCite.format("bibtex", {
+        format: "text",
+        template: "bibtex",
+        lang: "en-us",
+      });
+      return citationBibtex;
+    } catch (error) {
+      console.log(`Error converting CITATION.cff to BibTeX string: ${error.message}`);
+      return null;
+    }
+  })();
+
+  // Return formatted citation data
+  const citationData = {
+    apa: citationApa.replace(/\n/g, " "),
+    bibtex: citationBibtex.replace(/\n/g, " "),
+  };
+
+  return citationData;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jspsych/config",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "Shared (build) configuration for jsPsych packages",
   "type": "module",
   "exports": {
@@ -35,14 +35,21 @@
   },
   "homepage": "https://www.jspsych.org/latest/developers/configuration",
   "dependencies": {
+    "@citation-js/core": "^0.7.14",
+    "@citation-js/plugin-bibtex": "^0.7.14",
+    "@citation-js/plugin-csl": "^0.7.14",
+    "@citation-js/plugin-software-formats": "^0.6.1",
     "@rollup/plugin-commonjs": "26.0.1",
     "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-replace": "^6.0.1",
     "@sucrase/jest-plugin": "3.0.0",
     "@types/gulp": "4.0.17",
     "@types/jest": "29.5.8",
     "alias-hq": "6.2.4",
+    "app-root-path": "^3.1.0",
     "canvas": "^2.11.2",
     "esbuild": "0.23.1",
+    "glob": "7.2.3",
     "gulp": "5.0.0",
     "gulp-cli": "3.0.0",
     "gulp-file": "0.4.0",
@@ -55,9 +62,11 @@
     "rollup": "4.21.2",
     "rollup-plugin-dts": "6.1.1",
     "rollup-plugin-esbuild": "6.1.1",
+    "rollup-plugin-modify": "^3.0.0",
     "rollup-plugin-node-externals": "7.1.3",
     "sucrase": "3.34.0",
     "tslib": "2.6.2",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "yaml": "^2.5.1"
   }
 }

package/rollup.js

@@ -6,9 +6,12 @@ import resolve from "@rollup/plugin-node-resolve";
 import { defineConfig } from "rollup";
 import dts from "rollup-plugin-dts";
 import esbuild from "rollup-plugin-esbuild";
+import modify from "rollup-plugin-modify";
 import externals from "rollup-plugin-node-externals";
 import ts from "typescript";
 
+import generateCitations from "./generateCitations.js";
+
 const getTsCompilerOptions = () => {
   const cwd = process.cwd();
   return ts.parseJsonConfigFileContent(
@@ -38,6 +41,8 @@ const makeConfig = ({
     ...outputOptions,
   };
 
+  const citationData = generateCitations();
+
   /** @type{import("rollup-plugin-esbuild").Options} */
   const esBuildPluginOptions = {
     loaders: { ".json": "json" },
@@ -71,6 +76,11 @@ const makeConfig = ({
       input,
       plugins: [
         externals(),
+        modify({
+          // prettier-ignore
+          find: /'__CITATIONS__'/g,
+          replace: JSON.stringify(citationData, null, 2),
+        }),
         esbuild({ ...esBuildPluginOptions, target: "node18" }),
         commonjs(commonjsPluginOptions),
       ],
@@ -96,6 +106,11 @@ const makeConfig = ({
       input,
       plugins: [
         externals({ deps: false }),
+        modify({
+          // prettier-ignore
+          find: /'__CITATIONS__'/g,
+          replace: JSON.stringify(citationData, null, 2),
+        }),
         resolve({ preferBuiltins: false }),
         esbuild({ ...esBuildPluginOptions, target: "esnext" }),
         commonjs(commonjsPluginOptions),
@@ -115,6 +130,11 @@ const makeConfig = ({
       input,
       plugins: [
         externals({ deps: false }),
+        modify({
+          // prettier-ignore
+          find: /'__CITATIONS__'/g,
+          replace: JSON.stringify(citationData, null, 2),
+        }),
         resolve({ preferBuiltins: false }),
         esbuild({ ...esBuildPluginOptions, target: "es2015", minify: true }),
         commonjs(commonjsPluginOptions),
@@ -164,8 +184,9 @@ export const makeCoreRollupConfig = () =>
 /**
  * Returns the rollup configuration for Node.js-only packages
  */
-export const makeNodeRollupConfig = () =>
-  makeConfig({
+export const makeNodeRollupConfig = () => {
+  return makeConfig({
     globalOptions: { external: ["jspsych"] },
     isNodeOnlyBuild: true,
   });
+};