| 14 | } |
| 15 | |
| 16 | export function defineCliFlags(program: Command): Command { |
| 17 | const cli = program as any; |
| 18 | |
| 19 | return cli |
| 20 | .version(pkg.version) |
| 21 | .usage('<src> [options]') |
| 22 | .option( |
| 23 | '-c, --config [config]', |
| 24 | 'A configuration file : .compodocrc, .compodocrc.json, .compodocrc.yaml or compodoc property in package.json' |
| 25 | ) |
| 26 | .option('-p, --tsconfig [config]', 'A tsconfig.json file') |
| 27 | .option( |
| 28 | '-d, --output [folder]', |
| 29 | 'Where to store the generated documentation', |
| 30 | COMPODOC_DEFAULTS.folder |
| 31 | ) |
| 32 | .option('-y, --extTheme [file]', 'External styling theme file') |
| 33 | .option('-n, --name [name]', 'Title documentation', COMPODOC_DEFAULTS.title) |
| 34 | .option( |
| 35 | '-a, --assetsFolder [folder]', |
| 36 | 'External assets folder to copy in generated documentation folder' |
| 37 | ) |
| 38 | .option('-o, --open [value]', 'Open the generated documentation') |
| 39 | .option( |
| 40 | '-t, --silent', |
| 41 | "In silent mode, log messages aren't logged in the console", |
| 42 | COMPODOC_DEFAULTS.silent |
| 43 | ) |
| 44 | .option( |
| 45 | '-s, --serve', |
| 46 | 'Serve generated documentation (default http://localhost:8080/)', |
| 47 | COMPODOC_DEFAULTS.serve |
| 48 | ) |
| 49 | .option('--host [host]', 'Change default host address') |
| 50 | .option('-r, --port [port]', 'Change default serving port', COMPODOC_DEFAULTS.port) |
| 51 | .option( |
| 52 | '-w, --watch', |
| 53 | 'Watch source files after serve and force documentation rebuild', |
| 54 | COMPODOC_DEFAULTS.watch |
| 55 | ) |
| 56 | .option( |
| 57 | '-e, --exportFormat [format]', |
| 58 | 'Export in specified format (json, html)', |
| 59 | COMPODOC_DEFAULTS.exportFormat |
| 60 | ) |
| 61 | .option( |
| 62 | '--files [files]', |
| 63 | 'Files provided by external tool, used for coverage test', |
| 64 | collectFlagValues |
| 65 | ) |
| 66 | .option( |
| 67 | '--language [language]', |
| 68 | 'Language used for the generated documentation (bg-BG, de-DE, en-US, es-ES, fr-FR, hu-HU, it-IT, ja-JP, ka-GE, ko-KR, nl-NL, pl-PL, pt-BR, ru-RU, sk-SK, zh-CN, zh-TW)', |
| 69 | COMPODOC_DEFAULTS.language |
| 70 | ) |
| 71 | .option( |
| 72 | '--theme [theme]', |
| 73 | "Choose one of available themes, default is 'gitbook' (laravel, original, material, postmark, readthedocs, stripe, vagrant)" |