fix(core): change SecretLintRuleMessageTranslate to check statically #127
Conversation
This file contains 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
BREAKING CHANGE: It changes SecretLintRuleMessageTranslate interface Rule need to change `messages` object format.
- remove runtime check - add static check
azu
commented
Apr 10, 2020
| "required": [ | ||
| "en" | ||
| ], | ||
| "type": "object" |
azu
commented
Apr 10, 2020
| [P in SecretLintRuleLocaleTag]: SecretLintRuleLocalizeMessageHandler<Props>; | ||
| } & { | ||
| // Workaround for https://github.com/YousefED/typescript-json-schema/issues/110 | ||
| en(props?: Props): string; |
There was a problem hiding this comment.
YousefED/typescript-json-schema#110 does not support function.
It should be ignored.
|
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
BREAKING CHANGE: It changes SecretLintRuleMessageTranslate interface
Each rule need to change
messagesobject format.AWSAccessKeyID: { - en: "found AWS Access Key ID: {{ID}}", - ja: "AWS Access Key Id: {{ID}} がみつかりました" + en: (props: { ID: string }) => `found AWS Access Key ID: ${props.ID}`, + ja: (props: { ID: string }) => `AWS Access Key Id: ${props.ID} がみつかりました`, },It will resolve #119 because, it also remove runtime check for placeholder string.
It introduce static check for template string instead of non-typed placeholder string.
cons:
The message is not be string. message in JSON can not be used any more.
fix #119
fix #124