Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

set up readme to update automatically upon publish of new plugins/ext… #133

Merged
merged 8 commits into from
Aug 20, 2024
Merged

set up readme to update automatically upon publish of new plugins/ext… #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
59d1074
set up readme to update automatically upon publish of new plugins/ext…
cherriechang Aug 9, 2024
da8c915
use changeset to update readme on commit
cherriechang Aug 12, 2024
880e337
fix prompt to ask for any profile URL
cherriechang Aug 12, 2024
4a74ec7
fix unkpg links; fix url prompt; update author package.json to align …
cherriechang Aug 12, 2024
e798c0b
delete extra code lines in README
cherriechang Aug 13, 2024
781a7ea
fix cli prompt for author url; fix template package.json
cherriechang Aug 13, 2024
8d9b3b5
update all package.json follow npm convention
cherriechang Aug 13, 2024
9620b56
Merge branch 'main' into automate-readme-update
cherriechang Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ jobs:
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Update README list of plugins and extensions
run: npm run update-readme.js

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to add the commit and push actions here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quickly dropping a note here that we can just make the changesets action do the commit work for us:

    "update-unpkg-links": "gulp updateUnpkgLinks",
+   "update-readme": "node update-readme.js",
    "prepare": "husky install",
    "changeset": "changeset",
-   "changeset:version": "changeset version && npm install && npm run update-unpkg-links",
+   "changeset:version": "changeset version && npm install && npm run update-unpkg-links && npm run update-readme",

98 changes: 62 additions & 36 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

14,428 changes: 7,201 additions & 7,227 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@
"test:watch": "npm test -- --watch",
"build": "npm run build -ws",
"update-unpkg-links": "gulp updateUnpkgLinks",
"update-readme": "node ./update-readme.js",
"prepare": "husky install",
"changeset": "changeset",
"changeset:version": "changeset version && npm install && npm run update-unpkg-links",
"changeset:version": "changeset version && npm install && npm run update-unpkg-links && npm run update-readme",
"changeset:publish": "npm run build && changeset publish",
"new": "node ./templates/cli/src/index.js"
},
"dependencies": {
"gulp": "^5.0.0",
"gulp-replace": "^1.1.4"
},
"devDependencies": {
"@changesets/changelog-github": "^0.4.0",
"@changesets/cli": "^2.16.0",
Expand Down
7 changes: 5 additions & 2 deletions packages/extension-countdown/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/extension-countdown",
"version": "1.1.0",
"description": "jsPsych extension for adding a countdown during a trial",
"description": "This extension adds a countdown during a trial.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/extension-countdown"
},
"author": "Shaobin Jiang",
"author": {
"name": "Shaobin Jiang",
"url": "https://github.com/Shaobin-Jiang"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
5 changes: 4 additions & 1 deletion packages/extension-device-motion/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/extension-device-motion"
},
"author": "Pedro Neto",
"author": {
"name": "Pedro Neto",
"url": "https://github.com/pasoneto"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/extension-mediapipe-face-mesh/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/extension-mediapipe-face-mesh",
"version": "2.0.0",
"description": "A jsPsych extension for online tracking of facial posture during trials using the MediaPipe Face Mesh library",
"description": "This extension provides online tracking of facial posture during trials using the [MediaPipe Face Mesh](https://google.github.io/mediapipe/solutions/face_mesh) library.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -25,7 +25,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/extension-mediapipe-face-mesh"
},
"author": "C. Martin Grewe",
"author": {
"name": "C. Martin Grewe",
"url": "https://github.com/mgrewe"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
5 changes: 4 additions & 1 deletion packages/extension-touchscreen-buttons/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/extension-touchscreen-buttons"
},
"author": "Younes Strittmatter",
"author": {
"name": "Younes Strittmatter",
"url": "https://github.com/younesStrittmatter"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-audio-multi-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-audio-multi-response",
"version": "1.0.0",
"description": "",
"description": "This plugin collects responses to an audio file using both button clicks and key presses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-audio-multi-response"
},
"author": "Adam Richie-Halford",
"author": {
"name": "Adam Richie-Halford",
"url": "https://github.com/richford"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-audio-swipe-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-audio-swipe-response",
"version": "1.0.0",
"description": "",
"description": "This plugin collects responses to an audio file using swipe gestures and keyboard responses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-audio-swipe-response"
},
"author": "Adam Richie-Halford",
"author": {
"name": "Adam Richie-Halford",
"url": "https://github.com/richford"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
5 changes: 4 additions & 1 deletion packages/plugin-copying-task/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-copying-task"
},
"author": "Andre Sahakian",
"author": {
"name": "Andre Sahakian",
"url": "https://github.com/Andre3582"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-corsi-blocks/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-corsi-blocks",
"version": "1.0.0",
"description": "Corsi blocks task plugin for jsPsych",
"description": "This plugin displays a configurable Corsi blocks task and records a series of click responses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-corsi-blocks"
},
"author": "Josh de Leeuw",
"author": {
"name": "Josh de Leeuw",
"url": "https://github.com/jodeleeuw"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
9 changes: 6 additions & 3 deletions packages/plugin-gamepad/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/jspsych-gamepad",
"name": "@jspsych-contrib/plugin-gamepad",
"version": "1.0.1",
"description": "A jsPsych plugin for using gamepad in behavioral experiments",
"description": "This plugin allows one to use gamepads in a jsPsych experiment.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-gamepad"
},
"author": "Shaobin Jiang",
"author": {
"name": "Shaobin Jiang",
"url": "https://github.com/Shaobin-Jiang"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-gamepad/src/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import PluginGamepad from ".";

jest.useFakeTimers();

describe("jsPsychGamepad", () => {
describe("Gamepad", () => {
it("should end within about 2s", async () => {
let time_start = performance.now();
await startTimeline([
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-gamepad/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
import { GamepadModel, GamepadModels } from "./gamepad-model";

const info = <const>{
name: "jspsych-gamepad",
name: "gamepad",
parameters: {
/**
* The size of the canvas element
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-html-choice/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-html-choice",
"version": "1.0.0",
"description": "",
"description": "This plugin displays clickable html elements that can be used to present a choice.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-html-choice"
},
"author": "Younes Strittmatter",
"author": {
"name": "Younes Strittmatter",
"url": "https://github.com/younesStrittmatter"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
5 changes: 4 additions & 1 deletion packages/plugin-html-keyboard-response-raf/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-html-keyboard-response-raf"
},
"author": "Josh de Leeuw",
"author": {
"name": "Josh de Leeuw",
"url": "https://github.com/jodeleeuw"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-html-keyboard-slider/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-html-keyboard-slider",
"version": "1.0.0",
"description": "HTML slider which allows for keyboard responses",
"description": "Sliders which allow for keyboard responses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-html-keyboard-slider"
},
"author": "Max Lovell",
"author": {
"name": "Max Lovell",
"url": "https://github.com/Max-Lovell"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-html-multi-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-html-multi-response",
"version": "1.0.2",
"description": "",
"description": "This plugin collects responses to an arbitrary HTML string using both button clicks and key presses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-html-multi-response"
},
"author": "Adam Richie-Halford",
"author": {
"name": "Adam Richie-Halford",
"url": "https://github.com/richford"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-html-swipe-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-html-swipe-response",
"version": "1.1.2",
"description": "",
"description": "This plugin collects responses to an arbitrary HTML string using swipe gestures and keyboard responses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-html-swipe-response"
},
"author": "Adam Richie-Halford",
"author": {
"name": "Adam Richie-Halford",
"url": "https://github.com/richford"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-html-vas-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-html-vas-response",
"version": "1.2.0",
"description": "",
"description": "This plugin collects responses to an arbitrary HTML string using a point-and-click visual analogue scale.",
"unpkg": "dist/index.browser.min.js",
"files": [
"index.js",
Expand All @@ -16,7 +16,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-html-vas-response"
},
"author": "Isaac Kinley",
"author": {
"name": "Isaac Kinley",
"url": "https://github.com/kinleyid"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-image-array-keyboard-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-image-array-keyboard-response",
"version": "1.0.0",
"description": "",
"description": "This plugin displays an arbitrary number of images and records responses generated with the keyboard.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-image-array-keyboard-response"
},
"author": "Younes Strittmatter",
"author": {
"name": "Younes Strittmatter",
"url": "https://github.com/younesStrittmatter"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-image-multi-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-image-multi-response",
"version": "1.0.1",
"description": "",
"description": "This plugin collects responses to an image stimulus using both button clicks and key presses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-image-multi-response"
},
"author": "Adam Richie-Halford",
"author": {
"name": "Adam Richie-Halford",
"url": "https://github.com/richford"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
7 changes: 5 additions & 2 deletions packages/plugin-image-swipe-response/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jspsych-contrib/plugin-image-swipe-response",
"version": "1.0.0",
"description": "",
"description": "This plugin collects responses to an image stimulus using swipe gestures and keyboard responses.",
"type": "module",
"main": "dist/index.cjs",
"exports": {
Expand All @@ -27,7 +27,10 @@
"url": "git+https://github.com/jspsych/jspsych-contrib.git",
"directory": "packages/plugin-image-swipe-response"
},
"author": "Adam Richie-Halford",
"author": {
"name": "Adam Richie-Halford",
"url": "https://github.com/richford"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/jspsych/jspsych-contrib/issues"
Expand Down
Loading