This repository has been archived by the owner on Apr 6, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(nuxt)!: use parser to generate page metadata (#8536)
- Loading branch information
Showing
9 changed files
with
185 additions
and
153 deletions.
There are no files selected for viewing
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
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| import { pathToFileURL } from 'node:url' | ||
| import { createUnplugin } from 'unplugin' | ||
| import { parseQuery, parseURL, stringifyQuery } from 'ufo' | ||
| import { findStaticImports, findExports, StaticImport, parseStaticImport } from 'mlly' | ||
| import type { CallExpression, Expression } from 'estree' | ||
| import { walk } from 'estree-walker' | ||
| import MagicString from 'magic-string' | ||
| import { isAbsolute, normalize } from 'pathe' | ||
|
|
||
| export interface PageMetaPluginOptions { | ||
| dirs: Array<string | RegExp> | ||
| dev?: boolean | ||
| sourcemap?: boolean | ||
| } | ||
|
|
||
| export const PageMetaPlugin = createUnplugin((options: PageMetaPluginOptions) => { | ||
| return { | ||
| name: 'nuxt:pages-macros-transform', | ||
| enforce: 'post', | ||
| transformInclude (id) { | ||
| const query = parseMacroQuery(id) | ||
| id = normalize(id) | ||
|
|
||
| const isPagesDir = options.dirs.some(dir => typeof dir === 'string' ? id.startsWith(dir) : dir.test(id)) | ||
| if (!isPagesDir && !query.macro) { return false } | ||
|
|
||
| const { pathname } = parseURL(decodeURIComponent(pathToFileURL(id).href)) | ||
| return /\.(m?[jt]sx?|vue)/.test(pathname) | ||
| }, | ||
| transform (code, id) { | ||
| const query = parseMacroQuery(id) | ||
| if (query.type && query.type !== 'script') { return } | ||
|
|
||
| const s = new MagicString(code) | ||
| function result () { | ||
| if (s.hasChanged()) { | ||
| return { | ||
| code: s.toString(), | ||
| map: options.sourcemap | ||
| ? s.generateMap({ source: id, includeContent: true }) | ||
| : undefined | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const hasMacro = code.match(/\bdefinePageMeta\s*\(\s*/) | ||
|
|
||
| // Remove any references to the macro from our pages | ||
| if (!query.macro) { | ||
| if (hasMacro) { | ||
| walk(this.parse(code, { | ||
| sourceType: 'module', | ||
| ecmaVersion: 'latest' | ||
| }), { | ||
| enter (_node) { | ||
| if (_node.type !== 'CallExpression' || (_node as CallExpression).callee.type !== 'Identifier') { return } | ||
| const node = _node as CallExpression & { start: number, end: number } | ||
| const name = 'name' in node.callee && node.callee.name | ||
| if (name === 'definePageMeta') { | ||
| s.overwrite(node.start, node.end, 'false && {}') | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| return result() | ||
| } | ||
|
|
||
| const imports = findStaticImports(code) | ||
|
|
||
| // [vite] Re-export any script imports | ||
| const scriptImport = imports.find(i => parseMacroQuery(i.specifier).type === 'script') | ||
| if (scriptImport) { | ||
| const specifier = rewriteQuery(scriptImport.specifier) | ||
| s.overwrite(0, code.length, `export { default } from ${JSON.stringify(specifier)}`) | ||
| return result() | ||
| } | ||
|
|
||
| // [webpack] Re-export any exports from script blocks in the components | ||
| const currentExports = findExports(code) | ||
| for (const match of currentExports) { | ||
| if (match.type !== 'default' || !match.specifier) { | ||
| continue | ||
| } | ||
|
|
||
| const specifier = rewriteQuery(match.specifier) | ||
| s.overwrite(0, code.length, `export { default } from ${JSON.stringify(specifier)}`) | ||
| return result() | ||
| } | ||
|
|
||
| if (!hasMacro && !code.includes('export { default }') && !code.includes('__nuxt_page_meta')) { | ||
| s.overwrite(0, code.length, 'export default {}') | ||
| return result() | ||
| } | ||
|
|
||
| const importMap = new Map<string, StaticImport>() | ||
| for (const i of imports) { | ||
| const parsed = parseStaticImport(i) | ||
| for (const name of [ | ||
| parsed.defaultImport, | ||
| ...Object.keys(parsed.namedImports || {}), | ||
| parsed.namespacedImport | ||
| ].filter(Boolean) as string[]) { | ||
| importMap.set(name, i) | ||
| } | ||
| } | ||
|
|
||
| walk(this.parse(code, { | ||
| sourceType: 'module', | ||
| ecmaVersion: 'latest' | ||
| }), { | ||
| enter (_node) { | ||
| if (_node.type !== 'CallExpression' || (_node as CallExpression).callee.type !== 'Identifier') { return } | ||
| const node = _node as CallExpression & { start: number, end: number } | ||
| const name = 'name' in node.callee && node.callee.name | ||
| if (name !== 'definePageMeta') { return } | ||
|
|
||
| const meta = node.arguments[0] as Expression & { start: number, end: number } | ||
|
|
||
| let contents = `const __nuxt_page_meta = ${code!.slice(meta.start, meta.end) || '{}'}\nexport default __nuxt_page_meta` | ||
|
|
||
| walk(meta, { | ||
| enter (_node) { | ||
| if (_node.type === 'CallExpression') { | ||
| const node = _node as CallExpression & { start: number, end: number } | ||
| const name = 'name' in node.callee && node.callee.name | ||
| if (name && importMap.has(name)) { | ||
| contents = importMap.get(name)!.code + '\n' + contents | ||
| } | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| s.overwrite(0, code.length, contents) | ||
| } | ||
| }) | ||
|
|
||
| if (!s.hasChanged() && !code.includes('__nuxt_page_meta')) { | ||
| s.overwrite(0, code.length, 'export default {}') | ||
| } | ||
|
|
||
| return result() | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| // https://github.com/vuejs/vue-loader/pull/1911 | ||
| // https://github.com/vitejs/vite/issues/8473 | ||
| function rewriteQuery (id: string) { | ||
| const query = stringifyQuery({ macro: 'true', ...parseMacroQuery(id) }) | ||
| return id.replace(/\?.+$/, '?' + query) | ||
| } | ||
|
|
||
| function parseMacroQuery (id: string) { | ||
| const { search } = parseURL(decodeURIComponent(isAbsolute(id) ? pathToFileURL(id).href : id).replace(/\?macro=true$/, '')) | ||
| const query = parseQuery(search) | ||
| if (id.includes('?macro=true')) { | ||
| return { macro: 'true', ...query } | ||
| } | ||
| return query | ||
| } |
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.