Skip to content

Commit 7150920

Browse files
committed
Revert "Update new plugin and extension template mentions to point to jspsych-dev"
This reverts commit b243de6. Changes to be applied in point-templates-to-dev branch instead.
1 parent 2feebbf commit 7150920

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs/developers/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If you are developing a new plugin or extension there are two different reposito
3939

4040
The main `jspsych` repository is open to new plugins and extensions that are likely to be widely used. We require that contributions to main repository are well documented and tested before they are merged. Contributions to the main repository must use TypeScript. We limit contributions to this repository because once a plugin or extension is in the main codebase we are generally committed to providing updates as we develop new versions of jsPsych. Each new plugin and extension potentially increases the amount of development work that we will need to do in the future, so we are somewhat selective about what we will merge. If you have an idea that you'd like to discuss please [open a discussion thread](https://github.com/jspsych/jsPsych/discussions/new) and we'd love to chat about it!
4141

42-
The `jspsych-contrib` repository is open to any contributions that are complete and working code. There are some minimal guidelines in place about basic documentation that should be provided. Contributors can easily start building a new plugin or extension using our [new-plugin](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin) and [new-extension](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-extension) tools. Both tools run from the command line and will automatically generate a template plugin/extension package, which includes boilerplate code and essential files. Both of these tools also offer TypeScript and JavaScript versions of the generated package to choose from. Check our [plugin developer documentation](https://www.jspsych.org/latest/developers/plugin-development/) for additional guidance.
42+
The `jspsych-contrib` repository is open to any contributions that are complete and working code. There are some minimal guidelines in place about basic documentation that should be provided. Contributors can choose whether to develop their plugin or extension using our [TypeScript template](https://github.com/jspsych/jspsych-contrib/blob/main/templates/plugin-template-ts/src/index.ts) or using our [JavaScript template](https://github.com/jspsych/jspsych-contrib/blob/main/templates/plugin-template-js/src/index.js). Check our [plugin developer documentation](https://www.jspsych.org/latest/developers/plugin-development/) for additional guidance.
4343

4444
Contributions to `jspsych-contrib` are not evaluated for general usefulness in the same way that contributions to the main repository are. We also periodically consider whether to move contributions into the main repository from `jspsych-contrib` based on their popularity and completeness (documentation and testing).
4545

docs/developers/extension-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ As of version 7.0, extensions are [JavaScript Classes](https://developer.mozilla
1313

1414
### Templates
1515

16-
Plugins can be written in either plain JavaScript or in TypeScript. Template files for both [JavaScript](https://github.com/jspsych/jspsych-dev/blob/main/packages/new-extension/templates/extension-template-js/src/index.js) and [TypeScript](https://github.com/jspsych/jspsych-dev/blob/main/packages/new-extension/templates/extension-template-ts/src/index.ts) are available in the [jspsych-dev repository](https://github.com/jspsych/jspsych-dev/).
16+
Plugins can be written in either plain JavaScript or in TypeScript. Template files for both [JavaScript](https://github.com/jspsych/jspsych-contrib/blob/main/packages/extension-template/index.js) and [TypeScript](https://github.com/jspsych/jspsych-contrib/blob/main/packages/extension-template-ts/src/index.ts) are available in the [jspsych-contrib repository](https://github.com/jspsych/jspsych-contrib/).
1717

1818
## Extension components
1919

docs/developers/plugin-development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ As of version 7.0, plugins are [JavaScript Classes](https://developer.mozilla.or
1010

1111
## Plugin templates
1212

13-
Templates for plugins are available in the [jspsych-dev](https://github.com/jspsych/jspsych-dev) repository. Plugins can be written in either plain [JavaScript](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin/templates/plugin-template-js/src/index.js) or in [TypeScript](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin/templates/plugin-template-ts/src/index.ts).
13+
Templates for plugins are available in the [jspsych-contrib](https://github.com/jspsych/jspsych-contrib) repository. Plugins can be written in either plain [JavaScript](https://github.com/jspsych/jspsych-contrib/blob/main/templates/plugin-template-js/src/index.js) or in [TypeScript](https://github.com/jspsych/jspsych-contrib/blob/main/templates/plugin-template-ts/src/index.ts).
1414

15-
To get started with a template, we recommend using the CLI tools that we have published in jspsych-dev. These tools automate the setup of a new plugin in either JavaScript or TypeScript. Additional information about the CLI tools is available in the [`README`](https://github.com/jspsych/jspsych-dev/blob/main/README.md) of jspsych-dev.
15+
To get started with a template, we recommend using the CLI tool that we have published in jspsych-contrib. This automates the setup of a new plugin in either JavaScript or TypeScript. Additional information about the CLI tool is available in the [`README`](https://github.com/jspsych/jspsych-contrib?tab=readme-ov-file#creating-a-new-plugin-or-extension) of jspsych-contrib.
1616

1717
## Plugin components
1818

docs/support/migration-v7.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,11 @@ var trial = {
114114

115115
## Custom plugins
116116

117-
If you have custom plugins that you would like to upgrade to be compatible with v7.x we recommend using our [plugin template](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin/templates).
117+
If you have custom plugins that you would like to upgrade to be compatible with v7.x we recommend using our [plugin template](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-template/index.js).
118118

119119
The new template implements plugins as a class, but the core components are essentially unchanged.
120120

121-
* Anything in `plugin.info` from a v6.x plugin should be moved into the `info` object. Note that the `type` argument for the parameters follows a slightly different syntax in the v7.x plugins. This object is then [assigned as a static property of the class](https://github.com/jspsych/jspsych-dev/blob/main/packages/new-plugin/templates/plugin-template-js/src/index.js#L58).
121+
* Anything in `plugin.info` from a v6.x plugin should be moved into the `info` object. Note that the `type` argument for the parameters follows a slightly different syntax in the v7.x plugins. This object is then [assigned as a static property of the class](https://github.com/jspsych/jspsych-contrib/blob/6a27c3fc72fdb1feb1a4041cd670775a7c4bf51d/packages/plugin-template/index.js#L39).
122122
* Anything in `plugin.trial` from a v6.x plugin should be moved into the `trial` method inside the class.
123123
* The new template has a `constructor()` function that accepts an instance of jsPsych. You do not need to adjust this portion of the plugin.
124124

0 commit comments

Comments
 (0)