@jspsych/config 3.2.1 → 3.2.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @jspsych/config
 
+## 3.2.2
+
+### Patch Changes
+
+- [#3488](https://github.com/jspsych/jsPsych/pull/3488) [`64a01292c350b5f6fd9f3f2e0dad5124262d53c9`](https://github.com/jspsych/jsPsych/commit/64a01292c350b5f6fd9f3f2e0dad5124262d53c9) Thanks [@jodeleeuw](https://github.com/jodeleeuw)! - Replaces the dependency on `canvas` in `@jspsych/config` with `jest-canvas-mock`.
+
+- [#3484](https://github.com/jspsych/jsPsych/pull/3484) [`e710cb01e8ab2f992d0be902016e3e6540197f67`](https://github.com/jspsych/jsPsych/commit/e710cb01e8ab2f992d0be902016e3e6540197f67) Thanks [@jadeddelta](https://github.com/jadeddelta)! - Patches some edge cases for `getCitations` and the build process that reads CITATION.CFF files to include citation info
+
 ## 3.2.1
 
 ### Patch Changes

package/generateCitations.js

@@ -7,7 +7,6 @@ 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
@@ -23,11 +22,8 @@ export default function generateCitations() {
     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);
+      preferredCitation = rawCff.includes("preferred-citation:");
+      return rawCff;
     };
 
     try {
@@ -80,7 +76,7 @@ export default function generateCitations() {
       return citationBibtex;
     } catch (error) {
       console.log(`Error converting CITATION.cff to BibTeX string: ${error.message}`);
-      return null;
+      return "";
     }
   })();
 

package/jest.cjs

@@ -18,6 +18,7 @@ module.exports.makePackageConfig = (dirname) => {
     displayName: {
       name: packageBaseName,
       color: packageBaseName === "jspsych" ? "white" : "cyanBright",
-    }
+    },
+    setupFiles: [require.resolve("jest-canvas-mock")],
   };
 };

package/jest.config.cjs

@@ -0,0 +1 @@
+module.exports = require("./jest.cjs").makePackageConfig(__dirname);

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@jspsych/config",
-  "version": "3.2.1",
+  "version": "3.2.2",
   "description": "Shared (build) configuration for jsPsych packages",
   "type": "module",
+  "scripts": {
+    "test": "jest",
+    "test:watch": "npm test -- --watch"
+  },
   "exports": {
     "./gulp": {
       "import": "./gulp.js",
@@ -45,9 +49,9 @@
     "@sucrase/jest-plugin": "3.0.0",
     "@types/gulp": "4.0.17",
     "@types/jest": "29.5.8",
+    "@types/node": "^22.10.10",
     "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",
@@ -57,6 +61,7 @@
     "gulp-replace": "1.1.4",
     "gulp-zip": "6.0.0",
     "jest": "29.7.0",
+    "jest-canvas-mock": "2.5.0",
     "jest-environment-jsdom": "29.7.0",
     "merge-stream": "2.0.0",
     "rollup": "4.21.2",
@@ -66,7 +71,6 @@
     "rollup-plugin-node-externals": "7.1.3",
     "sucrase": "3.34.0",
     "tslib": "2.6.2",
-    "typescript": "^5.2.2",
-    "yaml": "^2.5.1"
+    "typescript": "^5.7.0"
   }
 }

package/tests/generateCitations.test.js

@@ -0,0 +1,94 @@
+import fs from "node:fs";
+
+import generateCitations from "../generateCitations";
+
+// Mock filesystem
+jest.mock("node:fs");
+jest.mock("app-root-path", () => ({
+  path: "/mock/root/path",
+}));
+
+describe("generateCitations", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  const validCitationCff = `
+cff-version: 1.2.0
+message: Please cite this software using these metadata
+title: Test Software
+authors:
+  - family-names: Doe
+    given-names: John
+version: 1.0.0
+date-released: 2023-01-01
+  `;
+
+  const citationCffWithPreferred = `
+cff-version: 1.2.0
+message: Please cite this software using these metadata
+title: Test Software
+authors:
+  - family-names: Doe
+    given-names: John
+preferred-citation:
+  title: Preferred Citation
+  authors:
+    - family-names: Smith
+      given-names: Jane
+  `;
+
+  test("should generate citations when CITATION.cff exists in current directory", () => {
+    fs.readFileSync.mockReturnValue(validCitationCff);
+
+    const result = generateCitations();
+
+    expect(result).toHaveProperty("apa");
+    expect(result).toHaveProperty("bibtex");
+    expect(result.apa).not.toBe("");
+    expect(result.bibtex).not.toBe("");
+  });
+
+  test("should handle preferred-citation when present", () => {
+    fs.readFileSync.mockReturnValue(citationCffWithPreferred);
+
+    const result = generateCitations();
+
+    expect(result).toHaveProperty("apa");
+    expect(result).toHaveProperty("bibtex");
+    expect(result.apa.includes("Smith")).toBeTruthy();
+  });
+
+  test("should return empty strings when CITATION.cff is not found", () => {
+    fs.readFileSync.mockImplementation(() => {
+      throw new Error("File not found");
+    });
+
+    const result = generateCitations();
+
+    expect(result).toEqual({
+      apa: "",
+      bibtex: "",
+    });
+  });
+
+  test("should handle malformed CITATION.cff", () => {
+    fs.readFileSync.mockReturnValue("invalid: yaml: content:");
+
+    const result = generateCitations();
+
+    expect(result).toEqual({
+      apa: "",
+      bibtex: "",
+    });
+  });
+
+  test("should remove newlines from citations", () => {
+    fs.readFileSync.mockReturnValue(validCitationCff);
+
+    const result = generateCitations();
+
+    expect(result.apa).not.toMatch(/\n/);
+    expect(result.bibtex).not.toMatch(/\n/);
+  });
+});