Merge pull request #7 from jspsych/spatial_cueing_import

add spatial cueing package
jspsych · Aug 6, 2024 · 3297231 · 3297231
2 parents 9c4ef13 + 6078789
commit 3297231
Show file tree

Hide file tree

Showing 8 changed files with 530 additions and 0 deletions.
diff --git a/.changeset/strange-penguins-stare.md b/.changeset/strange-penguins-stare.md
@@ -0,0 +1,5 @@
+---
+"@jspsych-timelines/spatial-cueing-task": minor
+---
+
+add spatial cueing task package
diff --git a/packages/spatial-cueing-task/README.md b/packages/spatial-cueing-task/README.md
@@ -0,0 +1,51 @@
+# spatial-cueing-task
+
+## Overview
+
+A shareable timeline of the Posner spatial cueing task.
+
+## Loading
+
+### In browser
+
+```html
+<script src="https://unpkg.com/@jspsych-timelines/spatial-cueing-task">
+```
+
+### Via NPM
+
+```
+npm install @jspsych-timelines/spatial-cueing-task
+```
+
+```js
+import { createTimeline, timelineUnits, utils } from "@jspsych-timelines/spatial-cueing-task"
+```
+
+## Compatibility
+
+`@jspsych-timelines/spatial-cueing-task` requires jsPsych v7.0.0 or later.
+
+## Documentation
+
+### createTimeline
+
+#### jsPsychTimelineSpatialCueingTask.createTimeline(jsPsych, { *options* }) ⇒ <code>timeline</code>
+Description of the timeline that this plugin generates
+
+The following parameters can be specified in the **options** parameter.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| parameter | type | default | description |
+
+
+### timelineUnits
+
+
+### utils
+
+## Author / Citation
+
+Cherrie
+
diff --git a/packages/spatial-cueing-task/examples/index.html b/packages/spatial-cueing-task/examples/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <script src="https://unpkg.com/jspsych"></script>
+    <script src="https://unpkg.com/@jspsych/plugin-html-keyboard-response"></script>
+    <script src="../dist/index.global.js"></script>
+    <link rel="stylesheet" type="text/css" href="https://unpkg.com/jspsych/css/jspsych.css" />
+    <link rel="stylesheet" type="text/css" href="../src/styles.css" />
+  </head>
+
+  <body></body>
+  <script>
+    const jsPsych = initJsPsych();
+    const spatialCueingTask = jsPsychTimelineSpatialCueingTask.createTimeline(jsPsych);
+    jsPsych.run([spatialCueingTask]);
+  </script>
+</html>
diff --git a/packages/spatial-cueing-task/jest.config.js b/packages/spatial-cueing-task/jest.config.js
@@ -0,0 +1 @@
+module.exports = require("@jspsych/config/jest").makePackageConfig(__dirname);
diff --git a/packages/spatial-cueing-task/package.json b/packages/spatial-cueing-task/package.json
@@ -0,0 +1,34 @@
+{
+    "name": "@jspsych-timelines/spatial-cueing-task",
+    "version": "0.0.1",
+    "description": "A shareable timeline of the Posner spatial cueing task.",
+    "type": "module",
+    "main": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "unpkg": "dist/index.global.js",
+    "scripts": {
+      "build": "tsup src/index.ts --format esm,iife --sourcemap --dts --treeshake --clean --global-name jsPsychTimelineSpatialCueingTask"
+    },
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/jspsych/jspsych-timelines.git"
+    },
+    "keywords": [
+      "jsPsych"
+    ],
+    "author": "Cherrie",
+    "license": "MIT",
+    "bugs": {
+      "url": "https://github.com/jspsych/jspsych-timelines/issues"
+    },
+    "homepage": "https://github.com/jspsych/jspsych-timelines/packages/spatial-cueing-task#readme",
+    "peerDependencies": {
+      "jspsych": "^7.3.3"
+    },
+    "dependencies": {
+    },
+    "devDependencies": {
+      "tsup": "^6.7.0",
+      "typescript": "^5.0.2"
+    }
+  }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		module.exports = require("@jspsych/config/jest").makePackageConfig(__dirname);