From 7e1b0f2df52e38b1668a967f2fd7c56f49f02655 Mon Sep 17 00:00:00 2001 From: cchang-vassar <79338042+cchang-vassar@users.noreply.github.com> Date: Fri, 2 May 2025 19:18:47 -0700 Subject: [PATCH] initial commit for plugin-free-sort-ordered --- .../plugin-free-sort-ordered/CITATION.cff | 41 +++++++++++ packages/plugin-free-sort-ordered/README.md | 21 ++++++ .../docs/plugin-free-sort-ordered.md | 33 +++++++++ .../examples/index.html | 25 +++++++ .../plugin-free-sort-ordered/jest.config.cjs | 1 + .../plugin-free-sort-ordered/package.json | 53 ++++++++++++++ .../rollup.config.mjs | 3 + .../src/index.spec.ts | 19 +++++ .../plugin-free-sort-ordered/src/index.ts | 71 +++++++++++++++++++ .../plugin-free-sort-ordered/tsconfig.json | 9 +++ 10 files changed, 276 insertions(+) create mode 100644 packages/plugin-free-sort-ordered/CITATION.cff create mode 100644 packages/plugin-free-sort-ordered/README.md create mode 100644 packages/plugin-free-sort-ordered/docs/plugin-free-sort-ordered.md create mode 100644 packages/plugin-free-sort-ordered/examples/index.html create mode 100644 packages/plugin-free-sort-ordered/jest.config.cjs create mode 100644 packages/plugin-free-sort-ordered/package.json create mode 100644 packages/plugin-free-sort-ordered/rollup.config.mjs create mode 100644 packages/plugin-free-sort-ordered/src/index.spec.ts create mode 100644 packages/plugin-free-sort-ordered/src/index.ts create mode 100644 packages/plugin-free-sort-ordered/tsconfig.json diff --git a/packages/plugin-free-sort-ordered/CITATION.cff b/packages/plugin-free-sort-ordered/CITATION.cff new file mode 100644 index 00000000..2627b8c9 --- /dev/null +++ b/packages/plugin-free-sort-ordered/CITATION.cff @@ -0,0 +1,41 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: +- family-names: "Cherrie Chang" # Replace with last name + given-names: "Cherrie Chang" # Replace with first name + name-particle: "Cherrie Chang" # Replace with name particle(s) + orcid: "https://orcid.org/0000-0000-0000-0000" # Replace with ORCID +# More authors can be listed here in the same format as above +contact: # Contact person for this extension +- family-names: "Cherrie Chang" + given-names: "Cherrie Chang" + email: "{email}" # Replace with contact person's email + orcid: "https://orcid.org/0000-0000-0000-0000" # Replace with contact person's ORCID +title: "jsPsychPluginFreeSortOrdered" +version: 0.0.0 +doi: 10.5281/zenodo.1234 # Replace with DOI +date-released: 2000-01-01 +url: "{softwareUrl}" # Replace with URL to this extension + +# If you wish to cite a paper on this extension instead, you can use the following template: +preferred-citation: + authors: + - family-names: "Cherrie Chang" + given-names: "Cherrie Chang" + name-particle: "Cherrie Chang" + orcid: "https://orcid.org/0000-0000-0000-0000" + # More authors can be listed here in the same format as above + date-published: 2023-05-11 + doi: 10.21105/joss.12345 + issn: 1234-5678 + issue: 01 + journal: Journal for Open Source Software + publisher: + name: Open Journals + start: 0001 + title: "{title}" + type: article # Other options include: book, pamphlet, conference-paper... + url: "{linkToPublicationInJournal}" + volume: 1 + +# More information on the preffered-citation CFF format can be found at https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#citing-something-other-than-software \ No newline at end of file diff --git a/packages/plugin-free-sort-ordered/README.md b/packages/plugin-free-sort-ordered/README.md new file mode 100644 index 00000000..3aae8167 --- /dev/null +++ b/packages/plugin-free-sort-ordered/README.md @@ -0,0 +1,21 @@ +# plugin-free-sort-ordered + +## Overview + +The free sort core plugin, but the images have to be sorted by placing into ordered boxes. + +## Loading + +*Enter instructions for loading the plugin package here.* + +## Compatibility + +`plugin-free-sort-ordered` requires jsPsych v8.0.0 or later. + +## Documentation + +See [documentation](/packages/plugin-free-sort-ordered/README.md) + +## Author / Citation + +[Cherrie Chang](https://github.com/cherriechang) \ No newline at end of file diff --git a/packages/plugin-free-sort-ordered/docs/plugin-free-sort-ordered.md b/packages/plugin-free-sort-ordered/docs/plugin-free-sort-ordered.md new file mode 100644 index 00000000..50308f59 --- /dev/null +++ b/packages/plugin-free-sort-ordered/docs/plugin-free-sort-ordered.md @@ -0,0 +1,33 @@ +# plugin-free-sort-ordered + +The free sort core plugin, but the images have to be sorted by placing into ordered boxes. + +## Parameters + +In addition to the [parameters available in all plugins](https://www.jspsych.org/latest/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of undefined must be specified. Other parameters can be left unspecified if the default value is acceptable. + +| Parameter | Type | Default Value | Description | +| ------------------- | ---------------- | ------------------ | ---------------------------------------- | +| | | | | + +## Data Generated + +In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial. + +| Name | Type | Value | +| --------- | ------- | ---------------------------------------- | +| | | | + +## Install + +*Enter instructions for installing the plugin package here.* + +## Examples + +### Title of Example + +```javascript +var trial = { + type: jsPsychPluginFreeSortOrdered +} +``` diff --git a/packages/plugin-free-sort-ordered/examples/index.html b/packages/plugin-free-sort-ordered/examples/index.html new file mode 100644 index 00000000..9c6e367e --- /dev/null +++ b/packages/plugin-free-sort-ordered/examples/index.html @@ -0,0 +1,25 @@ + + + +
+