@codification/cutwater-build-core

@codification/cutwater-build-core

Building on Microsoft's @microsoft/gulp-core-build architecture, this project provides easy methods for building, validating and publishing project documentation.

Installation

Via npm:

npm install @codification/cutwater-build-core

Via yarn:

yarn add @codification/cutwater-build-core

Documentation

• API Documentation

Classes

• BaseExecTask
• BaseTypeDocTask
• BuildUtils
• JestTask
• MarkdownTypeDocTask
• TSLintTask
• TypeDocTask

Interfaces

• JestConfig
• MarkdownTypeDocConfig
• TSLintConfig
• TypeDocConfig

Variables

• tsLintTask
• tscTask

Functions

• defaultConfig
• mdTypeDoc
• registerCiTasks
• typeDoc

---

Variables

<Const> tsLintTask

● tsLintTask: IExecutable = task('tslint', tslintCmd)

Defined in index.ts:43

beta:

---

<Const> tscTask

● tscTask: IExecutable = task('tsc', tscCmd)

Defined in index.ts:39

beta:

---

Functions

<Const> defaultConfig

▸ defaultConfig(packageName?: undefined | string): Partial<TypeDocConfig>

Defined in TypeDocTask.ts:5

Parameters:

Name	Type
Optional packageName	undefined \	string

Returns: Partial<TypeDocConfig>

---

<Const> mdTypeDoc

▸ mdTypeDoc(packageName?: undefined | string, docusaurus?: boolean): MarkdownTypeDocTask

Defined in index.ts:27

Parameters:

Name	Type	Default value
Optional packageName	undefined \	string	-
Default value docusaurus	boolean	false

Returns: MarkdownTypeDocTask

---

<Const> registerCiTasks

▸ registerCiTasks(packageObj: __type): void

Defined in index.ts:57

Registers various tasks for use during common CI usage scenarios using the package name (without the scope, if present) to determine the output location.

• cutwater-ci-docs: Generates Docusaurus style documentation from TypeDoc comments
• cutwater-ci-typedocs: Generates default style documentaiton using TypeDoc
• cutwater-ci-mdtypedocs: Generates documentation from TypeDoc comment in the Markdown format
• cutwater-ci-tslint: Runs TSLint and send output to a junit formatted file
• cutwater-ci-jest: Runs jest unit tests, sending output to a junit formatted file

Parameters:

Name	Type
packageObj	__type

Returns: void

---

<Const> typeDoc

▸ typeDoc(packageName?: undefined | string): TypeDocTask

Defined in index.ts:21

Parameters:

Name	Type
Optional packageName	undefined \	string

Returns: TypeDocTask

---