fix(cli): support dashed formats in --output.<format>#2968
Open
slegarraga wants to merge 1 commit into
Open
Conversation
yargs camel-cases dotted keys, so `--output.github-actions` became `githubActions` (and could duplicate the original key), no longer matching the dashed `--format` name. A coerce on `output` re-keys the object by the canonical format names so dashed formats line up with `--format`. Closes stoplightio#2926
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
1 participant
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.
Summary
--output.github-actions/--output.code-climatedid not work, even though the docs show--output.<format>. Fixes #2926.Root cause
yargs camel-cases dotted keys, so
--output.github-actions <file>is parsed asoutput.githubActions(and may keep the originalgithub-actionskey too). The validation then compares theoutputkeys against the--formatvalues, which use the dashed names, producing either:The number of outputs must match the number of formats(duplicate key), orMissing outputs for the following formats: github-actions, code-climate(camel-cased key).Fix
Add a
coerceto theoutputoption that re-keys the object by the canonical format names, taking the value from either the dashed or the camel-cased key. Dashed formats now line up with--format.Test
Added a test in
lint.test.ts:asserts
writeOutputis called withga.txtandcc.json. Full suite: 21 passed.