@asyncapi/generator
v1.10.5 asyncapi documentation generator markdown codegen
docs
jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/docs.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs --files lib/generator.js > docs/api.md
lint
eslint --max-warnings 0 --config .eslintrc .
test
npm run test:unit && npm run test:integration && npm run test:cli
test:cli
node cli.js ./test/docs/dummy.yml @asyncapi/html-template -o test/output --force-write --debug && test -e test/output/index.html
test:dev
npm run test:unit -- --watchAll
test:unit
jest --coverage --testPathIgnorePatterns=integration --testPathIgnorePatterns=test-project
bump:version
npm --no-git-tag-version --allow-same-version version $VERSION
docker:build
docker build -t asyncapi/generator:latest .
test:cleanup
rimraf "test/temp"
generate:assets
npm run docs && npm run generate:readme:toc
test:integration
npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__'
lint:tpl:validator
eslint --fix --config .eslintrc .github/templates-list-validator
generate:readme:toc
markdown-toc -i README.md
npm i @asyncapi/[email protected]
Metadata
- Apache-2.0
- >12.16
- Fran Mendez
- released 6/7/2023