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

Enable jsdoc linting and readme generation. #18

Open
mattcollier opened this issue Mar 15, 2019 · 3 comments
Open

Enable jsdoc linting and readme generation. #18

mattcollier opened this issue Mar 15, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@mattcollier
Copy link
Contributor

No description provided.

@aljones15
Copy link
Contributor

@mattcollier let's use this to test out the eslint-plugin-import rules.
Also I do think we need to abstract out the jsdoc-to-markdown stuff into a project and start requiring it. Creating docs should be as easy as

npm run create-docs **/*.js

that would take a glob and then use that glob to pick up the files it would then put each file into an individual markdown file with title and api.

@mattcollier
Copy link
Contributor Author

I'm not in favor of investing any more time on tooling related to this at this time.

Also, I'm not clear on how what you're suggesting improves upon what we have now, as here:

https://github.com/digitalbazaar/bedrock-stats/blob/initial/package.json#L7

@aljones15
Copy link
Contributor

https://github.com/digitalbazaar/bedrock-stats/blob/initial/package.json#L7

no problem I like how you used the command line more efficiently than me.

@mandyvenables mandyvenables added the enhancement New feature or request label Jun 17, 2020
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

No branches or pull requests

3 participants