update false memory task package.json

jspsych · Aug 8, 2024 · 6717f9e · 6717f9e
1 parent faa7bfc
commit 6717f9e
Show file tree

Hide file tree

Showing 10 changed files with 2,241 additions and 24 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/arrow-flanker/package.json b/packages/arrow-flanker/package.json
@@ -29,7 +29,7 @@
       "@jspsych/plugin-html-keyboard-response": "^2.0.0"
     },
     "devDependencies": {
-      "tsup": "^6.7.0",
-      "typescript": "^5.0.2"
+      "tsup": "^8.0.1",
+      "typescript": "^5.5.4"
     }
   }
diff --git a/packages/false-memory-task/package.json b/packages/false-memory-task/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@jspsych/timeline-template",
+  "name": "@jspsych/false-memory-task",
   "version": "0.0.1",
-  "description": "A template for a shareable, configurable false memory jsPsych experiment",
+  "description": "False memory task for jsPsych",
   "type": "module",
   "main": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -11,17 +11,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/open-cognition-lab/false-memory-module.git"
+    "url": "git+https://github.com/jspsych/jspsych-timelines.git"
   },
   "keywords": [
     "jsPsych"
   ],
   "author": "Cherrie Chang",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/open-cognition-lab/false-memory-module/issues"
+    "url": "https://github.com/jspsych/jspsych-timelines/issues"
   },
-  "homepage": "https://github.com/open-cognition-lab/false-memory-module#readme",
+  "homepage": "https://github.com/jspsych/jspsych-timelines/packages/false-memory-task#readme",
   "peerDependencies": {
     "jspsych": "^8.0.1"
   },
@@ -30,7 +30,7 @@
     "@jspsych/plugin-survey-text": "^2.0.0"
   },
   "devDependencies": {
-    "tsup": "^6.7.0",
-    "typescript": "^5.0.2"
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4"
   }
 }
diff --git a/packages/test/README.md b/packages/test/README.md
@@ -0,0 +1,51 @@
+# test
+
+## Overview
+
+test
+
+## Loading
+
+### In browser
+
+```html
+<script src="https://unpkg.com/@jspsych-timelines/test">
+```
+
+### Via NPM
+
+```
+npm install @jspsych-timelines/test
+```
+
+```js
+import { createTimeline, timelineUnits, utils } from "@jspsych-timelines/test"
+```
+
+## Compatibility
+
+`@jspsych-timelines/test` requires jsPsych v7.0.0 or later.
+
+## Documentation
+
+### createTimeline
+
+#### jsPsychTimelineTest.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
+
+me
+
diff --git a/packages/test/docs/test.md b/packages/test/docs/test.md
@@ -0,0 +1,51 @@
+# test
+
+test
+
+## Parameters
+
+### Initialization Parameters
+
+Initialization parameters can be set when calling `initJsPsych()`
+
+```js
+initJsPsych({
+  timelines: [
+    {type: jsPsychTimelineTest, params: {...}}
+  ]
+})
+```
+
+Parameter | Type | Default Value | Description
+----------|------|---------------|------------
+          |      |               |
+
+### Trial Parameters
+
+Trial parameters can be set when adding the timeline to a trial object.
+
+```js
+var trial = {
+  type: jsPsych...,
+  timelines: [
+    {type: jsPsychTimelineTest, params: {...}}
+  ]
+}
+```
+
+Parameter | Type | Default Value | Description
+----------|------|---------------|------------
+          |      |               |
+
+## Data Generated
+
+Name | Type | Value
+-----|------|------
+     |      |
+
+## Functions
+
+If the timeline adds any static functions, list them here.
+
+### function()
+
diff --git a/packages/test/examples/index.html b/packages/test/examples/index.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <script src="https://unpkg.com/jspsych"></script>
+  <script src="../dist/index.global.js"></script>
+  <link rel="stylesheet" href="https://unpkg.com/jspsych/css/jspsych.css">
+</head>
+
+<body></body>
+<script>
+  const jsPsych = initJsPsych();
+
+  const task = jsPsychTimelineTest.createTimeline(jsPsych, { });
+
+  jsPsych.run([task])
+</script>
+
+</html>
diff --git a/packages/test/jest.config.js b/packages/test/jest.config.js
@@ -0,0 +1 @@
+module.exports = require("@jspsych/config/jest").makePackageConfig(__dirname);
diff --git a/packages/test/package.json b/packages/test/package.json
@@ -0,0 +1,34 @@
+{
+  "name": "@jspsych-timelines/test",
+  "version": "0.0.1",
+  "description": "test",
+  "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 jsPsychTimelineTest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jspsych/jspsych-timelines.git"
+  },
+  "keywords": [
+    "jsPsych"
+  ],
+  "author": "me",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jspsych/jspsych-timelines/issues"
+  },
+  "homepage": "https://github.com/jspsych/jspsych-timelines/packages/test#readme",
+  "peerDependencies": {
+    "jspsych": "^8.0.1"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+    "tsup": "^6.7.0",
+    "typescript": "^5.0.2"
+  }
+}
diff --git a/packages/test/src/index.ts b/packages/test/src/index.ts
@@ -0,0 +1,9 @@
+import { JsPsych } from "jspsych"
+
+export function createTimeline(jsPsych:JsPsych, {}){
+
+}
+
+export const timelineUnits = {}
+
+export const utils = {}
diff --git a/packages/test/tsconfig.json b/packages/test/tsconfig.json
@@ -0,0 +1,10 @@
+{
+    "extends": "@jspsych/config/tsconfig.contrib.json",
+    "compilerOptions": {
+        "baseUrl": "."
+    },
+    "include": [
+        "src",
+        "../cli/src/build.js"
+    ]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		module.exports = require("@jspsych/config/jest").makePackageConfig(__dirname);