Skip to content

Commit 61ff129

Browse files
twittwertwittwer
committed
docs(compodoc): improve docs for documentation coverage test
1 parent a73c79f commit 61ff129

File tree

3 files changed

+52
-55
lines changed

3 files changed

+52
-55
lines changed

‎packages/compodoc/CHANGELOG.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@ This file was generated using [@jscutlery/semver](https://github.com/jscutlery/s
44

55
# [1.10.0](https://github.com/twittwer/nx-tools/compare/compodoc/v1.9.0...compodoc/v1.10.0) (2023-06-25)
66

7-
87
### Features
98

10-
* upgrade Nx to `16.*` ([e5db16c](https://github.com/twittwer/nx-tools/commit/e5db16c89c433ab496a1e4e47d14d09fe02cda5f))
11-
* upgrade Nx to 16.4.0 ([7a80a08](https://github.com/twittwer/nx-tools/commit/7a80a082bc3fea5331e23f5766713165efa0e6b3))
12-
13-
9+
- upgrade Nx to `16.*` ([e5db16c](https://github.com/twittwer/nx-tools/commit/e5db16c89c433ab496a1e4e47d14d09fe02cda5f))
10+
- upgrade Nx to 16.4.0 ([7a80a08](https://github.com/twittwer/nx-tools/commit/7a80a082bc3fea5331e23f5766713165efa0e6b3))
1411

1512
# [1.9.0](https://github.com/twittwer/nx-tools/compare/compodoc/v1.8.2...compodoc/v1.9.0) (2022-11-23)
1613

‎packages/compodoc/README.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -61,53 +61,53 @@ Additional options (used exclusively by the executor) are indicated by an italic
6161

6262
> For more details you may have a look at the [original Compodoc documentation](https://compodoc.app/guides/options.html) or the [builder's schema.json](./src/builders/compodoc/schema.json)
6363
64-
| Option | Default | Description |
65-
| ------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
66-
| tsConfig | `<projectRoot>/tsconfig.json` | Path to project's tsconfig file. |
67-
| outputPath | `dist/compodoc/<projectName>` | The output path of the generated files. |
68-
| exportFormat | `html` | Format of generated documentation. (html, json - enables Compodoc's `minimal` mode as well) |
69-
| _workspaceDocs_ | `false` | Use readme of workspace root as entry and add the readme files of all project as additional documentation. |
70-
| | | |
71-
| name | `<projectName>` | Title of the documentation. (`workspaceDocs` uses workspace name as default - defined in `package.json`) |
72-
| | | |
73-
| includes | | Path to external markdown files, folder should contain a `summary.json`. (`workspaceDocs` will override this) |
74-
| includesName | | Name of menu item containing external markdown files. (`workspaceDocs` uses "Projects" as default) |
75-
| | | |
76-
| assetsFolder | | External assets folder to copy in generated documentation folder. |
77-
| unitTestCoverage | | Path to unit test coverage in json-summary format. |
78-
| | | |
79-
| disableCoverage | `true` | Do not add the documentation coverage report. |
80-
| disableSourceCode | `false` | Do not add source code tab and links to source code. |
81-
| disableDomTree | `false` | Do not add dom tree tab. |
82-
| disableTemplateTab | `false` | Do not add template tab. |
83-
| disableStyleTab | `false` | Do not add style tab. |
84-
| disableGraph | `false` | Disable rendering of the dependency graph. |
85-
| disablePrivate | `true` | Do not show private in generated documentation. |
86-
| disableProtected | `false` | Do not show protected in generated documentation. |
87-
| disableInternal | `true` | Do not show @internal in generated documentation. |
88-
| disableLifeCycleHooks | `true` | Do not show Angular lifecycle hooks in generated documentation. |
89-
| disableRoutesGraph | `false` | Do not add the routes graph. |
90-
| disableSearch | `false` | Do not add the search input. |
91-
| disableDependencies | `false` | Do not add the dependencies list. |
92-
| | | |
93-
| coverageTest | `0` | Test command of documentation coverage with a threshold. Any value other than 0 disables documentation generation. |
94-
| coverageMinimumPerFile | `0` | Test command of documentation coverage per file with a minimum. |
95-
| coverageTestThresholdFail | `true` | Test command of documentation coverage (global or per file) will fail with error or just warn user (true: error, false: warn). |
96-
| | | |
97-
| language | `en-US` | Language used for generated documentation. |
98-
| theme | `gitbook` | Theme used for generated documentation. |
99-
| extTheme | | Path to external theme file. |
100-
| templates | | Path to directory of Handlebars templates to override built-in templates. |
101-
| customLogo | | Path to custom logo. |
102-
| customFavicon | | Path to custom favicon. |
103-
| hideGenerator | `false` | Do not print the Compodoc logo at the bottom of the page. |
104-
| | | |
105-
| serve | `false` (`true` in watch mode) | Serve generated documentation. (_automatically enabled in watch mode_) |
106-
| port | `8080` | Port for serving of documentation. |
107-
| watch | `false` | Watch for source files changes to automatically rebuild documentation. |
108-
| silent | `true` (`false` in watch/serve mode) | Suppress verbose build output. |
109-
| | | |
110-
| _debug_ | `false` | Log resulting executor options & the final Compodoc command with all arguments. |
64+
| Option | Default | Description |
65+
| ------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
66+
| tsConfig | `<projectRoot>/tsconfig.json` | Path to project's tsconfig file. |
67+
| outputPath | `dist/compodoc/<projectName>` | The output path of the generated files. |
68+
| exportFormat | `html` | Format of generated documentation. (html, json - enables Compodoc's `minimal` mode as well) |
69+
| _workspaceDocs_ | `false` | Use readme of workspace root as entry and add the readme files of all project as additional documentation. |
70+
| | | |
71+
| name | `<projectName>` | Title of the documentation. (`workspaceDocs` uses workspace name as default - defined in `package.json`) |
72+
| | | |
73+
| includes | | Path to external markdown files, folder should contain a `summary.json`. (`workspaceDocs` will override this) |
74+
| includesName | | Name of menu item containing external markdown files. (`workspaceDocs` uses "Projects" as default) |
75+
| | | |
76+
| assetsFolder | | External assets folder to copy in generated documentation folder. |
77+
| unitTestCoverage | | Path to unit test coverage in json-summary format. |
78+
| | | |
79+
| disableCoverage | `true` | Do not add the documentation coverage report. |
80+
| disableSourceCode | `false` | Do not add source code tab and links to source code. |
81+
| disableDomTree | `false` | Do not add dom tree tab. |
82+
| disableTemplateTab | `false` | Do not add template tab. |
83+
| disableStyleTab | `false` | Do not add style tab. |
84+
| disableGraph | `false` | Disable rendering of the dependency graph. |
85+
| disablePrivate | `true` | Do not show private in generated documentation. |
86+
| disableProtected | `false` | Do not show protected in generated documentation. |
87+
| disableInternal | `true` | Do not show @internal in generated documentation. |
88+
| disableLifeCycleHooks | `true` | Do not show Angular lifecycle hooks in generated documentation. |
89+
| disableRoutesGraph | `false` | Do not add the routes graph. |
90+
| disableSearch | `false` | Do not add the search input. |
91+
| disableDependencies | `false` | Do not add the dependencies list. |
92+
| | | |
93+
| coverageTest | `0` | Threshold for global documentation coverage. |
94+
| coverageMinimumPerFile | `0` | Threshold for documentation coverage of each file. |
95+
| coverageTestThresholdFail | `true` | Abort compodoc with an error instead of a warn log, if coverage threshold (global or per file) is not reached (true: error, false: warn). |
96+
| | | |
97+
| language | `en-US` | Language used for generated documentation. |
98+
| theme | `gitbook` | Theme used for generated documentation. |
99+
| extTheme | | Path to external theme file. |
100+
| templates | | Path to directory of Handlebars templates to override built-in templates. |
101+
| customLogo | | Path to custom logo. |
102+
| customFavicon | | Path to custom favicon. |
103+
| hideGenerator | `false` | Do not print the Compodoc logo at the bottom of the page. |
104+
| | | |
105+
| serve | `false` (`true` in watch mode) | Serve generated documentation. (_automatically enabled in watch mode_) |
106+
| port | `8080` | Port for serving of documentation. |
107+
| watch | `false` | Watch for source files changes to automatically rebuild documentation. |
108+
| silent | `true` (`false` in watch/serve mode) | Suppress verbose build output. |
109+
| | | |
110+
| _debug_ | `false` | Log resulting executor options & the final Compodoc command with all arguments. |
111111

112112
> All paths should be relative to workspace root
113113

0 commit comments

Comments
 (0)