jsarch

v6.0.4
A simple module to extract architecture notes from your code.
architecture documentation

Readme Versions Dependencies Scripts

architecture

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

build

rimraf 'dist' && tsc --outDir dist

changelog

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

cli

env NODE_ENV=${NODE_ENV:-cli}

cover

npm run jest -- --coverage

cz

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

doc

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

format

npm run prettier

graph

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

graph:build

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

graph:generate

mmdc -i DEPENDENCIES.mmd -o DEPENDENCIES.mmd.png

jest

NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest

jsarch

node bin/jsarch.js

lint

eslint 'src/**/*.ts'

metapak

metapak

mocha

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

precz

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

prettier

prettier --write 'src/**/*.ts'

preversion

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

rebuild

swc ./src -s -d dist -C jsc.target=es2022

test

npm run jest

type-check

tsc --pretty --noEmit

version

npm run changelog
npm i jsarch

Metadata

  • MIT
  • >=20.11.1
  • Nicolas Froidure
  • released 7/15/2024

Downloads