Skip to content

auto-generate documentation from JSDoc strings for timelines #38

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

Jump to bottom
Open
wants to merge 59 commits into
base: main
Choose a base branch
from
Open

auto-generate documentation from JSDoc strings for timelines #38

wants to merge 59 commits into from

Conversation

cherriechang
Copy link
Collaborator

@cherriechang cherriechang commented Mar 18, 2025 •
edited
Loading

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Mar 18, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: de9c557

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@jspsych/new-extension Patch
@jspsych/new-plugin Patch
@jspsych/new-timeline Patch
@jspsych-dev/generate-timeline-docs Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@cherriechang
auto-generate non-flat version of docs
0f76471
@cherriechang
expand parameters and objects and display items in timelineUnits and …
aa620ff 
…utils in list form
@cherriechang
add files for post-processing auto-generated docs
75b25d5
@cherriechang
post-processing for main timeline docs done
2d79a0b
@cherriechang
change update-readme.js to generate-docs.js
be1bb66
@cherriechang
delete update-readme.js, update package.json to include generate-docs…
b183e03 
….js, filter-interfaces-docs.js and filter-timeline-docs.js
@cherriechang
delete merge-readme.js
8f7e0d5
@cherriechang
happy with interface filtering, timelineUnits filtering and timeline …
f80c4ff 
…filtering
@cherriechang
finish all 3 levels filter functions; updated update-readme script in…
d7fc5fa 
… package.json
@cherriechang
hearts and flowers documentation follows order
843a735
@cherriechang
fix package.json update-readme script to run all scripts not just first
06cb1b5
@cherriechang
adjust heading levels in createTimeline.md generation; add udpate-rea…
870742e 
…dme.js script to copy over to main README
@cherriechang
update update-readme.js to copy over timelineUnits and utils document…
c2cd138 
…ation as well
@cherriechang
properly update readme and delete unnecessary docs folder in hearts-a…
ffba82e 
…nd-flowers; moved all scripts for update-readme into separate folder 'readme-scripts'; updated templates to reflect changes
@cherriechang
add two missing readme-scripts to template-ts
02a5d3f
@cherriechang
add changeset
4c236d6
@cherriechang cherriechang requested a review from jodeleeuw June 9, 2025 16:46
@cherriechang cherriechang linked an issue Jun 10, 2025 that may be closed by this pull request
Path to dist file isn't right in the examples for new plugin #41
Open
@cherriechang cherriechang linked an issue Jun 10, 2025 that may be closed by this pull request
Add .gitignore to templates if needed #42
Open
cherriechang and others added 25 commits June 18, 2025 02:42
@cherriechang
add function in doc-dependency-graph.js to loop through all files in …
4b0cc58 
…docs directory
@cherriechang
Change to loop through all files in interfaces/ and filters them + ap…
83a28c5 
…plies path normalization
@cherriechang
add terminating heading to end of each interface
cdc3d8c
@cherriechang
process-interfaces-docs only returns false if interfaces/ doesn't exi…
987df68 
…st; keeps original file content if interface header not found; apply link normalization to all files
@cherriechang
process-functions-docs applies filtering to all .md files in function…
fbb96d3 
…s/; keeps original content if function not found; applies link normalization to all
@cherriechang
finish generalizing all processing to all .md files in functions/ var…
1052075 
…iables/ interfaces/
@cherriechang
filtering + link normalization works
f5cbcc1
@cherriechang
have to deal with fragments
8077358
@cherriechang
correct order of processing being generated
67df595
@cherriechang
add individual sections in docs files to graph
402bde8
@cherriechang
correct, section-based dependency order being generated
b0a9c48
@cherriechang
finish auto-gen docs with recursive dependency appending
610db7a
@cherriechang
convert to using commander so that tool options can be customized in …
d1fcefe 
…command line
@cherriechang
add doc marker as argument to tool
e499218
@cherriechang
modify update-readme to append generated docs after specified heading…
0682c5c 
… that marks the start of the readme to append, adding ## createTimeline() Documentation as a heading if the provided heading does not include createTimeline() documentation in it
@cherriechang
fix regex to allow for backticks in createTimeline()
db3516e
@cherriechang
add src/index.js as an entry point for typedoc
d357654
@cherriechang
update generate-typedoc-docs to loop through entrypoints in config; a…
46d825b 
…dd typedoc.json to final exported package; first pass at readme
@cherriechang
Allow relative path as package-directory argument
d8e13e9
@cherriechang
update default docStart to ## Documentation, start docs at one level …
5d051e2 
…lower than docStart (no replace)
@cherriechang
readme mostly done except boring jsdoc stuff; fix code to also append…
35b6047 
… non-createtimeline, timelineunits, utils docs at the end
@cherriechang
fix internal links
e498ee7
@cherriechang
jsdoc annotations readme part done
2c6eb54
@cherriechang
add comment that interfaces can only be used in typescript files
a226699
@cherriechang
update readme
0a87413
@cherriechang cherriechang requested a review from jodeleeuw July 10, 2025 00:13
cherriechang
cherriechang commented Jul 10, 2025
View reviewed changes
Copy link
Collaborator Author

@cherriechang cherriechang left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Reviewed changes: added functionality of recursively building dependency graph between element documentations and printing them in order in readme; re-organized source code for generate-timeline-docs, moving each step in the pipeline to its own script and adding an index.js file that centralizes the actual running of the pipeline; added small fixes to new-extension, new-plugin and new-timeline; modified README files in new-timeline templates to work with generate-timeline-docs tool

@jodeleeuw
Copy link
Member

It looks like merging this will make changes to the new-* packages as well. Do we need changesets for those changes?

@cherriechang
Copy link
Collaborator Author

It looks like merging this will make changes to the new-* packages as well. Do we need changesets for those changes?

added changesets separately for new-* packages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jodeleeuw jodeleeuw Awaiting requested review from jodeleeuw

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add .gitignore to templates if needed Path to dist file isn't right in the examples for new plugin
2 participants
@cherriechang @jodeleeuw