0.7.0 • Published 4 years ago
livingdoc-typescript-plugin v0.7.0
livingdoc-typescript-plugin
Living documentation plugin for typescript.
Usage
Install
npm install --global livingdocNo installation
npx livingdoc ...Generate classes diagram
livingdoc-typescript-plugin diagram -i src\domain\**\*.ts -o dist\domain-classes.svgResult example :
Generate glossary
livingdoc-typescript-plugin glossary -i src\domain\**\*.ts -o dist\glossary.mdResult example :
| ObjectName | Attribute name | Type | Description |
|---|---|---|---|
| Access | |||
| phoneNumber | string | ||
| price | number | ||
| dateTime | string | ||
| Bill | @RootAggregateMonthly bill. | ||
| month | string | Which month of the bill. | |
| contract | Contract | Contract concerned by the bill. | |
| accesses | Access[] | Bill contents. | |
| paymentState | PaymentState | Bill payment state | |
| BillsService | |||
| CallAccess | |||
| duration | string | ||
| Contract | Telecom contract | ||
| id | number | Contract identifier.Generate by the system and communicate to client. | |
| customer | Customer | Contract customer. | |
| Customer | Customer of the telecom service | ||
| string | Email of the customer. | ||
| contracts | Contract[] | Customer's contracts. | |
| PaymentState | Enumeration | Bill payment state values. | |
| WAITING | Wainting payment by the client. | ||
| DONE | Client has payed. | ||
| SmsAccess |
Options
-i, --input
Define the path of the Typescript file-o, --output
Define the path of the output file. If not defined, it'll output on the STDOUT-d, --deep
Indicate if program must through dependancies content or not