@rxap/plugin-compodoc

This Nx plugin generates documentation for Angular, NestJS and other TypeScript projects using Compodoc. It provides executors to build and serve the documentation, as well as generators to initialize Compodoc in your projects. The plugin automates the configuration of tsconfig files and gitignore files for Compodoc.

• Installation
• Generators
  • init
  • init-library
  • init-application
• Executors
  • build

Installation

Add the package to your workspace:

yarn add @rxap/plugin-compodoc

Execute the init generator:

yarn nx g @rxap/plugin-compodoc:init

Generators

init

init generator

nx g @rxap/plugin-compodoc:init

Option	Type	Default	Description
project	string
projects	array
skipFormat	boolean	false
overwrite	boolean	false	Whether to overwrite existing files
skipProjects	boolean	false	Whether to skip executing project specific initialization

init-library

init-library generator

nx g @rxap/plugin-compodoc:init-library

Option	Type	Default	Description
project	string
projects	array
skipFormat	boolean	false
overwrite	boolean	false	Whether to overwrite existing files
skipProjects	boolean	false	Whether to skip executing project specific initialization

init-application

init-application generator

nx g @rxap/plugin-compodoc:init-application

Option	Type	Default	Description
project	string
projects	array
skipFormat	boolean	false
overwrite	boolean	false	Whether to overwrite existing files
skipProjects	boolean	false	Whether to skip executing project specific initialization

Executors

build

build executor

Option	Type	Default	Description
tsConfig	string		Path to project's TypeScript configuration file. (default: `<projectRoot>/tsconfig.json`)
outputPath			The output path of the generated files. (default: `dist/compodoc/<projectName>`)
exportFormat	string	html	Format of generated documentation: html, json (json implicitly enables Compodoc's `minimal` mode)
name	string		Title of the documentation.
includes	string		Path to external markdown files, folder should contain a summary.json.
includesName	string		Name of menu item containing external markdown files.
assetsFolder	string		External assets folder to copy in generated documentation folder.
unitTestCoverage	string		Path to unit test coverage in json-summary format.
disableCoverage	boolean	true	Do not add the documentation coverage report.
disableSourceCode	boolean	false	Do not add source code tab and links to source code.
disableDomTree	boolean	false	Do not add dom tree tab.
disableTemplateTab	boolean	false	Do not add template tab.
disableStyleTab	boolean	false	Do not add style tab.
disableGraph	boolean	false	Disable rendering of the dependency graph.
disablePrivate	boolean	true	Do not show private in generated documentation.
disableProtected	boolean	false	Do not show protected in generated documentation.
disableInternal	boolean	true	Do not show @internal in generated documentation.
disableLifeCycleHooks	boolean	true	Do not show Angular lifecycle hooks in generated documentation.
disableRoutesGraph	boolean	false	Do not add the routes graph.
disableSearch	boolean	false	Do not add the search input.
disableDependencies	boolean	false	Do not add the dependencies list.
coverageTest	integer	0	Threshold for global documentation coverage.
coverageMinimumPerFile	integer	0	Threshold for documentation coverage of each file.
coverageTestThresholdFail	boolean	true	bort compodoc with an error instead of a warn log, if coverage threshold (global or per file) is not reached (true: error, false: warn).
language	string	en-US	Language used for generated documentation.
theme	string	gitbook	Theme used for generated documentation.
extTheme	string		Path to external theme file.
templates	string		Path to directory of Handlebars templates to override built-in templates.
customLogo	string		Path to custom logo.
customFavicon	string		Path to custom favicon.
hideGenerator	boolean	false	Do not print the Compodoc logo at the bottom of the page.
serve	boolean		Serve generated documentation.
port	number	8080	Port for serving of documentation. (default: 8080)
watch	boolean	false	Watch for source files changes to automatically rebuild documentation.
silent	boolean		Suppress verbose build output.
debug	boolean	false	Show executor logs like compodoc command with arguments and working directory.