feat($plugin-last-updated): add "$page.lastUpdatedTimestamp" #2843
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
Some plugins depends of
$page.lastUpdated
to get the last updated date of a document, example https://github.com/lorisleiva/vuepress-plugin-seo or https://github.com/ekoeryanto/vuepress-plugin-sitemap.However, due to the changes on the default transformer which adds support for localized date, passing a lang in the frontmatter header (ex:
lang: fr
) returns a string formatted like this04/05/2021 à 23:29:04
which can't be parsed throughnew Date()
, see lorisleiva/vuepress-plugin-seo#9 or https://github.com/ekoeryanto/vuepress-plugin-sitemap/blob/master/index.js#L24.I don't think it's a nice idea to pass a custom transformer which just return the timestamp, because it means people will have to use theme inheritance just for re-formatting a localized date.
Instead, adding a new key
lastUpdatedTimestamp
which now contains the raw timestamp value without any transformation on it, in order to be easily used by other plugins.WDYT?
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Other information: