Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
e0fc6b4
initial commit for autodoc tool
jadeddelta May 28, 2026
c12a80b
add smart detection of jsPsych package type, begin utility function r…
jadeddelta Jun 1, 2026
2664e38
finish autodoc extension parser + tests, remove async/awaits, other r…
jadeddelta Jun 2, 2026
23f926c
quick and dirty implementation of extension renderer
jadeddelta Jun 2, 2026
0e7acb6
finish extension example parser and renderer, tests + refactor
jadeddelta Jun 15, 2026
1f7f907
add auto-detection of package type, set up timeline skeleton
jadeddelta Jun 16, 2026
8ddec93
add timeline parsing and rendering and testing
jadeddelta Jun 18, 2026
f4df858
add file discovery for running CLI without any flags
jadeddelta Jun 24, 2026
e5ec2e8
fix handling of destructured parameters in function signatures
jadeddelta Jun 26, 2026
fcd0abe
fix bug where `typeof` interfaces would not get hoisted
jadeddelta Jun 26, 2026
1da68f0
add support for custom renderer section templates, exportable CLI too…
jadeddelta Jun 28, 2026
4749539
move typescript to dependencies
jadeddelta Jun 29, 2026
0b9ab58
move param type map into utils and import into renderers/parsers for …
becky-gilbert Jul 1, 2026
198deec
fix expected param type strings in data extraction tests
becky-gilbert Jul 1, 2026
f179972
add tests for parameter type map and data generated type values in pl…
becky-gilbert Jul 1, 2026
a06a1d5
update extension test snapshot with string versions of param types
becky-gilbert Jul 1, 2026
8b349bc
Merge pull request #68 from jspsych/data-table-param-strings
jadeddelta Jul 2, 2026
7cd82a6
add testing workflow and ensure `npm t` is runnable in root directory
jadeddelta Jul 2, 2026
4f38d7f
extension example inference: detect relevant code by var name or exte…
becky-gilbert Jul 6, 2026
1de842c
update inferCodeBlock JSDoc comment to reflect new logic (either tria…
becky-gilbert Jul 6, 2026
94a2991
add tests for extension example code parsing and infer-tests director…
becky-gilbert Jul 6, 2026
5dd528a
add missing test example file
becky-gilbert Jul 7, 2026
8479e6a
Merge pull request #70 from jspsych/extension-example-parsing
jadeddelta Jul 9, 2026
ce22b8f
add static/instance method detection to plugin and extension autodoc
jadeddelta Jul 13, 2026
4ed1f47
reduce functions/examples to empty strings if none are found
jadeddelta Jul 14, 2026
ae138e4
remove package name (first bolded word) in description for renderers
jadeddelta Jul 14, 2026
a3b0523
parser wraps default values with backticks in double backticks to ren…
jadeddelta Jul 15, 2026
3559a02
relativize example paths before giving them to the renderer
jadeddelta Jul 15, 2026
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
5 changes: 5 additions & 0 deletions .changeset/red-students-tap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@jspsych/autodoc": minor
---

Initial implementation of @jspsych/autodoc, a CLI tool for generating documentation from jsPsych package files.
32 changes: 32 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: build

on:
push:
pull_request:
types: [opened, reopened, ready_for_review, review_requested, synchronize]

jobs:
test:
name: Build, lint, and test on Node.js ${{ matrix.node }}
runs-on: ubuntu-latest
strategy:
matrix:
node: [20, 22]

steps:
- uses: actions/checkout@v4

- name: Setup Node.js ${{ matrix.node }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
cache: npm

- name: Install dependencies
run: npm ci

- name: Build packages
run: npm run build --workspaces --if-present

- name: Run tests
run: npm run test -- --ci --maxWorkers=2 --reporters=default --reporters=github-actions
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
.vscode
.DS_Store
.DS_Store
dist
Loading
Loading