vite-plugin-taro 0.0.3 → 0.0.4

package/src/vite/types.ts

@@ -0,0 +1,48 @@
+/** Plain JSON object emitted into Mini Program/Web config payloads. */
+export type JsonObject = Record<string, unknown>
+
+/** Build target handled by this plugin. */
+export type VitePluginTaroTarget = 'wx' | 'h5'
+
+/** Describes one React-backed page shared by WeChat Mini Program and Web builds. */
+export type VitePluginTaroPageOption = {
+    /**
+     * Page route and output path, without file extension.
+     * Example: "pages/index/index" emits pages/index/index.{js,json,wxml,wxss}
+     * for WeChat and becomes the Web router path.
+     */
+    path: string
+
+    /** Page JSON config merged into WeChat JSON and Web route config. */
+    config: JsonObject
+}
+
+/** Required build inputs for the custom Vite/Rolldown Taro renderer plugin. */
+export interface VitePluginTaroOptions {
+    /** Active target for this Vite invocation. */
+    target: VitePluginTaroTarget
+
+    /** Source file that default-exports the root React app component. */
+    app: string
+
+    /** Ordered page list; also becomes app.json.pages and Web route order. */
+    pages: VitePluginTaroPageOption[]
+
+    /** Base app.json content. Its pages field is overwritten from options.pages. */
+    appJson: JsonObject
+
+    /** project.config.json content emitted at the Mini Program root. */
+    projectConfigJson: JsonObject
+
+    /** sitemap.json content emitted at the Mini Program root. */
+    sitemapJson: JsonObject
+}
+
+export type VitePluginTaroBuildContext = {
+    target: VitePluginTaroTarget
+    appComponentImport: string
+    pages: VitePluginTaroPageOption[]
+    appConfig: JsonObject
+    projectConfigJson: JsonObject
+    sitemapJson: JsonObject
+}

package/src/vite/utils.ts

@@ -0,0 +1,35 @@
+import path from 'node:path'
+
+/**
+ * Derives a page component import from a Taro-style page path.
+ *
+ * https://github.com/NervJS/taro/blob/f0e5c39d5f04290db975670411e23c3a396e15f8/packages/taro-webpack5-runner/src/plugins/MiniPlugin.ts#L660-L668
+ * https://github.com/NervJS/taro/blob/f0e5c39d5f04290db975670411e23c3a396e15f8/packages/taro-webpack5-runner/src/utils/app.ts#L74-L90
+ * https://github.com/NervJS/taro/blob/f0e5c39d5f04290db975670411e23c3a396e15f8/packages/taro-loader/src/h5.ts#L12-L21
+ */
+export function createPageComponentImport(pagePath: string): string {
+    return toImportPath(`src/${pagePath}.tsx`)
+}
+
+/**
+ * Converts a local file path into an absolute ESM import path for Vite.
+ */
+export function toImportPath(filePath: string): string {
+    return path.resolve(filePath)
+}
+
+/**
+ * Removes Rollup/Vite's internal virtual-module prefix before ID comparisons.
+ */
+export function stripVirtualPrefix(id: string): string {
+    return id.startsWith('\0') ? id.slice(1) : id
+}
+
+/**
+ * Uses Taro-style slash normalization, plus Vite query-string stripping for module IDs.
+ *
+ * https://github.com/NervJS/taro/blob/f0e5c39d5f04290db975670411e23c3a396e15f8/packages/taro-helper/src/utils.ts#L32-L34
+ */
+export function normalizeModuleId(id: string): string {
+    return id.replace(/\\/g, '/').replace(/\?.*$/, '')
+}

package/src/vite/vite-plugin-taro.ts

@@ -0,0 +1,105 @@
+import type { Plugin, PluginOption, UserConfig } from 'vite'
+import { createVitePluginTaroConditionalDirectivePlugin } from './plugins.ts'
+import { createTailwindcssPlugins } from './tailwindcss.ts'
+import {
+    createH5SupportPlugins,
+    createH5ViteConfig,
+    createWebIndexHtmlTags,
+    isH5VirtualModuleId,
+    loadH5VirtualModule
+} from './targets/h5.ts'
+import {
+    createWxViteConfig,
+    emitWechatAssets,
+    emitWechatImplicitChunksForVirtualApp,
+    isWxVirtualModuleId,
+    loadWxVirtualModule
+} from './targets/wx.ts'
+import type { VitePluginTaroBuildContext, VitePluginTaroOptions } from './types.ts'
+import { stripVirtualPrefix, toImportPath } from './utils.ts'
+
+/**
+ * Creates the Vite/Rolldown plugin that emits either WeChat Mini Program files
+ * or a Taro Web app using the official Taro runtime packages.
+ */
+export default function vitePluginTaro(options: VitePluginTaroOptions): PluginOption[] {
+    const context = createVitePluginTaroBuildContext(options)
+
+    return [
+        createVitePluginTaroConditionalDirectivePlugin(context),
+        ...createTargetSupportPlugins(context),
+        ...createTailwindcssPlugins(context),
+        createVitePluginTaroPlugin(context)
+    ]
+}
+
+function createTargetSupportPlugins(context: VitePluginTaroBuildContext): PluginOption[] {
+    switch (context.target) {
+        case 'h5':
+            return createH5SupportPlugins()
+        default:
+            return []
+    }
+}
+
+/**
+ * Creates the vite-plugin-taro plugin that emits H5 or Wx outputs.
+ */
+function createVitePluginTaroPlugin(context: VitePluginTaroBuildContext): Plugin {
+    return {
+        name: 'vite-plugin-taro',
+        enforce: 'post',
+
+        /** Configures Vite/Rolldown for the active target. */
+        config: {
+            order: 'pre',
+            handler: (): UserConfig => {
+                return context.target === 'wx' ? createWxViteConfig(context) : createH5ViteConfig()
+            }
+        },
+
+        /** Marks generated app/page/component entries as virtual modules. */
+        resolveId(id) {
+            if (isWxVirtualModuleId(id) || isH5VirtualModuleId(id)) return `\0${id}`
+        },
+
+        /** Supplies source code for each virtual entry module. */
+        load(id) {
+            const cleanId = stripVirtualPrefix(id)
+
+            emitWechatImplicitChunksForVirtualApp(this, context, cleanId)
+
+            return loadWxVirtualModule(cleanId, context) ?? loadH5VirtualModule(cleanId, context)
+        },
+
+        /** Injects the generated Web entry into the app shell before Vite scans HTML imports. */
+        transformIndexHtml: {
+            order: 'pre',
+            handler() {
+                return createWebIndexHtmlTags(context)
+            }
+        },
+
+        /** Emits the WeChat JSON/WXML/WXS/WXSS files that are not JS bundle chunks. */
+        generateBundle(_, bundle) {
+            emitWechatAssets(this, bundle, context)
+        }
+    }
+}
+
+/**
+ * Normalizes user options into the shared data used by both target builders.
+ */
+function createVitePluginTaroBuildContext(options: VitePluginTaroOptions): VitePluginTaroBuildContext {
+    return {
+        target: options.target,
+        appComponentImport: toImportPath(options.app),
+        pages: options.pages,
+        appConfig: {
+            ...options.appJson,
+            pages: options.pages.map((page) => page.path)
+        },
+        projectConfigJson: options.projectConfigJson,
+        sitemapJson: options.sitemapJson
+    }
+}

package/src/vite.ts

@@ -0,0 +1,2 @@
+export type { VitePluginTaroOptions, VitePluginTaroPageOption, VitePluginTaroTarget } from './vite/types.ts'
+export { default } from './vite/vite-plugin-taro.ts'

package/client.d.ts

@@ -1,10 +0,0 @@
-declare module 'virtual:taro' {
-    import Taro = require('@tarojs/taro')
-
-    const taro: typeof Taro
-    export default taro
-}
-
-declare module 'virtual:taro/components' {
-    export * from '@tarojs/components'
-}

package/dist/vite/virtual.js

@@ -1,26 +0,0 @@
-import { nodeRequire } from './constants.js';
-import { normalizeModuleId } from './utils.js';
-const virtualTaroId = 'virtual:taro';
-const virtualTaroComponentsId = 'virtual:taro/components';
-export function isPublicVirtualModuleId(id) {
-    return id === virtualTaroId || id === virtualTaroComponentsId;
-}
-export function loadPublicVirtualModule(id, context) {
-    if (id === virtualTaroId)
-        return createVirtualTaroModule(context);
-    if (id === virtualTaroComponentsId)
-        return "export * from '@tarojs/components'\n";
-}
-function createVirtualTaroModule(context) {
-    if (context.target === 'h5') {
-        return "export * from '@tarojs/taro'\nexport { default } from '@tarojs/taro'\n";
-    }
-    const taroPath = createResolvedImport('@tarojs/taro');
-    return `import Taro from ${taroPath}
-
-export default Taro
-`;
-}
-function createResolvedImport(id) {
-    return JSON.stringify(normalizeModuleId(nodeRequire.resolve(id)));
-}