feat(blog): add onUntruncatedBlogPosts blog options
#10375
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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: -604 B (-0.01%) Total Size: 11.5 MB
ℹ️ View Unchanged
|
slorber
reviewed
Aug 8, 2024
slorber
requested changes
Aug 8, 2024
Comment on lines
50
to
66
| function reportTruncateMarkerProblem({ | ||
| blogSourceRelative, | ||
| truncateMarker, | ||
| options, | ||
| content, | ||
| }: { | ||
| content: string; | ||
| truncateMarker: RegExp; | ||
| blogSourceRelative: string; | ||
| options: Pick<PluginOptions, 'onUntruncatedBlogPost'>; | ||
| }): void { | ||
| if (!truncateMarker.test(content)) { | ||
| logger.report(options.onUntruncatedBlogPost)( | ||
| logger.interpolate`Blog post path=${blogSourceRelative} is not truncated.`, | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
We shouldn't run this Regex against the content twice: this can be expensive and is useless work. We already run it later in the blog post processing to compute the hasTruncateMarker meta attribute.
Note that in the future we'll probably handle that with Remark (the RegExp is the historical solution).
I'd prefer if:
- we emit the warning based on
blogPost.metadata.hasTruncateMarker - we emit a single report for all the blog posts
- we explain in the message that this can be turned off with the blog
onUntruncatedBlogPost: 'ignore'option. Many sites run with untruncated blogs on purpose, let's give them a better upgrading experience if warn is the default.
The function should rather be something like this:
function reportTruncateMarkerProblem({
blogPosts,
onUntruncatedBlogPost,
}: {
blogPosts: BlogPost[],
onUntruncatedBlogPost: PluginOptions['onUntruncatedBlogPost']
}): void {
const untruncatedBlogPosts = blogPosts.filter(p => !p.metadata.hasTruncateMarker)
if (onUntruncatedBlogPost !== "ignore" && onUntruncatedBlogPost.length > 0) {
const message = `Blabla there are untruncated blog posts:
${untruncatedBlogPosts.map(getPath).join('\n- ')}
Blabla additional help`
logger.report(options.onUntruncatedBlogPost)(message);
}
}
slorber
changed the title
onUntruncatedBlogPost blog optionsonUntruncatedBlogPost blog options
slorber
changed the title
onUntruncatedBlogPost blog optionsonUntruncatedBlogPosts blog options
This was referenced Aug 30, 2024
Closed
This was referenced Sep 4, 2024
This was referenced Sep 4, 2024
This was referenced Sep 6, 2024
This was referenced Sep 13, 2024
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.
Motivation
Fix #10289
Using
onUntruncatedBlogPosts: "throw"is useful for blogs that want to ensure a consistent usage of truncation markers.By default, we emit a warning, but it's also possible to throw and fail a build:
The default is quite opinionated so the error message makes it clear how to disable it by using
onUntruncatedBlogPosts: 'ignore'Test Plan
Unit test & ci
Test links
Deploy preview: https://deploy-preview-10375--docusaurus-2.netlify.app/docs/api/plugins/@docusaurus/plugin-content-blog/#onUntruncatedBlogPost