Skip to content

refactor(utils): update template outlets from object to enum #1649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 30, 2025
Merged

refactor(utils): update template outlets from object to enum #1649

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39c4a97
feat(utils)!: refine template outlets to be a enum to improve readabi…
Mister-Hope May 2, 2025
3d31e3c
Merge branch 'main' into template-outlets
Mister-Hope May 8, 2025
1300a96
refactor: use enum instead of const enum
meteorlxy Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions packages/utils/src/ssr/templateRenderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
/**
* HTML outlets of the template renderer
*/
export const TEMPLATE_RENDERER_OUTLETS = {
CONTENT: '<!--vuepress-ssr-content-->',
HEAD: '<!--vuepress-ssr-head-->',
LANG: '{{ lang }}',
PREFETCH: '<!--vuepress-ssr-prefetch-->',
PRELOAD: '<!--vuepress-ssr-preload-->',
SCRIPTS: '<!--vuepress-ssr-scripts-->',
STYLES: '<!--vuepress-ssr-styles-->',
VERSION: '{{ version }}',
export enum TemplateRendererOutlet {
Content = '<!--vuepress-ssr-content-->',
Head = '<!--vuepress-ssr-head-->',
Lang = '{{ lang }}',
Prefetch = '<!--vuepress-ssr-prefetch-->',
Preload = '<!--vuepress-ssr-preload-->',
Scripts = '<!--vuepress-ssr-scripts-->',
Styles = '<!--vuepress-ssr-styles-->',
Version = '{{ version }}',
}

/**
Expand Down Expand Up @@ -76,11 +76,11 @@ export const templateRenderer: TemplateRenderer = (
// notice that some special chars in string like `$&` would be recognized by `replace()`,
// and they won't be html-escaped and will be kept as is when they are inside a code block,
// so we use a replace function as the second param to avoid those potential issues
.replace(TEMPLATE_RENDERER_OUTLETS.CONTENT, () => content)
.replace(TEMPLATE_RENDERER_OUTLETS.HEAD, head)
.replace(TEMPLATE_RENDERER_OUTLETS.LANG, lang)
.replace(TEMPLATE_RENDERER_OUTLETS.PREFETCH, prefetch)
.replace(TEMPLATE_RENDERER_OUTLETS.PRELOAD, preload)
.replace(TEMPLATE_RENDERER_OUTLETS.SCRIPTS, scripts)
.replace(TEMPLATE_RENDERER_OUTLETS.STYLES, styles)
.replace(TEMPLATE_RENDERER_OUTLETS.VERSION, version)
.replace(TemplateRendererOutlet.Content, () => content)
.replace(TemplateRendererOutlet.Head, head)
.replace(TemplateRendererOutlet.Lang, lang)
.replace(TemplateRendererOutlet.Prefetch, prefetch)
.replace(TemplateRendererOutlet.Preload, preload)
.replace(TemplateRendererOutlet.Scripts, scripts)
.replace(TemplateRendererOutlet.Styles, styles)
.replace(TemplateRendererOutlet.Version, version)
Loading