merge with remote branch

jspsych · Sep 3, 2024 · ab66fa0 · ab66fa0
1 parent 3297231
commit ab66fa0
Show file tree

Hide file tree

Showing 8 changed files with 8,331 additions and 6,336 deletions.
diff --git a/package-lock.json b/package-lock.json
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,37 @@
+{
+    "name": "@jspsych-timelines/test",
+    "version": "0.0.1",
+    "description": "test",
+    "type": "module",
+    "main": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "unpkg": "dist/index.browser.min.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": {
+      "name": "me",
+      "url": ""
+    },
+    "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);