digitalbazaar / web-ledger-client

An implementation of a a Web Ledger client
BSD 3-Clause "New" or "Revised" License
5 stars 2 forks source link

Enable jsdoc linting and readme generation. #18

Open mattcollier opened 5 years ago

aljones15 commented 5 years ago

@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 commented 5 years ago

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 commented 5 years ago

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.