jsPsych icon indicating copy to clipboard operation
jsPsych copied to clipboard

V8 plugin metadata

Open vzhang03 opened this issue 1 year ago • 2 comments

Updated plugins to adopt new JsPsych standard for parameters with the version and data fields, while updating comments and links within plugins to phase out documentation and update JsDoc. Worked with Professor de Leeuw on implementing Psych-DS and decided on this prototype as the final version. By including the version with the plugin, we allow the versions of each plugin to be included with the final data. This allows the metadata module to scrape and call the API correctly. The "data" field allows the metadata module to scrape descriptions of the output and describe the variables.

~~Due to the updates to the PluginInfo interface with the "version" and "data" fields, this breaks all previous versions of plugins to be incompatible with v8. To fix these issues adjusted test cases to include these fields. Will need to update tests and can use these to finalize testing of the metadata module.~~

List of changes to all JsPsych plugins

  • Added version numbers
  • Added data field describing the data generated with type and description in jsDoc
  • Updated links with "/latest"
  • Updated parameters comments to be the same as included in the documentation files (efforts to standardize descriptions)
  • Updated descriptions of plugins to reflect the current documentation

General Changes

  • Writing version numbers of plugins to data for every plugin

vzhang03 avatar Jun 24 '24 14:06 vzhang03