jsarch

v5.0.0
A simple module to extract architecture notes from your code.
architecture documentation

Readme Versions Dependencies Scripts

cz

env NODE_ENV=${NODE_ENV:-cli} git cz

cli

env NODE_ENV=${NODE_ENV:-cli}

doc

echo "# API" > API.md; jsdoc2md src/*.js >> API.md && git add API.md

lint

eslint src/*.js

test

npm run mocha

cover

nyc npm test && nyc report --reporter=html --reporter=text

graph

npm run graph:build && npm run graph:generate && git add DEPENDENCIES.mmd*

mocha

mocha --require '@babel/register' src/*.mocha.js

precz

npm run compile && npm run graph && npm run architecture && npm run doc && npm t && npm run lint && npm run metapak -- -s

jsarch

node bin/jsarch.js

compile

rimraf -f 'dist' && npm run compile:cjs && npm run compile:mjs

metapak

metapak

version

npm run changelog

prettier

prettier --write src/*.js

changelog

conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md

coveralls

nyc npm test && nyc report --reporter=text-lcov | coveralls && rm -rf ./coverage

preversion

npm t && npm run lint && npm run metapak -- -s && npm run compile && npm run doc

compile:cjs

babel --env-name=cjs --out-dir=dist --source-maps=true src

compile:mjs

babel --env-name=mjs --out-file-extension=.mjs --out-dir=dist --source-maps=true src

graph:build

MERMAID_RUN=1 node bin/jsarch.js > DEPENDENCIES.mmd

architecture

node bin/jsarch.js src/*.js > ARCHITECTURE.md

graph:generate

mmdc -i DEPENDENCIES.mmd -o DEPENDENCIES.mmd.png
npm i [email protected]

Metadata

  • MIT
  • >=12.19.0
  • Nicolas Froidure
  • released 10/31/2021

Downloads