Add feature to generate Markdown files#1087
Open
jshackell-sfdc wants to merge 19 commits into
Open
Conversation
The markdown.test.ts file expects generated markdown files in test/tmp-md, but the test:only task only depended on test:command-reference (which generates DITA XML). Added test:command-reference-markdown as an additional dependency to ensure markdown test files are generated before tests run.
Added tests to verify: - HTML entity escaping in descriptions - Consistent whitespace normalization - Removal of leading $ from shell examples - Proper markdown table formatting with pipe escaping - State label handling for beta/preview/pilot commands These tests ensure the markdown generator produces consistent, properly formatted output for all command documentation.
HTML comments like <!-- prettier-ignore-start --> are intentional markdown and should not be flagged by the entity escaping test.
soridalac
reviewed
May 29, 2026
| @@ -146,9 +151,13 @@ export default class CommandReferenceGenerate extends SfCommand<CommandReference | |||
| const commands = await this.loadCommands(plugins); | |||
| const topicMetadata = this.loadTopicMetadata(commands); | |||
| const cliMeta = this.loadCliMeta(); | |||
Contributor
There was a problem hiding this comment.
suggest to add validation for output-format flag before docs:
const outputFormat = flags['output-format'];
if (outputFormat !== 'dita' && outputFormat !== 'markdown') {
throw new SfError(`Invalid output format: ${outputFormat}. Must be 'dita' or 'markdown'.`);
}
soridalac
reviewed
May 29, 2026
| const docs = new Docs(Ditamap.outputDir, flags.hidden, topicMetadata, cliMeta); | ||
| const docs = new Docs( | ||
| Ditamap.outputDir, | ||
| flags['output-format'] as 'dita' | 'markdown', |
Contributor
There was a problem hiding this comment.
change this to outputFormat
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.