baldrick-doc-ts

Documentation generator for typescript projects

Generation of documentation for node.js libraries written in Typescript

Highlights:

• Generate helpful documentation for a typescript project.

• Produce a markdown file with an UML diagram in Mermaid of all the dependencies and the relationships between them.

• Generate API documentation as markdown. This provides a more basic documentation that the default typedoc but does not generate any html or css that would become part of the source code, and may raise some warnings with many linters.

• Generate a markdown file with the common vocabulary used in the function names.

• Generate a CSV with the list of typescript functions from the code base.

A few examples of commands:

Generate markdown document describing the api of the library:

npx baldrick-doc-ts@latest typedoc --json-source pest-spec/fixture/typedoc.json

Generate CODE_VOCABULARY.md with ngram of the code base vocabulary:

npx baldrick-doc-ts@latest parse --feature ngram

Generate INTERNAL.md with UML diagram in Mermaid of the dependencies:

npx baldrick-doc-ts@latest parse --feature internal

Generate internal_functions.csv with all the typescript functions:

npx baldrick-doc-ts@latest parse --feature functions-csv

Documentation and links

• Code Maintenance
• Code Of Conduct
• Api for baldrick-doc-ts
• Contributing
• Glossary
• Diagram for the code base
• Vocabulary used in the code base
• Architectural Decision Records
• Contributors
• Dependencies
• Usage

Related

• baldrick-zest-engine Run tests declaratively with a few cunning plans

Installation

This package is ESM only.

yarn global add baldrick-doc-ts
baldrick-doc-ts --help

Or alternatively run it:

npx baldrick-doc-ts --help

If you want to tun the latest version from github. Mostly useful for dev:

git clone git@github.com:flarebyte/baldrick-doc-ts.git
yarn global add `pwd`