initial release of the autodoc tool

[jadeddelta]

release for @jspsych/autodoc, a CLI tool for automatically generating documentation based off of jsPsych plugins, extensions, and timelines.

as of the first commit, it works via running it with a --source and --dest flag for the source files and destination files, alongside an optional --example flag for if you have examples (one file or a directory) to tie with the source file.

things we will offer (and a handy TODO list):

• generate documentation based off of plugin files
  • forgot this, add static function documentation, see if other extensions/timelines need this
• generate documentation based off of extension files
• generate documentation based off of timeline files
• system to allow for customizable templates: i.e. one for jspsych core repo, one for contrib, and then the ability to have other orgs write and run their own templates.
• automatic inference on if a file is a plugin, extension, or timeline
• clear documentation on every part, what the outputs are and quirks of the system
• ensure package.json is formatted to allow for the typescript file to be transpiled to javascript for npx usage

[changeset-bot]

🦋 Changeset detected

Latest commit: 7cd82a6

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

This PR includes changesets to release 1 package

Name	Type
@jspsych/autodoc	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

[becky-gilbert]

I'm excited to try this out! 🎉