@tarojs/service 4.0.0-beta.1 → 4.0.0-beta.10

package/src/platform-plugin-base/platform.ts

@@ -1,75 +0,0 @@
-import { PLATFORM_TYPE } from '@tarojs/shared'
-
-import type { Func, IPluginContext, TConfig } from '../utils/types'
-
-interface IWrapper {
-  init? (): void
-  close? (): void
-}
-
-export class Transaction<T = TaroPlatform> {
-  wrappers: IWrapper[] = []
-
-  async perform (fn: Func, scope: T, ...args: any[]) {
-    this.initAll(scope)
-    await fn.call(scope, ...args)
-    this.closeAll(scope)
-  }
-
-  initAll (scope: T) {
-    const wrappers = this.wrappers
-    wrappers.forEach(wrapper => wrapper.init?.call(scope))
-  }
-
-  closeAll (scope: T) {
-    const wrappers = this.wrappers
-    wrappers.forEach(wrapper => wrapper.close?.call(scope))
-  }
-
-  addWrapper (wrapper: IWrapper) {
-    this.wrappers.push(wrapper)
-  }
-}
-
-export default abstract class TaroPlatform<T extends TConfig = TConfig> {
-  protected ctx: IPluginContext
-  protected config: T
-  protected helper: IPluginContext['helper']
-  protected compiler: string
-
-  abstract platformType: PLATFORM_TYPE
-  abstract platform: string
-  abstract runtimePath: string | string[]
-
-  protected setupTransaction = new Transaction<this>()
-  protected buildTransaction = new Transaction<this>()
-
-  constructor (ctx: IPluginContext, config: T) {
-    this.ctx = ctx
-    this.helper = ctx.helper
-    this.config = config
-    this.updateOutputPath(config)
-    const _compiler = config.compiler
-    this.compiler = typeof _compiler === 'object' ? _compiler.type : _compiler
-  }
-
-  protected emptyOutputDir (excludes: Array<string | RegExp> = []) {
-    const { outputPath } = this.ctx.paths
-    this.helper.emptyDirectory(outputPath, { excludes })
-  }
-
-  /**
-   * 如果分端编译详情 webpack 配置了 output 则需更新 outputPath 位置
-   */
-  private updateOutputPath (config: TConfig) {
-    const platformPath = config.output?.path
-    if (platformPath) {
-      this.ctx.paths.outputPath = platformPath
-    }
-  }
-
-  /**
-   * 调用 runner 开启编译
-   */
-  abstract start(): Promise<void>
-}

package/src/platform-plugin-base/web.ts

@@ -1,136 +0,0 @@
-import { isObject, PLATFORM_TYPE } from '@tarojs/shared'
-import { get, merge } from 'lodash'
-import * as path from 'path'
-
-import { getPkgVersion } from '../utils/package'
-import TaroPlatform from './platform'
-
-import type { TConfig } from '../utils/types'
-
-export abstract class TaroPlatformWeb<T extends TConfig = TConfig> extends TaroPlatform<T> {
-  platformType = PLATFORM_TYPE.WEB
-
-  /**
-   * 1. 清空 dist 文件夹
-   * 2. 输出编译提示
-   */
-  private async setup () {
-    await this.setupTransaction.perform(this.setupWebApp, this)
-    this.ctx.onSetupClose?.(this)
-  }
-
-  private setupWebApp () {
-    const { output } = this.config
-    // webpack5 原生支持 output.clean 选项，但是 webpack4 不支持， 为统一行为，这里做一下兼容
-    // （在 packages/taro-mini-runner/src/webpack/chain.ts 和 packages/taro-webpack-runner/src/utils/chain.ts 的 makeConfig 中对 clean 选项做了过滤）
-    // eslint-disable-next-line eqeqeq
-    if (output == undefined || output.clean == undefined || output.clean === true) {
-      this.emptyOutputDir()
-    } else if (isObject(output.clean)) {
-      this.emptyOutputDir(output.clean.keep || [])
-    }
-    this.printDevelopmentTip()
-  }
-
-  protected printDevelopmentTip () {
-    const tips: string[] = []
-    const config = this.config
-    const { chalk } = this.helper
-
-    if (this.compiler === 'webpack5' && !config.cache?.enable) {
-      tips.push(chalk.yellowBright('建议开启持久化缓存功能，能有效提升二次编译速度，详情请参考: https://docs.taro.zone/docs/config-detail#cache。'))
-    }
-
-    if (tips.length) {
-      console.log(chalk.yellowBright('Tips:'))
-      tips.forEach((item, index) => console.log(`${chalk.yellowBright(index + 1)}. ${item}`))
-      console.log('\n')
-    }
-  }
-
-  /**
-   * 返回当前项目内的 runner 包
-   */
-  protected async getRunner () {
-    const { appPath } = this.ctx.paths
-    const { npm } = this.helper
-
-    let runnerPkg: string
-    switch (this.compiler) {
-      case 'webpack5':
-        runnerPkg = '@tarojs/webpack5-runner'
-        break
-      case 'vite':
-        runnerPkg = '@tarojs/vite-runner'
-        break
-      default:
-        runnerPkg = '@tarojs/webpack-runner'
-    }
-
-    const runner = await npm.getNpmPkg(runnerPkg, appPath)
-
-    return runner.bind(null, appPath)
-  }
-
-  /**
-   * 准备 runner 参数
-   * @param extraOptions 需要额外合入 Options 的配置项
-   */
-  protected getOptions (extraOptions = {}) {
-    const { sourcePath } = this.ctx.paths
-    const { initialConfig } = this.ctx
-    const { port } = this.ctx.runOpts.options
-    const { recursiveMerge, ENTRY, SOURCE_DIR, OUTPUT_DIR } = this.ctx.helper
-    const entryFileName = `${ENTRY}.config`
-    const entryFile = path.basename(entryFileName)
-    const defaultEntry = {
-      [ENTRY]: [path.join(sourcePath, entryFile)]
-    }
-    const customEntry = get(initialConfig, 'h5.entry')
-    const config = recursiveMerge(Object.assign({}, this.config), {
-      entryFileName: ENTRY,
-      env: {
-        FRAMEWORK: JSON.stringify(this.config.framework),
-        TARO_ENV: JSON.stringify(this.platform),
-        TARO_PLATFORM: JSON.stringify(this.platformType),
-        TARO_VERSION: JSON.stringify(getPkgVersion())
-      },
-      devServer: { port },
-      sourceRoot: this.config.sourceRoot || SOURCE_DIR,
-      outputRoot: this.config.outputRoot || OUTPUT_DIR
-    })
-    config.entry = merge(defaultEntry, customEntry)
-
-    return {
-      ...config,
-      buildAdapter: config.platform,
-      platformType: this.platformType,
-      ...extraOptions
-    }
-  }
-
-  /**
-   * 调用 runner 开始编译
-   * @param extraOptions 需要额外传入 runner 的配置项
-   */
-  private async build (extraOptions = {}) {
-    this.ctx.onBuildInit?.(this)
-    await this.buildTransaction.perform(this.buildWebApp, this, extraOptions)
-  }
-
-  private async buildWebApp (extraOptions = {}) {
-    const runner = await this.getRunner()
-    const options = this.getOptions(Object.assign({
-      runtimePath: this.runtimePath,
-    }, extraOptions))
-    await runner(options)
-  }
-
-  /**
-   * 调用 runner 开启编译
-   */
-  public async start () {
-    await this.setup()
-    await this.build()
-  }
-}

package/src/platform-plugin-base/webpack/hmr-plugin.ts

@@ -1,37 +0,0 @@
-export default class TaroMiniHMRPlugin {
-  apply (compiler) {
-    compiler.hooks.thisCompilation.tap('TaroMiniHMRPlugin', compilation => {
-      compilation.hooks.beforeChunkAssets.tap('TaroMiniHMRPlugin', () => {
-        compilation.chunks.forEach(chunk => {
-          if (chunk.hasRuntime() && chunk.name === 'runtime') {
-            const runtimeModules = compilation.chunkGraph.getChunkRuntimeModulesInOrder(chunk)
-            for (const module of runtimeModules) {
-              if (module.name === 'jsonp chunk loading') {
-                const runtimeSource = compilation.codeGenerationResults.getSource(
-                  module,
-                  chunk.runtime,
-                  'runtime'
-                )
-                runtimeSource._value += `
-var miniHMRCallback = function(parentChunkLoadingFunction, data) {
-  var chunkIds = data[0];
-  var moreModules = data[1];
-  if(chunkIds.some(function(id) { return installedChunks[id] === 0 })) {
-    chunkIds.forEach(id => {
-      delete installedChunks[id]
-    })
-    Object.keys(moreModules).forEach(id => {
-      delete __webpack_module_cache__[id]
-    })
-  }
-  if(parentChunkLoadingFunction) parentChunkLoadingFunction(data);
-}
-chunkLoadingGlobal.push = miniHMRCallback.bind(null, chunkLoadingGlobal.push.bind(chunkLoadingGlobal));`
-              }
-            }
-          }
-        })
-      })
-    })
-  }
-}

package/src/utils/constants.ts

@@ -1,21 +0,0 @@
-export const CONFIG_DIR_NAME = 'config'
-export const DEFAULT_CONFIG_FILE = 'index'
-
-export const PRESET_PREFIX = '@tarojs/preset-'
-export const PLUGIN_PREFIX = '@tarojs/plugin-'
-
-export const IS_EVENT_HOOK = /^on/
-export const IS_ADD_HOOK = /^add/
-export const IS_MODIFY_HOOK = /^modify/
-
-export const presetOrPluginPrefixReg = new RegExp(`^${PRESET_PREFIX}|${PLUGIN_PREFIX}`)
-
-export enum PluginType {
-  Preset = 'Preset',
-  Plugin = 'Plugin'
-}
-
-export const PluginNamePrefix = {
-  [PluginType.Preset]: PLUGIN_PREFIX,
-  [PluginType.Plugin]: PLUGIN_PREFIX
-}

package/src/utils/index.ts

@@ -1,118 +0,0 @@
-import { chalk, getModuleDefaultExport } from '@tarojs/helper'
-import { merge } from 'lodash'
-import * as path from 'path'
-import * as resolve from 'resolve'
-
-import { PluginType } from './constants'
-
-import type { PluginItem } from '@tarojs/taro/types/compile'
-import type { IPlugin, IPluginsObject } from './types'
-
-export const isNpmPkg: (name: string) => boolean = name => !(/^(\.|\/)/.test(name))
-
-export function getPluginPath (pluginPath: string) {
-  if (isNpmPkg(pluginPath) || path.isAbsolute(pluginPath)) return pluginPath
-  throw new Error('plugin 和 preset 配置必须为绝对路径或者包名')
-}
-
-export function convertPluginsToObject (items: PluginItem[]): () => IPluginsObject {
-  return () => {
-    const obj: IPluginsObject = {}
-    if (Array.isArray(items)) {
-      items.forEach(item => {
-        if (typeof item === 'string') {
-          const name = getPluginPath(item)
-          obj[name] = null
-        } else if (Array.isArray(item)) {
-          const name = getPluginPath(item[0])
-          obj[name] = item[1]
-        }
-      })
-    }
-    return obj
-  }
-}
-
-export function mergePlugins (dist: PluginItem[], src: PluginItem[]) {
-  return () => {
-    const srcObj = convertPluginsToObject(src)()
-    const distObj = convertPluginsToObject(dist)()
-    return merge(distObj, srcObj)
-  }
-}
-
-// getModuleDefaultExport
-export function resolvePresetsOrPlugins (root: string, args: IPluginsObject, type: PluginType, skipError?: boolean): IPlugin[] {
-  // 全局的插件引入报错，不抛出 Error 影响主流程，而是通过 log 提醒然后把插件 filter 掉，保证主流程不变
-  const resolvedPresetsOrPlugins: IPlugin[] = []
-  const presetsOrPluginsNames = Object.keys(args) || []
-  for ( let i = 0; i < presetsOrPluginsNames.length; i++ ) {
-    const item = presetsOrPluginsNames[i]
-    let fPath
-    try {
-      fPath = resolve.sync(item, {
-        basedir: root,
-        extensions: ['.js', '.ts']
-      })
-    } catch (err) {
-      if (args[item]?.backup) {
-        // 如果项目中没有，可以使用 CLI 中的插件
-        fPath = args[item]?.backup
-      } else if (skipError) {
-        // 如果跳过报错，那么 log 提醒，并且不使用该插件
-        console.log(chalk.yellow(`找不到插件依赖 "${item}"，请先在项目中安装，项目路径：${root}`))
-        continue
-      } else {
-        console.log(chalk.red(`找不到插件依赖 "${item}"，请先在项目中安装，项目路径：${root}`))
-        process.exit(1)
-      }
-    }
-    const resolvedItem = {
-      id: fPath,
-      path: fPath,
-      type,
-      opts: args[item] || {},
-      apply () {
-        try {
-          return getModuleDefaultExport(require(fPath))
-        } catch (error) {
-          console.error(error)
-          // 全局的插件运行报错，不抛出 Error 影响主流程，而是通过 log 提醒然后把插件 filter 掉，保证主流程不变
-          if (skipError) {
-            console.error(`插件依赖 "${item}" 加载失败，请检查插件配置`)
-          } else {
-            throw new Error(`插件依赖 "${item}" 加载失败，请检查插件配置`)
-          }
-        }
-      }
-    }
-    resolvedPresetsOrPlugins.push(resolvedItem)
-  }
-
-  return resolvedPresetsOrPlugins
-}
-
-function supplementBlank (length) {
-  return Array(length).map(() => '').join(' ')
-}
-
-export function printHelpLog (command, optionsList: Map<string, string>, synopsisList?: Set<string>) {
-  console.log(`Usage: taro ${command} [options]`)
-  console.log()
-  console.log('Options:')
-  const keys = Array.from(optionsList.keys())
-  const maxLength = keys.reduce((v1, v2) => {
-    return v1.length > v2.length ? v1 : v2
-  }).length + 3
-  optionsList.forEach((v, k) => {
-    const supplementBlankLength = maxLength - k.length
-    console.log(`  ${k}${supplementBlank(supplementBlankLength)}${v}`)
-  })
-  if (synopsisList && synopsisList.size) {
-    console.log()
-    console.log('Synopsis:')
-    synopsisList.forEach(item => {
-      console.log(`  $ ${item}`)
-    })
-  }
-}

package/src/utils/package.ts

@@ -1,15 +0,0 @@
-/* eslint-disable no-console */
-import * as path from 'path'
-
-export function getRootPath (): string {
-  return path.resolve(__dirname, '../../')
-}
-
-export function getPkgVersion (): string {
-  return require(path.join(getRootPath(), 'package.json')).version
-}
-
-export function printPkgVersion () {
-  console.log(`👽 Taro v${getPkgVersion()}`)
-  console.log()
-}

package/src/utils/types.ts

@@ -1,167 +0,0 @@
-import type helper from '@tarojs/helper'
-import type runnerUtils from '@tarojs/runner-utils'
-import type { IMiniFilesConfig, IProjectConfig } from '@tarojs/taro/types/compile'
-import type { IModifyChainData } from '@tarojs/taro/types/compile/hooks'
-import type joi from 'joi'
-import type Webpack from 'webpack'
-import type Chain from 'webpack-chain'
-import type { PluginType } from './constants'
-
-export interface IPaths {
-  /**
-   * 当前命令执行的目录，如果是 build 命令则为当前项目路径
-   */
-  appPath: string
-  /**
-   * 当前项目配置目录，如果 init 命令，则没有此路径
-   */
-  configPath: string
-  /**
-   * 当前项目源码路径
-   */
-  sourcePath: string
-  /**
-   * 当前项目输出代码路径
-   */
-  outputPath: string
-  /**
-   * 当前项目所用的 node_modules 路径
-   */
-  nodeModulesPath: string
-}
-
-export type Func = (...args: any[]) => any
-
-export type IPluginsObject = Record<string, Record<any, any> | null>
-
-export interface IPlugin {
-  id: string
-  path: string
-  opts: any
-  type: PluginType
-  apply: Func
-}
-
-export type IPreset = IPlugin
-
-export interface IHook {
-  name: string
-  plugin?: string
-  fn: Func
-  before?: string
-  stage?: number
-}
-
-export interface ICommand extends IHook {
-  alias?: string
-  optionsMap?: {
-    [key: string]: string
-  }
-  synopsisList?: string[]
-}
-
-export interface IFileType {
-  templ: string
-  style: string
-  script: string
-  config: string
-}
-
-export interface IPlatform extends IHook {
-  useConfigName?: string
-}
-
-export declare interface IPluginContext {
-  /**
-   * 获取当前所有挂载的插件
-   */
-  plugins: Map<string, IPlugin>
-  /**
-   * 获取当前所有挂载的平台
-   */
-  platforms: Map<string, IPlatform>
-  /**
-   * 包含当前执行命令的相关路径集合
-   */
-  paths: IPaths
-  /**
-   * 获取当前执行命令所带的参数
-   */
-  runOpts: any
-  /**
-   * 为包 @tarojs/helper 的快捷使用方式，包含其所有 API
-   */
-  helper: typeof helper
-  /**
-   * 为包 @tarojs/runner-utils 的快捷使用方式，包含其所有 API
-   */
-  runnerUtils: typeof runnerUtils
-  /**
-   * 项目配置
-   */
-  initialConfig: IProjectConfig
-  /**
-   * 注册一个可供其他插件调用的钩子，接收一个参数，即 Hook 对象
-   */
-  register: (hook: IHook) => void
-  /**
-   * 向 ctx 上挂载一个方法可供其他插件直接调用
-   */
-  registerMethod: (arg: (string | { name: string, fn?: Func }), fn?: Func) => void
-  /**
-   * 注册一个自定义命令
-   */
-  registerCommand: (command: ICommand) => void
-  /**
-   * 注册一个自定义编译平台
-   */
-  registerPlatform: (platform: IPlatform) => void
-  /**
-   * 触发注册的钩子（使用`ctx.register`方法注册的钩子），传入钩子名和钩子所需参数
-   */
-  applyPlugins: (args: string | { name: string, initialVal?: any, opts?: any }) => Promise<any>
-  /**
-   * 为插件添加入参校验
-   */
-  addPluginOptsSchema: (fn: (joi: joi.Root) => void) => void
-  /**
-   * 编译开始
-   */
-  onBuildStart: (fn: Func) => void
-  /**
-   * 编译结束（保存代码每次编译结束后都会触发）
-   */
-  onBuildFinish: (fn: Func) => void
-  /**
-   * 编译完成（启动项目后首次编译结束后会触发一次）
-   */
-  onBuildComplete: (fn: Func) => void
-  /**
-   * 修改编译过程中的页面组件配置
-   */
-  onCompilerMake: (fn: (args: { compilation: Webpack.Compilation, compiler: Webpack.Compiler, plugin: any }) => void) => void
-  /**
-   * 编译中修改 webpack 配置，在这个钩子中，你可以对 webpackChain 作出想要的调整，等同于配置 [`webpackChain`](./config-detail.md#miniwebpackchain)
-   */
-  modifyWebpackChain: (fn: (args: { chain: Chain, webpack: typeof Webpack, data?: IModifyChainData }) => void) => void
-  /**
-   * 编译中修改 vite 配置
-   */
-  modifyViteConfig: (fn: (args: { viteConfig: any, data?: IModifyChainData }) => void) => void
-  /**
-   * 修改编译后的结果
-   */
-  modifyBuildAssets: (fn: (args: { assets: any, miniPlugin: any }) => void) => void
-  /**
-   * 修改编译过程中的页面组件配置
-   */
-  modifyMiniConfigs: (fn: (args: { configMap: IMiniFilesConfig }) => void) => void
-  /**
-   * 修改 Taro 编译配置
-   */
-  modifyRunnerOpts: (fn: (args: { opts: any }) => void) => void
-
-  [key: string]: any
-}
-
-export declare type TConfig = Record<string, any>