Fix frontmatter not live-reloading on header/footer update #1035
Conversation
|
Thanks for your PR @Parcly-Taxel! |
@yamgent I've made the suggested fix. Please review. With the current diff utilities it is impossible to ignore changing content like the one in MarkBind's default footer. I had to change |
test/functional/testUtil/diffHtml.js
Outdated
| @@ -9,7 +9,9 @@ const DiffPrinter = require('./diffPrinter'); | |||
| * @returns {bool} if diff was found | |||
| */ | |||
| const diffHtml = (expected, actual, filePathName) => { | |||
| const diffParts = jsdiff.diffWords(expected, actual); | |||
| // ignore default template's footer | |||
| const timeRegex = /\[Generated by .*? on .*?\]/; | |||
There was a problem hiding this comment.
Could we use an empty footer instead?
This change may cause text explicitly typed by the user that matches the regex to not be detected.
Looks good otherwise 👍
There was a problem hiding this comment.
If that line is not present, five of the tests fail.
There was a problem hiding this comment.
Yes, because {{ timestamp }} is present in the footer, those tests would fail.
You could make the footer empty ( but keep the <footer> tag ) to fix it
There was a problem hiding this comment.
Just noticed src/template/minimal has the same footer/header/navgation.md files too, do update those as well
There was a problem hiding this comment.
@ang-zeyu I only needed to take out one line to make all the tests pass (i.e. the footer remains non-empty). Please re-review.
And by the way, what files am I supposed to change to make the footer empty?
There was a problem hiding this comment.
And by the way, what files am I supposed to change to make the footer empty?
That would be the same footer.md file you already edited, but removing the {{ timestamp }} is fine as well 👍
Do make the changes for the minimal template's files too ( src/template/minimal )
|
@ang-zeyu how about now? |
|
Ok looks good 👍 Do squash your commits As for the commit message |
@ang-zeyu How do I do that? I've made a pull from master during this pull request, so I can't just rewind all the way, right? |
The header, footer and navigation frontmatter for the minimal and default site templates are empty. This causes inconsistent reloading when the frontmatter is changed (#1001). Here we populate said frontmatter.
It should be possible to rename your master branch to something else then rebase on top of it, though that will likely mean this PR has to be closed and a new one opened from the renamed branch. You can link back to this PR for some context if that's the case. This repo practices squash-rebase workflow, so your master branch should track this repo's master; |
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [X] Bug fix
This one-line update fixes #1001 using the suggested fix provided here.
What is the rationale for this request?
This is also my first pull request to this project.
Testing instructions:
See the issue opener on #1001.
Proposed commit message: (wrap lines at 72 characters)
Fix reload inconsistency when updating frontmatter