update plugins index.ts

jspsych · Nov 1, 2024 · 5753468 · 5753468
1 parent f0bc8ae
commit 5753468
Show file tree

Hide file tree

Showing 57 changed files with 79 additions and 7 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "@changesets/changelog-github": "^0.4.7",
     "@changesets/cli": "^2.25.2",
     "@jspsych/config": "^3.0.0",
-    "husky": "^8.0.2",
+    "husky": "^8.0.3",
     "import-sort-style-module": "^6.0.0",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",

diff --git a/packages/config/generateCitations.js b/packages/config/generateCitations.js
@@ -3,8 +3,10 @@ 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";
 
 /**
@@ -18,18 +20,24 @@ export default function generateCitations() {
 
   // Try to find CITATION.cff file and look for preferred-citation
   const citationCff = (() => {
+    let rawCff;
     try {
-      const rawCff = fs.readFileSync("./CITATION.cff", "utf-8").toString();
+      rawCff = fs.readFileSync("./CITATION.cff", "utf-8").toString();
       const cffData = yaml.parse(rawCff);
       if (cffData["preferred-citation"]) {
         preferredCitation = true;
       }
       return yaml.stringify(rawCff);
     } catch (error) {
-      console.log(
-        `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;
+      try {
+        rawCff = fs.readFileSync(path.join(appRootPath.path, "CITATION.cff"), "utf-8").toString();
+        return yaml.stringify(rawCff);
+      } 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;
+      }
     }
   })();
 

diff --git a/packages/config/package.json b/packages/config/package.json
@@ -46,6 +46,7 @@
     "@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",
     "gulp": "5.0.0",

diff --git a/packages/extension-record-video/src/index.ts b/packages/extension-record-video/src/index.ts
@@ -16,6 +16,7 @@ class RecordVideoExtension implements JsPsychExtension {
         type: ParameterType.STRING,
       },
     },
+    citations: "__CITATIONS__",
   };
 
   constructor(private jsPsych: JsPsych) {

diff --git a/packages/extension-webgazer/src/index.ts b/packages/extension-webgazer/src/index.ts
@@ -91,6 +91,7 @@ class WebGazerExtension implements JsPsychExtension {
         },
       },
     },
+    citations: "__CITATIONS__",
   };
 
   constructor(private jsPsych: JsPsych) {}

diff --git a/packages/plugin-animation/src/index.ts b/packages/plugin-animation/src/index.ts
@@ -96,6 +96,7 @@ const info = <const>{
       },
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-audio-button-response/src/index.ts b/packages/plugin-audio-button-response/src/index.ts
@@ -110,6 +110,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-audio-keyboard-response/src/index.ts b/packages/plugin-audio-keyboard-response/src/index.ts
@@ -82,6 +82,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-audio-slider-response/src/index.ts b/packages/plugin-audio-slider-response/src/index.ts
@@ -117,6 +117,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-browser-check/src/index.ts b/packages/plugin-browser-check/src/index.ts
@@ -173,6 +173,7 @@ const info = <const>{
       type: ParameterType.BOOL,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-call-function/src/index.ts b/packages/plugin-call-function/src/index.ts
@@ -27,6 +27,7 @@ const info = <const>{
       default: undefined,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-canvas-button-response/src/index.ts b/packages/plugin-canvas-button-response/src/index.ts
@@ -113,6 +113,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-canvas-keyboard-response/src/index.ts b/packages/plugin-canvas-keyboard-response/src/index.ts
@@ -78,6 +78,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-canvas-slider-response/src/index.ts b/packages/plugin-canvas-slider-response/src/index.ts
@@ -90,6 +90,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-categorize-animation/src/index.ts b/packages/plugin-categorize-animation/src/index.ts
@@ -90,6 +90,7 @@ const info = <const>{
       type: ParameterType.BOOL,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-categorize-html/src/index.ts b/packages/plugin-categorize-html/src/index.ts
@@ -95,6 +95,7 @@ const info = <const>{
       type: ParameterType.BOOL,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-categorize-image/src/index.ts b/packages/plugin-categorize-image/src/index.ts
@@ -96,6 +96,7 @@ const info = <const>{
       type: ParameterType.BOOL,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-cloze/src/index.ts b/packages/plugin-cloze/src/index.ts
@@ -39,6 +39,7 @@ const info = <const>{
       array: true,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-external-html/src/index.ts b/packages/plugin-external-html/src/index.ts
@@ -48,6 +48,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-free-sort/src/index.ts b/packages/plugin-free-sort/src/index.ts
@@ -167,6 +167,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-fullscreen/src/index.ts b/packages/plugin-fullscreen/src/index.ts
@@ -46,6 +46,7 @@ const info = <const>{
       description: "Time in milliseconds until the user entered fullscreen mode.",
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-html-audio-response/src/index.ts b/packages/plugin-html-audio-response/src/index.ts
@@ -75,6 +75,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-html-button-response/src/index.ts b/packages/plugin-html-button-response/src/index.ts
@@ -85,6 +85,7 @@ const info = <const>{
       type: ParameterType.HTML_STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-html-slider-response/src/index.ts b/packages/plugin-html-slider-response/src/index.ts
@@ -92,6 +92,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-html-video-response/src/index.ts b/packages/plugin-html-video-response/src/index.ts
@@ -80,6 +80,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-iat-html/src/index.ts b/packages/plugin-iat-html/src/index.ts
@@ -111,6 +111,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-iat-image/src/index.ts b/packages/plugin-iat-image/src/index.ts
@@ -111,6 +111,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-image-button-response/src/index.ts b/packages/plugin-image-button-response/src/index.ts
@@ -124,6 +124,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-image-keyboard-response/src/index.ts b/packages/plugin-image-keyboard-response/src/index.ts
@@ -88,6 +88,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-image-slider-response/src/index.ts b/packages/plugin-image-slider-response/src/index.ts
@@ -128,6 +128,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-initialize-camera/src/index.ts b/packages/plugin-initialize-camera/src/index.ts
@@ -48,6 +48,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-initialize-microphone/src/index.ts b/packages/plugin-initialize-microphone/src/index.ts
@@ -23,6 +23,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-instructions/src/index.ts b/packages/plugin-instructions/src/index.ts
@@ -92,6 +92,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-maxdiff/src/index.ts b/packages/plugin-maxdiff/src/index.ts
@@ -75,6 +75,7 @@ const info = <const>{
       },
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-mirror-camera/src/index.ts b/packages/plugin-mirror-camera/src/index.ts
@@ -38,6 +38,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-reconstruction/src/index.ts b/packages/plugin-reconstruction/src/index.ts
@@ -52,6 +52,7 @@ const info = <const>{
       type: ParameterType.INT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-resize/src/index.ts b/packages/plugin-resize/src/index.ts
@@ -50,6 +50,7 @@ const info = <const>{
       type: ParameterType.FLOAT,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-same-different-html/src/index.ts b/packages/plugin-same-different-html/src/index.ts
@@ -76,6 +76,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-same-different-image/src/index.ts b/packages/plugin-same-different-image/src/index.ts
@@ -78,6 +78,7 @@ const info = <const>{
       type: ParameterType.STRING,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-serial-reaction-time-mouse/src/index.ts b/packages/plugin-serial-reaction-time-mouse/src/index.ts
@@ -88,6 +88,7 @@ const info = <const>{
       type: ParameterType.BOOL,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;

diff --git a/packages/plugin-serial-reaction-time/src/index.ts b/packages/plugin-serial-reaction-time/src/index.ts
@@ -98,6 +98,7 @@ const info = <const>{
       type: ParameterType.BOOL,
     },
   },
+  citations: "__CITATIONS__",
 };
 
 type Info = typeof info;
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ class RecordVideoExtension implements JsPsychExtension { @@
             type: ParameterType.STRING,
           },
         },
+        citations: "__CITATIONS__",
       };
       constructor(private jsPsych: JsPsych) {
@@ Expand Down @@