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.

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

Adding new checkup package to provide plugin utils. Generates docs #923

Merged
merged 1 commit into from
Apr 7, 2021

Conversation

scalvert
Copy link
Contributor

@scalvert scalvert commented Apr 7, 2021

Implements #734

Adds a new package, @checkup/plugin, to provide plugin utilities for plugins to use. The first util is a new command, which generates markdown documentation files for tasks.

The first iteration generates very rudimentary documentation, but paves the way for additions to improve the quality of the plugin docs.

Example:

Generates...

<!--TASK_NAME_START-->
# javascript/outdated-dependencies
<!--TASK_NAME_END-->

<!--TASK_DESCRIPTION_START-->
Gets a summary of all outdated dependencies in a project
<!--TASK_DESCRIPTION_END-->

<!--RUN_START-->
## To run this task

\`\`\`bash
checkup run --task javascript/outdated-dependencies
\`\`\`
<!--RUN_END-->

which looks like...

javascript/outdated-dependencies

Gets a summary of all outdated dependencies in a project

To run this task

checkup run --task javascript/outdated-dependencies

@scalvert scalvert requested review from carakessler and rwjblue April 7, 2021 19:21
@scalvert scalvert added the enhancement New feature or request label Apr 7, 2021
@scalvert scalvert linked an issue Apr 7, 2021 that may be closed by this pull request
@scalvert scalvert merged commit 349d24f into master Apr 7, 2021
@scalvert scalvert deleted the plugin-docs branch April 7, 2021 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create system for auto-generating documentation.
1 participant