@asyncapi/generator

v2.4.1
The AsyncAPI generator. It can generate documentation, code, anything!
asyncapi documentation generator markdown codegen

test

npm run test:unit && npm run test:integration && npm run test:cli

test:unit

jest --coverage --testPathIgnorePatterns=integration --testPathIgnorePatterns=test-project

test:dev

npm run test:unit -- --watchAll

test:integration

npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\/loglevel\.js$)'

test:integration:update

jest --updateSnapshot --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\/loglevel\.js$)'

test:cli

node cli.js ./test/docs/dummy.yml ./test/test-templates/react-template -o test/output --force-write --debug && test -e test/output/test-file.md

test:cleanup

rimraf "test/temp"

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

docker:build

docker build -t asyncapi/generator:latest .

lint

eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .

lint:tpl:validator

eslint --fix --config ../../.eslintrc ../../.github/templates-list-validator

generate:readme:toc

markdown-toc -i README.md

generate:assets

npm run docs && npm run generate:readme:toc

bump:version

npm --no-git-tag-version --allow-same-version version $VERSION
npm i @asyncapi/generator

Metadata

Downloads