fix: only warn if langPrefix is changed #2796
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
calculuschild
approved these changes
May 4, 2023
styfle
reviewed
May 5, 2023
src/defaults.js
Outdated
| @@ -9,7 +9,7 @@ export function getDefaults() { | |||
| headerPrefix: '', | |||
| highlight: null, | |||
| hooks: null, | |||
| langPrefix: 'language-', | |||
| langPrefix: null, | |||
There was a problem hiding this comment.
Technically this is semver major because its a breaking change to the public API
import marked from 'marked';
const result = marked.getDefaults();
There was a problem hiding this comment.
Have we considered using (and is it possible to use) empty types instead of null?
Coming at it from someone who doesn't know the architecture and intent, I'd need to search and find what's expected from the argument list, yeah?
There was a problem hiding this comment.
That is true. And any extensions that rely on options.langPrefix could break.
There was a problem hiding this comment.
I changed this PR to only check if langPrefix has changed from it's default value before warning about it.
UziTech
changed the title
styfle
approved these changes
May 6, 2023
github-actions bot
pushed a commit
that referenced
this pull request
May 6, 2023
## [5.0.1](v5.0.0...v5.0.1) (2023-05-06) ### Bug Fixes * only warn if langPrefix is changed ([#2796](#2796)) ([d193694](d193694))
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.
Marked version: 5.0.0
Description
This removes the warning for langPrefix unless it is changed.
The default warnings can be silenced by setting the following options:
Contributor
Committer
In most cases, this should be a different person than the contributor.