Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | 1x 1x | import { COMPODOC_DEFAULTS } from '../defaults';
export interface Flag {
label: string;
flag: string;
description: string;
defaultValue?: boolean | string | number | string[];
parsingFunction?: (val: string) => string[];
stringifyDefaultValue?: boolean;
}
function list(val: string): string[] {
return val.split(',');
}
export const PUBLIC_FLAGS: Flag[] = [
{
label: 'assetsFolder',
flag: '-a, --assetsFolder [folder]',
description: 'External assets folder to copy in generated documentation folder',
},
{
label: 'config',
flag: '-c, --config [config]',
description:
'A configuration file : .compodocrc, .compodocrc.json, .compodocrc.yaml or compodoc property in package.json',
},
{
label: 'coverageMinimumPerFile',
flag: '--coverageMinimumPerFile [minimum]',
description: 'Test command of documentation coverage per file with a minimum (default 0)',
},
{
label: 'coverageTest',
flag: '--coverageTest [threshold]',
description: 'Test command of documentation coverage with a threshold (default 70)',
},
{
label: 'coverageTestShowOnlyFailed',
flag: '--coverageTestShowOnlyFailed',
description: 'Display only failed files for a coverage test',
},
{
label: 'coverageTestThresholdFail',
flag: '--coverageTestThresholdFail [true|false]',
description:
'Test command of documentation coverage (global or per file) will fail with error or just warn user (true: error, false: warn)',
defaultValue: COMPODOC_DEFAULTS.coverageTestThresholdFail,
},
{
label: 'customFavicon',
flag: '--customFavicon [path]',
description: 'Use a custom favicon',
},
{
label: 'customLogo',
flag: '--customLogo [path]',
description: 'Use a custom logo',
},
{
label: 'disableCoverage',
flag: '--disableCoverage',
description: 'Do not add the documentation coverage report',
defaultValue: false,
},
{
label: 'disableDependencies',
flag: '--disableDependencies',
description: 'Do not add the dependencies list',
defaultValue: COMPODOC_DEFAULTS.disableDependencies,
},
{
label: 'disableDomTree',
flag: '--disableDomTree',
description: 'Do not add dom tree tab',
defaultValue: false,
},
{
label: 'disableGraph',
flag: '--disableGraph',
description: 'Do not add the dependency graph',
defaultValue: false,
},
{
label: 'disableInternal',
flag: '--disableInternal',
description: 'Do not show @internal in generated documentation',
defaultValue: false,
},
{
label: 'disableLifeCycleHooks',
flag: '--disableLifeCycleHooks',
description: 'Do not show Angular lifecycle hooks in generated documentation',
defaultValue: false,
},
{
label: 'disablePrivate',
flag: '--disablePrivate',
description: 'Do not show private in generated documentation',
defaultValue: false,
},
{
label: 'disableProtected',
flag: '--disableProtected',
description: 'Do not show protected in generated documentation',
defaultValue: false,
},
{
label: 'disableRoutesGraph',
flag: '--disableRoutesGraph',
description: 'Do not add the routes graph',
defaultValue: COMPODOC_DEFAULTS.disableRoutesGraph,
},
{
label: 'disableSearch',
flag: '--disableSearch',
description: 'Do not add the search input',
defaultValue: false,
},
{
label: 'disableSourceCode',
flag: '--disableSourceCode',
description: 'Do not add source code tab and links to source code',
defaultValue: false,
},
{
label: 'disableStyleTab',
flag: '--disableStyleTab',
description: 'Do not add style tab',
defaultValue: false,
},
{
label: 'disableTemplateTab',
flag: '--disableTemplateTab',
description: 'Do not add template tab',
defaultValue: false,
},
{
label: 'exportFormat',
flag: '-e, --exportFormat [format]',
description: 'Export in specified format (json, html)',
defaultValue: COMPODOC_DEFAULTS.exportFormat,
},
{
label: 'extTheme',
flag: '-y, --extTheme [file]',
description: 'External styling theme file',
},
{
label: 'files',
flag: '--files [files]',
description: 'Files provided by external tool, used for coverage test',
},
{
label: 'gaID',
flag: '--gaID [id]',
description: 'Google Analytics tracking ID',
},
{
label: 'gaSite',
flag: '--gaSite [site]',
description: 'Google Analytics site name',
defaultValue: COMPODOC_DEFAULTS.gaSite,
},
{
label: 'hideGenerator',
flag: '--hideGenerator',
description: 'Do not print the Compodoc link at the bottom of the page',
defaultValue: false,
},
{
label: 'host',
flag: '--host [host]',
description: 'Change default host address',
defaultValue: COMPODOC_DEFAULTS.hostname,
},
{
label: 'includes',
flag: '--includes [path]',
description: 'Path of external markdown files to include',
},
{
label: 'includesName',
flag: '--includesName [name]',
description: 'Name of item menu of externals markdown files',
defaultValue: COMPODOC_DEFAULTS.additionalEntryName,
},
{
label: 'language',
flag: '--language [language]',
description:
'Language used for the generated documentation (en-US, de-DE, es-ES, fr-FR, hu-HU, it-IT, ja-JP, nl-NL, pt-BR, zh-CN)',
defaultValue: COMPODOC_DEFAULTS.language,
},
{
label: 'minimal',
flag: '--minimal',
description: 'Minimal mode with only documentation. No search, no graph, no coverage.',
defaultValue: false,
},
{
label: 'name',
flag: '-n, --name [name]',
description: 'Title documentation',
defaultValue: COMPODOC_DEFAULTS.title,
},
{
label: 'navTabConfig',
flag: '--navTabConfig <tab configs>',
description: `List navigation tab objects in the desired order with two string properties ("id" and "label"). \
Double-quotes must be escaped with '\\'. \
Available tab IDs are "info", "readme", "source", "templateData", "styleData", "tree", and "example". \
Note: Certain tabs will only be shown if applicable to a given dependency`,
defaultValue: false,
parsingFunction: list,
stringifyDefaultValue: true,
},
{
label: 'open',
flag: '-o, --open [value]',
description: 'Open the generated documentation',
defaultValue: false,
},
{
label: 'output',
flag: '-d, --output [folder]',
description: 'Where to store the generated documentation',
defaultValue: COMPODOC_DEFAULTS.folder,
},
{
label: 'port',
flag: '-r, --port [port]',
description: 'Change default serving port',
defaultValue: COMPODOC_DEFAULTS.port,
},
{
label: 'serve',
flag: '-s, --serve',
description: 'Serve generated documentation (default http://localhost:8080/)',
defaultValue: false,
},
{
label: 'silent',
flag: '-t, --silent',
description: `In silent mode, log messages aren't logged in the console`,
defaultValue: false,
},
{
label: 'templates',
flag: '--templates [folder]',
description: 'Path to directory of Handlebars templates to override built-in templates',
},
{
label: 'theme',
flag: '--theme [theme]',
description: `Choose one of available themes, default is 'gitbook' (laravel, original, material, postmark, readthedocs, stripe, vagrant)`,
defaultValue: COMPODOC_DEFAULTS.theme,
},
{
label: 'toggleMenuItems',
flag: '--toggleMenuItems <items>',
description: `Close by default items in the menu values : ['all'] or one of these ['modules','components','directives','controllers','classes','injectables','guards','interfaces','interceptors','pipes','miscellaneous','additionalPages']`,
defaultValue: COMPODOC_DEFAULTS.toggleMenuItems,
parsingFunction: list,
},
{
label: 'tsconfig',
flag: '-p, --tsconfig [config]',
description: 'A tsconfig.json file',
},
{
label: 'unitTestCoverage',
flag: '--unitTestCoverage [json-summary]',
description: 'To include unit test coverage, specify istanbul JSON coverage summary file',
},
{
label: 'watch',
flag: '-w, --watch',
description: 'Watch source files after serve and force documentation rebuild',
defaultValue: false,
},
{
label: 'maxSearchResults',
flag: '--maxSearchResults [number]',
description: 'Max search results on the results page. To show all results, set to 0',
defaultValue: 15,
},
];
|