From 2c4c9dd9b6deb075bb7f0f3052f3674adbe0290b Mon Sep 17 00:00:00 2001 From: Cherrie Chang Date: Fri, 17 Jan 2025 13:52:21 -0500 Subject: [PATCH 1/5] add README for new-extension and new-timeline --- packages/new-extension/README.md | 9 +++++++++ packages/new-timeline/README.md | 9 +++++++++ 2 files changed, 18 insertions(+) create mode 100644 packages/new-extension/README.md diff --git a/packages/new-extension/README.md b/packages/new-extension/README.md new file mode 100644 index 0000000..440f6bc --- /dev/null +++ b/packages/new-extension/README.md @@ -0,0 +1,9 @@ +# `@jspsych/new-extension` +This package allows you to start building an extension in any directory by simply running `npx @jspsych/new-extension` from the command line. + +You will be prompted to enter a name for your extension, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your extension, and an optional link to a `README.md` file for your extension. Your template package containing boilerplate code will then be automatically generated in your current working directory. + +!!! note + If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In general, if you are planning to publish your extension, we recommend choosing TypeScript as your extension's language, because________________. + +In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your extension, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your extension provides. The file that contains your actual extension code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your extension so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your extension, we highly recommend filling out the `CITATION.cff` file as it allows your extension's users to easily cite your extension. diff --git a/packages/new-timeline/README.md b/packages/new-timeline/README.md index e69de29..666b8c0 100644 --- a/packages/new-timeline/README.md +++ b/packages/new-timeline/README.md @@ -0,0 +1,9 @@ +# `@jspsych/new-timeline` +This package allows you to start building a timeline in any directory by simply running `npx @jspsych/new-timeline` from the command line. + +You will be prompted to enter a name for your timeline, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your timeline, and an optional link to a `README.md` file for your timeline. Your template package containing boilerplate code will then be automatically generated in your current working directory. + +!!! note + If you are running this command in the jspsych-timelines repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In general, if you are planning to publish your timeline, we recommend choosing TypeScript as your timeline's language, because________________. + +In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your timeline, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your timeline provides. The file that contains your actual timeline code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your timeline so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your timeline, we highly recommend filling out the `CITATION.cff` file as it allows your timeline's users to easily cite your timeline. From 6aedc8ea9f3d876cb3d9baa3d3d925522a2183b7 Mon Sep 17 00:00:00 2001 From: Cherrie Chang Date: Fri, 17 Jan 2025 14:19:52 -0500 Subject: [PATCH 2/5] fix package name --- packages/new-timeline/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/new-timeline/package.json b/packages/new-timeline/package.json index ad4ba04..05455f3 100644 --- a/packages/new-timeline/package.json +++ b/packages/new-timeline/package.json @@ -1,6 +1,6 @@ { - "name": "@jspsych-timelines/new-timeline", - "version": "0.2.0", + "name": "@jspsych/new-timeline", + "version": "0.0.1", "description": "CLI tool for creating new jsPsych timelines", "type": "module", "files": [ From eb80839257ac2105b9d857de2b8717bb3e41f3f5 Mon Sep 17 00:00:00 2001 From: Cherrie Chang Date: Fri, 17 Jan 2025 14:33:38 -0500 Subject: [PATCH 3/5] add changeset --- .changeset/plenty-books-wait.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/plenty-books-wait.md diff --git a/.changeset/plenty-books-wait.md b/.changeset/plenty-books-wait.md new file mode 100644 index 0000000..eea858f --- /dev/null +++ b/.changeset/plenty-books-wait.md @@ -0,0 +1,6 @@ +--- +"@jspsych/new-extension": patch +"@jspsych/new-timeline": patch +--- + +Added README for new-extension and new-timeline; fixed new-timeline package name. From f5586a058c1be2d4e962ecbb87f9438dac575b41 Mon Sep 17 00:00:00 2001 From: Cherrie Chang Date: Fri, 17 Jan 2025 15:04:48 -0500 Subject: [PATCH 4/5] fix note display in readme; delete line about using ts for publishing --- packages/new-extension/README.md | 4 ++-- packages/new-plugin/README.md | 4 ++-- packages/new-timeline/README.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/new-extension/README.md b/packages/new-extension/README.md index 440f6bc..0a6b37b 100644 --- a/packages/new-extension/README.md +++ b/packages/new-extension/README.md @@ -3,7 +3,7 @@ This package allows you to start building an extension in any directory by simpl You will be prompted to enter a name for your extension, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your extension, and an optional link to a `README.md` file for your extension. Your template package containing boilerplate code will then be automatically generated in your current working directory. -!!! note - If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In general, if you are planning to publish your extension, we recommend choosing TypeScript as your extension's language, because________________. +> [!NOTE] +> If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your extension, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your extension provides. The file that contains your actual extension code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your extension so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your extension, we highly recommend filling out the `CITATION.cff` file as it allows your extension's users to easily cite your extension. diff --git a/packages/new-plugin/README.md b/packages/new-plugin/README.md index e413824..be2b788 100644 --- a/packages/new-plugin/README.md +++ b/packages/new-plugin/README.md @@ -3,7 +3,7 @@ This package allows you to start building a plugin in any directory by simply ru You will be prompted to enter a name for your plugin, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your plugin, and an optional link to a `README.md` file for your plugin. Your template package containing boilerplate code will then be automatically generated in your current working directory. -!!! note - If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In general, if you are planning to publish your plugin, we recommend choosing TypeScript as your plugin's language, because________________. +> [!NOTE] +> If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your plugin, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your plugin provides. The file that contains your actual plugin code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your plugin so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your plugin, we highly recommend filling out the `CITATION.cff` file as it allows your plugin's users to easily cite your plugin. diff --git a/packages/new-timeline/README.md b/packages/new-timeline/README.md index 666b8c0..447256f 100644 --- a/packages/new-timeline/README.md +++ b/packages/new-timeline/README.md @@ -3,7 +3,7 @@ This package allows you to start building a timeline in any directory by simply You will be prompted to enter a name for your timeline, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your timeline, and an optional link to a `README.md` file for your timeline. Your template package containing boilerplate code will then be automatically generated in your current working directory. -!!! note - If you are running this command in the jspsych-timelines repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In general, if you are planning to publish your timeline, we recommend choosing TypeScript as your timeline's language, because________________. +> [!NOTE] +> If you are running this command in the jspsych-timelines repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your timeline, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your timeline provides. The file that contains your actual timeline code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your timeline so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your timeline, we highly recommend filling out the `CITATION.cff` file as it allows your timeline's users to easily cite your timeline. From 236029fcfa28e7d481e6446e7f9cad10f54d6a93 Mon Sep 17 00:00:00 2001 From: Cherrie Chang Date: Fri, 17 Jan 2025 15:14:51 -0500 Subject: [PATCH 5/5] update changeset --- .changeset/plenty-books-wait.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.changeset/plenty-books-wait.md b/.changeset/plenty-books-wait.md index eea858f..bf42e18 100644 --- a/.changeset/plenty-books-wait.md +++ b/.changeset/plenty-books-wait.md @@ -1,6 +1,7 @@ --- "@jspsych/new-extension": patch "@jspsych/new-timeline": patch +"@jspsych/new-plugin": patch --- -Added README for new-extension and new-timeline; fixed new-timeline package name. +This patch adds README for new-extension and new-timeline; fixes new-timeline package name; and fixes note in README for all 3 packages.