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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import { ArgumentConfig, IWriteMarkDown, ParseOptions, UsageGuideConfig } from './contracts';
export const replaceBelowDefault = `[//]: ####ts-command-line-args_write-markdown_replaceBelow`;
export const replaceAboveDefault = `[//]: ####ts-command-line-args_write-markdown_replaceAbove`;
export const configImportNameDefault = `usageGuideInfo`;
export const footerReplaceBelowMarker = `[//]: ####ts-command-line-args_generated-by-footer`;
export const argumentConfig: ArgumentConfig<IWriteMarkDown> = {
markdownPath: {
type: String,
alias: 'm',
description:
'The file to write to. Without replacement markers the whole file content will be replaced. Path can be absolute or relative.',
},
replaceBelow: {
type: String,
defaultValue: replaceBelowDefault,
description: `A marker in the file to replace text below.`,
optional: true,
},
replaceAbove: {
type: String,
defaultValue: replaceAboveDefault,
description: `A marker in the file to replace text above.`,
optional: true,
},
jsFile: {
type: String,
alias: 'j',
description: `jsFile to 'require' that has an export with the 'UsageGuideConfig' export. Multiple file can be specified.`,
multiple: true,
},
configImportName: {
type: String,
alias: 'c',
defaultValue: [configImportNameDefault],
description: `Export name of the 'UsageGuideConfig' object. Defaults to '${configImportNameDefault}'. Multiple exports can be specified.`,
multiple: true,
},
verify: {
type: Boolean,
alias: 'v',
description: `Verify the markdown file. Does not update the file but returns a non zero exit code if the markdown file is not correct. Useful for a pre-publish script.`,
},
configFile: {
type: String,
alias: 'f',
optional: true,
description: `Optional config file to load config from. package.json can be used if jsonPath specified as well`,
},
jsonPath: {
type: String,
alias: 'p',
optional: true,
description: `Used in conjunction with 'configFile'. The path within the config file to load the config from. For example: 'configs.writeMarkdown'`,
},
verifyMessage: {
type: String,
optional: true,
description: `Optional message that is printed when markdown verification fails. Use '\\{fileName\\}' to refer to the file being processed.`,
},
removeDoubleBlankLines: {
type: Boolean,
description: 'When replacing content removes any more than a single blank line',
},
skipFooter: {
type: Boolean,
description: `Does not add the 'Markdown Generated by...' footer to the end of the markdown`,
},
help: { type: Boolean, alias: 'h', description: `Show this usage guide.` },
};
export const parseOptions: ParseOptions<IWriteMarkDown> = {
helpArg: 'help',
loadFromFileArg: 'configFile',
loadFromFileJsonPathArg: 'jsonPath',
baseCommand: `write-markdown`,
optionsHeaderLevel: 3,
defaultSectionHeaderLevel: 3,
optionsHeaderText: `write-markdown cli options`,
headerContentSections: [
{
header: 'Markdown Generation',
headerLevel: 2,
content: `A markdown version of the usage guide can be generated and inserted into an existing markdown document.
Markers in the document describe where the content should be inserted, existing content betweeen the markers is overwritten.`,
},
{
content: `{highlight write-markdown -m README.MD -j usageGuideConstants.js}`,
},
],
footerContentSections: [
{
header: 'Default Replacement Markers',
content: `replaceBelow defaults to:
{code '${replaceBelowDefault}'}
replaceAbove defaults to:
{code '${replaceAboveDefault}'}`,
},
{
header: 'String Formatting',
content: `The only chalk modifiers supported when converting to markdown are {highlight bold} and {highlight italic}.
For example:
{code \\{bold bold text\\} \\{italic italic text\\} \\{italic.bold bold italic text\\}}
will be converted to:
{code **boldText** *italic text* ***bold italic text***}`,
},
{
header: 'Additional Modifiers',
content: `Two additional style modifiers have been added that are supported when writing markdown. They are removed when printing to the console.
{code \\{highlight someText\\}}
surrounds the text in backticks:
\`someText\`
and
{code \\{code.typescript function(message: string)\\\\\\{console.log(message);\\\\\\}\\}}
Surrounds the text in triple back ticks (with an optional language specifer, in this case typescript):
\`\`\`typescript
function(message: string)\\{console.log(message);\\}
\`\`\``,
},
],
};
export const usageGuideInfo: UsageGuideConfig<IWriteMarkDown> = {
arguments: argumentConfig,
parseOptions,
};
|