docs run + update verison based on package.json

jspsych · Nov 3, 2024 · 8f55785 · 8f55785
1 parent 4aee11b
commit 8f55785
Show file tree

Hide file tree

Showing 54 changed files with 6,882 additions and 1,054 deletions.
diff --git a/.changeset/thick-llamas-greet.md b/.changeset/thick-llamas-greet.md
@@ -12,7 +12,6 @@
 "@jspsych-contrib/plugin-html-multi-response": major
 "@jspsych-contrib/plugin-html-swipe-response": major
 "@jspsych-contrib/plugin-nextcloud-filedrop": major
-"@jspsych-contrib/plugin-self-paced-reading": major
 "@jspsych-contrib/plugin-html-vas-response": major
 "@jspsych-contrib/plugin-vsl-grid-scene": major
 "@jspsych-contrib/plugin-survey-number": major

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/plugin-audio-multi-response/package.json b/packages/plugin-audio-multi-response/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   },

diff --git a/packages/plugin-audio-multi-response/src/index.ts b/packages/plugin-audio-multi-response/src/index.ts
@@ -1,9 +1,11 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 import { AudioPlayer, AudioPlayerInterface } from "jspsych/src/modules/plugin-api/AudioPlayer";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "audio-multi-response",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The HTML string to be displayed. */
     stimulus: {

diff --git a/packages/plugin-audio-swipe-response/package.json b/packages/plugin-audio-swipe-response/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   },

diff --git a/packages/plugin-audio-swipe-response/src/index.ts b/packages/plugin-audio-swipe-response/src/index.ts
@@ -2,9 +2,11 @@ import interact from "interactjs";
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 import { AudioPlayerInterface } from "jspsych/src/modules/plugin-api/AudioPlayer";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "audio-swipe-response",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The HTML string to be displayed. */
     stimulus: {
@@ -106,6 +108,7 @@ type Info = typeof info;
 
 /**
  * **audio-swipe-response**
+ *
  * jsPsych plugin for playing an audio file and getting a swipe response
  * @author Adam Richie-Halford
  * @see {@link https://www.jspsych.org/plugins/jspsych-audio-swipe-response/ audio-swipe-response plugin documentation on jspsych.org}

diff --git a/packages/plugin-copying-task/package.json b/packages/plugin-copying-task/package.json
@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-copying-task",
   "devDependencies": {
-    "@jspsych/config": "^2.0.0",
-    "jspsych": "^7.3.0"
+    "@jspsych/config": "^3.0.1",
+    "jspsych": "^8.0.0"
   }
 }
diff --git a/packages/plugin-copying-task/src/index.js b/packages/plugin-copying-task/src/index.js
@@ -1,14 +1,10 @@
 /**
- * jspsych-copying-task
- * version 2.0.0
- *
- * Andre Sahakian (modified from Chris Jungerius (modified from Josh de Leeuw))
+ * **jspsych-copying-task**
  *
  * a jsPsych plugin for displaying a basic copying task.
- *
+ * @author Andre Sahakian (modified from Chris Jungerius (modified from Josh de Leeuw))
  * documentation: docs.jspsych.org
- **/
-
+ */
 var jsPsychCopyingTask = (function (jspsych) {
   "use strict";
 

diff --git a/packages/plugin-corsi-blocks/package.json b/packages/plugin-corsi-blocks/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   }

diff --git a/packages/plugin-corsi-blocks/src/index.ts b/packages/plugin-corsi-blocks/src/index.ts
@@ -1,10 +1,10 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
-// import { version } from "../package.json";
+import { version } from "../package.json";
 
 const info = <const>{
   name: "corsi-blocks",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /**
      * An array of block indexes that specify the order of the sequence to be displayed. For example,

diff --git a/packages/plugin-gamepad/package.json b/packages/plugin-gamepad/package.json
@@ -37,11 +37,11 @@
   },
   "homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-gamepad",
   "peerDependencies": {
-    "jspsych": ">=7.0.0"
+    "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^2.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
-    "jspsych": "^7.0.0"
+    "jspsych": "^8.0.0"
   }
 }
diff --git a/packages/plugin-gamepad/src/index.ts b/packages/plugin-gamepad/src/index.ts
@@ -1,10 +1,11 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
 import { GamepadModel, GamepadModels } from "./gamepad-model";
 
 const info = <const>{
   name: "gamepad",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The size of the canvas element. */
     canvas_size: {
@@ -99,7 +100,7 @@ type Info = typeof info;
 /**
  * **jspsych-gamepad**
  *
- * A jsPsych plugin for using gamepad in behavioral experiments.
+ * A jsPsych plugin for using a gamepad in behavioral experiments.
  *
  * @author Shaobin Jiang
  */

diff --git a/packages/plugin-html-choice/package.json b/packages/plugin-html-choice/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   }

diff --git a/packages/plugin-html-choice/src/index.ts b/packages/plugin-html-choice/src/index.ts
@@ -1,8 +1,10 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "html-choice",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The HTML string to be displayed */
     html_array: {
@@ -67,7 +69,8 @@ const info = <const>{
 type Info = typeof info;
 
 /**
- * html-choice
+ * **html-choice**
+ *
  * jsPsych plugin for displaying a stimulus and getting a choice
  * @author Younes Strittmatter
  */

diff --git a/packages/plugin-html-keyboard-response-raf/package.json b/packages/plugin-html-keyboard-response-raf/package.json
@@ -37,11 +37,11 @@
   },
   "homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-html-keyboard-response-raf",
   "peerDependencies": {
-    "jspsych": ">=7.0.0"
+    "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^2.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
-    "jspsych": "^7.0.0"
+    "jspsych": "^8.0.0"
   }
 }
diff --git a/packages/plugin-html-keyboard-response-raf/src/index.ts b/packages/plugin-html-keyboard-response-raf/src/index.ts
@@ -1,8 +1,10 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "html-keyboard-response-raf",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /**
      * The HTML string to be displayed.
@@ -53,7 +55,7 @@ const info = <const>{
       default: true,
     },
     /**
-     * FPS for requestAnimationFrame
+     * Frames per second for requestAnimationFrame.
      */
     fps: {
       type: ParameterType.INT,

diff --git a/packages/plugin-html-keyboard-slider/package.json b/packages/plugin-html-keyboard-slider/package.json
@@ -37,11 +37,11 @@
   },
   "homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-html-keyboard-slider",
   "peerDependencies": {
-    "jspsych": ">=7.0.0"
+    "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^2.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
-    "jspsych": "^7.0.0"
+    "jspsych": "^8.0.0"
   }
 }
diff --git a/packages/plugin-html-keyboard-slider/src/index.ts b/packages/plugin-html-keyboard-slider/src/index.ts
@@ -2,12 +2,12 @@
 // Need to trim params down in future
 
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
-//Cannot find module '../package.json'. Consider using '--resolveJsonModule' to import module with '.json' extension.ts(2732)//
-//import { version } from '../package.json';
+
+import { version } from "../package.json";
 
 const info = <const>{
   name: "html-keyboard-slider",
-  version: "1.0.0",
+  version: version,
   parameters: {
     // HTML Attributes
     /**
@@ -32,7 +32,9 @@ const info = <const>{
       default: 1,
     },
     /**
-     * For a more coninuous slider, set HTML Range input's step attribute to 'any', see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#examples. Step values above still apply to 'increase_keys' and 'decrease_keys'.
+     * For a more continuous slider, set HTML Range input's step attribute to 'any',
+     * see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#examples.
+     * Step values above still apply to `increase_keys` and `decrease_keys`.
      */
     step_any: {
       type: ParameterType.BOOL,
@@ -150,7 +152,7 @@ const info = <const>{
       default: null,
     },
     /**
-     * Whether to display dividing lines between labels
+     * Whether or not to display dividing lines between labels
      */
     label_dividers: {
       type: ParameterType.BOOL,

diff --git a/packages/plugin-html-multi-response/package.json b/packages/plugin-html-multi-response/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   }

diff --git a/packages/plugin-html-multi-response/src/index.ts b/packages/plugin-html-multi-response/src/index.ts
@@ -1,8 +1,10 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "html-multi-response",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The HTML string to be displayed */
     stimulus: {
@@ -111,7 +113,8 @@ const info = <const>{
 type Info = typeof info;
 
 /**
- * html-multi-response
+ * **html-multi-response**
+ *
  * jsPsych plugin for displaying an HTML stimulus and getting a swipe or keyboard response
  * @author Adam Richie-Halford
  * @see {@link https://www.jspsych.org/plugins/jspsych-html-multi-response/ html-multi-response plugin documentation on jspsych.org}

diff --git a/packages/plugin-html-swipe-response/package.json b/packages/plugin-html-swipe-response/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   },

diff --git a/packages/plugin-html-swipe-response/src/index.ts b/packages/plugin-html-swipe-response/src/index.ts
@@ -1,9 +1,11 @@
 import interact from "interactjs";
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "html-swipe-response",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The HTML string to be displayed. */
     stimulus: {
@@ -146,6 +148,7 @@ type Info = typeof info;
 
 /**
  * **html-swipe-response**
+ *
  * jsPsych plugin for displaying a stimulus and getting a swipe response
  * @author Adam Richie-Halford
  * @see {@link https://www.jspsych.org/plugins/jspsych-html-swipe-response/ html-swipe-response plugin documentation on jspsych.org}

diff --git a/packages/plugin-html-vas-response/index.js b/packages/plugin-html-vas-response/index.js
@@ -156,6 +156,12 @@ var jsPsychHtmlVasResponse = (function (jspsych) {
     },
   };
 
+  /**
+   * **html-vas-response**
+   *
+   * jsPsych plugin for a visual analogue scale (VAS) response.
+   * @author Isaac Kinley
+   */
   class jsPsychHtmlVasResponsePlugin {
     constructor(jsPsych) {
       this.jsPsych = jsPsych;

diff --git a/packages/plugin-html-vas-response/package.json b/packages/plugin-html-vas-response/package.json
@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-html-vas-response",
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "jspsych": "^8.0.0"
   }
 }
diff --git a/packages/plugin-image-array-keyboard-response/package.json b/packages/plugin-image-array-keyboard-response/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   }

diff --git a/packages/plugin-image-array-keyboard-response/src/index.ts b/packages/plugin-image-array-keyboard-response/src/index.ts
@@ -1,8 +1,10 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "image-array-keyboard-response",
-  version: "2.0.0",
+  version: version,
   parameters: {
     /** The images to be displayed */
     stimulus: {
@@ -85,7 +87,7 @@ type Info = typeof info;
  * jsPsych plugin for displaying an image array and getting a keyboard response
  *
  * @author Younes Strittmatter
- * @see {@link https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-image-array-keyboard-response/README.md image-array-keyboard-response plugin documentation on github.com}
+ * @see {@link https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-image-array-keyboard-response image-array-keyboard-response plugin documentation on github.com}
  */
 class ImageArrayKeyboardResponsePlugin implements JsPsychPlugin<Info> {
   static info = info;

diff --git a/packages/plugin-image-multi-response/package.json b/packages/plugin-image-multi-response/package.json
@@ -40,7 +40,7 @@
     "jspsych": ">=8.0.0"
   },
   "devDependencies": {
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@jspsych/test-utils": "^1.0.0",
     "jspsych": "^8.0.0"
   }