feat(documentation): add api-extractore, api-doc, es-lint fixes #27 #55
Conversation
| @@ -44,6 +44,7 @@ | |||
| "eslint-config-airbnb-base": "^15.0.0", | |||
| "eslint-plugin-import": "^2.26.0", | |||
| "eslint-plugin-json": "^3.1.0", | |||
| "eslint-plugin-tsdoc": "^0.2.17", | |||
There was a problem hiding this comment.
a docs script should be added to the main package json
docs script should be added to each package that exists
docs script should be added to the template plop generator
api extractor config should be added to the template plop generator as well as the eslint config
docs script should be added to the list of affected scripts that run so that this will trigger during CI/CD to generate docs
There was a problem hiding this comment.
re docs script should be added to each package that exists -- tokens package is just a db, it doesn't have any code, only JSON files.
There was a problem hiding this comment.
re docs script should be added to the template plop generator -- added
There was a problem hiding this comment.
re a docs script should be added to the main package json -- added
There was a problem hiding this comment.
re api extractor config should be added to the template plop generator as well as the eslint config -- added api-extractor config to plop templates (also fixed some small bugs).
re eslint config to plop -- the es lint rule I've added is global for the monorepo not individual to each package.
There was a problem hiding this comment.
@chrisadubois ready for re-review
| @@ -28,6 +28,7 @@ module.exports = { | |||
| }, | |||
| plugins: [ | |||
| '@typescript-eslint', | |||
| 'eslint-plugin-tsdoc', | |||
| @@ -47,6 +48,7 @@ module.exports = { | |||
| 'max-len': ['error', { code: 120 }], | |||
| indent: ['error', 2, { ignoredNodes: ['PropertyDefinition'], SwitchCase: 1 }], | |||
| 'object-curly-newline': 'off', | |||
| 'tsdoc/syntax': 'warn', | |||
Description
Added following packages:
Also added scripts to generate metadata and the markdown.
Links
#27