🎨 Simplify WordPress dependency handling (#3202)
This commit is contained in:
@@ -1,133 +1,61 @@
|
|||||||
import resolveConfig from 'tailwindcss/resolveConfig'
|
import resolveConfig from 'tailwindcss/resolveConfig'
|
||||||
import {
|
import { defaultRequestToExternal, defaultRequestToHandle } from '@wordpress/dependency-extraction-webpack-plugin/lib/util'
|
||||||
defaultRequestToExternal,
|
|
||||||
defaultRequestToHandle,
|
|
||||||
} from '@wordpress/dependency-extraction-webpack-plugin/lib/util'
|
|
||||||
import fs from 'fs'
|
import fs from 'fs'
|
||||||
import path from 'path'
|
import path from 'path'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Vite plugin that handles WordPress dependencies and generates a dependency manifest.
|
* WordPress dependency extraction for Vite.
|
||||||
*
|
*
|
||||||
* This plugin:
|
* This plugin configures Vite to exclude WordPress packages from your bundle
|
||||||
* 1. Transforms @wordpress/* imports into global wp.* references
|
* and instead load them from the `window.wp` global. It also generates a
|
||||||
* 2. Tracks WordPress script dependencies
|
* dependency file that is read by Sage's setup.php to enqueue required
|
||||||
* 3. Generates an editor.deps.json file listing all WordPress dependencies
|
* WordPress scripts.
|
||||||
*
|
*
|
||||||
* @returns {import('vite').Plugin} Vite plugin
|
* @returns {import('vite').Plugin}
|
||||||
*/
|
*/
|
||||||
export function wordpressPlugin() {
|
|
||||||
const dependencies = new Set()
|
|
||||||
|
|
||||||
// Helper functions for import handling
|
const externalMap = new Map()
|
||||||
function extractNamedImports(imports) {
|
|
||||||
const match = imports.match(/{([^}]+)}/)
|
|
||||||
if (!match) return []
|
|
||||||
return match[1].split(',').map((s) => s.trim())
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleNamedReplacement(namedImports, external) {
|
|
||||||
return namedImports
|
|
||||||
.map((imports) => {
|
|
||||||
const [name, alias = name] = imports
|
|
||||||
.split(' as ')
|
|
||||||
.map((script) => script.trim())
|
|
||||||
return `const ${alias} = ${external.join('.')}.${name};`
|
|
||||||
})
|
|
||||||
.join('\n')
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleReplacements(imports, external) {
|
|
||||||
const importStr = Array.isArray(imports) ? imports[0] : imports
|
|
||||||
|
|
||||||
if (importStr.includes('{')) {
|
|
||||||
const namedImports = extractNamedImports(importStr)
|
|
||||||
return handleNamedReplacement(namedImports, external)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (importStr.includes('* as')) {
|
|
||||||
const match = importStr.match(/\*\s+as\s+(\w+)/)
|
|
||||||
if (!match) return ''
|
|
||||||
const alias = match[1]
|
|
||||||
return `const ${alias} = ${external.join('.')};`
|
|
||||||
}
|
|
||||||
|
|
||||||
const name = importStr.trim()
|
|
||||||
return `const ${name} = ${external.join('.')};`
|
|
||||||
}
|
|
||||||
|
|
||||||
|
export function extractWordPressDependencies() {
|
||||||
return {
|
return {
|
||||||
name: 'wordpress-plugin',
|
name: 'wordpress-dependencies',
|
||||||
enforce: 'post',
|
config() {
|
||||||
transform(code, id) {
|
return {
|
||||||
if (!id.endsWith('.js')) return
|
build: {
|
||||||
|
rollupOptions: {
|
||||||
const imports = [
|
external(id) {
|
||||||
...(code.match(/^import .+ from ['"]@wordpress\/[^'"]+['"]/gm) || []),
|
const result = defaultRequestToExternal(id)
|
||||||
...(code.match(/^import ['"]@wordpress\/[^'"]+['"]/gm) || []),
|
if (result) {
|
||||||
]
|
externalMap.set(id, result)
|
||||||
|
return true
|
||||||
imports.forEach((statement) => {
|
|
||||||
const match =
|
|
||||||
statement.match(/^import (.+) from ['"]@wordpress\/([^'"]+)['"]/) ||
|
|
||||||
statement.match(/^import ['"]@wordpress\/([^'"]+)['"]/)
|
|
||||||
|
|
||||||
if (!match) return
|
|
||||||
|
|
||||||
const [, imports, pkg] = match
|
|
||||||
if (!pkg) return
|
|
||||||
|
|
||||||
const external = defaultRequestToExternal(`@wordpress/${pkg}`)
|
|
||||||
const handle = defaultRequestToHandle(`@wordpress/${pkg}`)
|
|
||||||
|
|
||||||
if (external && handle) {
|
|
||||||
dependencies.add(handle)
|
|
||||||
const replacement = imports
|
|
||||||
? handleReplacements(imports, external)
|
|
||||||
: `const ${pkg.replace(/-([a-z])/g, (_, letter) => letter.toUpperCase())} = ${external.join('.')};`
|
|
||||||
|
|
||||||
code = code.replace(statement, replacement)
|
|
||||||
}
|
}
|
||||||
})
|
return false
|
||||||
|
|
||||||
return { code, map: null }
|
|
||||||
},
|
},
|
||||||
generateBundle() {
|
output: {
|
||||||
|
globals(id) {
|
||||||
|
const global = externalMap.get(id)
|
||||||
|
return Array.isArray(global) ? global.join('.') : global
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
generateBundle(options, bundle) {
|
||||||
|
const deps = Object.values(bundle)
|
||||||
|
.filter(chunk => chunk.type === 'chunk' && chunk.isEntry)
|
||||||
|
.flatMap(chunk => chunk.imports)
|
||||||
|
.map(defaultRequestToHandle)
|
||||||
|
.filter(Boolean)
|
||||||
|
|
||||||
|
if (deps.length) {
|
||||||
this.emitFile({
|
this.emitFile({
|
||||||
type: 'asset',
|
type: 'asset',
|
||||||
fileName: 'editor.deps.json',
|
fileName: 'editor.deps.json',
|
||||||
source: JSON.stringify([...dependencies]),
|
source: JSON.stringify(deps, null, 2)
|
||||||
})
|
})
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Rollup plugin that configures external WordPress dependencies.
|
|
||||||
*
|
|
||||||
* This plugin:
|
|
||||||
* 1. Marks all @wordpress/* packages as external dependencies
|
|
||||||
* 2. Maps external @wordpress/* imports to wp.* global variables
|
|
||||||
*
|
|
||||||
* This prevents WordPress core libraries from being bundled and ensures
|
|
||||||
* they are loaded from WordPress's global scope instead.
|
|
||||||
*
|
|
||||||
* @returns {import('rollup').Plugin} Rollup plugin
|
|
||||||
*/
|
|
||||||
export function wordpressRollupPlugin() {
|
|
||||||
return {
|
|
||||||
name: 'wordpress-rollup-plugin',
|
|
||||||
options(opts) {
|
|
||||||
opts.external = (id) => id.startsWith('@wordpress/')
|
|
||||||
opts.output = opts.output || {}
|
|
||||||
opts.output.globals = (id) => {
|
|
||||||
if (id.startsWith('@wordpress/')) {
|
|
||||||
const packageName = id.replace('@wordpress/', '')
|
|
||||||
return `wp.${packageName.replace(/-([a-z])/g, (_, letter) => letter.toUpperCase())}`
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return opts
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -146,7 +74,7 @@ export function wordpressRollupPlugin() {
|
|||||||
* @param {boolean} [options.disableTailwindFontSizes=false] - Disable including Tailwind font sizes in theme.json
|
* @param {boolean} [options.disableTailwindFontSizes=false] - Disable including Tailwind font sizes in theme.json
|
||||||
* @returns {import('vite').Plugin} Vite plugin
|
* @returns {import('vite').Plugin} Vite plugin
|
||||||
*/
|
*/
|
||||||
export function wordpressThemeJson({
|
export function processThemeJson({
|
||||||
tailwindConfig,
|
tailwindConfig,
|
||||||
disableTailwindColors = false,
|
disableTailwindColors = false,
|
||||||
disableTailwindFonts = false,
|
disableTailwindFonts = false,
|
||||||
|
|||||||
@@ -1,10 +1,6 @@
|
|||||||
import { defineConfig } from 'vite'
|
import { defineConfig } from 'vite'
|
||||||
import laravel from 'laravel-vite-plugin'
|
import laravel from 'laravel-vite-plugin'
|
||||||
import {
|
import { extractWordPressDependencies, processThemeJson } from './resources/js/build/wordpress'
|
||||||
wordpressPlugin,
|
|
||||||
wordpressRollupPlugin,
|
|
||||||
wordpressThemeJson,
|
|
||||||
} from './resources/js/build/wordpress'
|
|
||||||
import tailwindConfig from './tailwind.config.js'
|
import tailwindConfig from './tailwind.config.js'
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
@@ -18,13 +14,11 @@ export default defineConfig({
|
|||||||
],
|
],
|
||||||
refresh: true,
|
refresh: true,
|
||||||
}),
|
}),
|
||||||
|
extractWordPressDependencies(),
|
||||||
wordpressPlugin(),
|
|
||||||
wordpressRollupPlugin(),
|
|
||||||
|
|
||||||
// Generate the theme.json file in the public/build/assets directory
|
// Generate the theme.json file in the public/build/assets directory
|
||||||
// based on the Tailwind config and the theme.json file from base theme folder
|
// based on the Tailwind config and the theme.json file from base theme folder
|
||||||
wordpressThemeJson({
|
processThemeJson({
|
||||||
tailwindConfig,
|
tailwindConfig,
|
||||||
disableTailwindColors: false,
|
disableTailwindColors: false,
|
||||||
disableTailwindFonts: false,
|
disableTailwindFonts: false,
|
||||||
|
|||||||
Reference in New Issue
Block a user