template.ts 3.7 KB
Newer Older
fxy060608's avatar
fxy060608 已提交
1
import path from 'path'
fxy060608's avatar
fxy060608 已提交
2
import { EmittedAsset } from 'rollup'
fxy060608's avatar
fxy060608 已提交
3
import { LINEFEED } from '@dcloudio/uni-shared'
fxy060608's avatar
fxy060608 已提交
4
import { normalizeMiniProgramFilename } from '../utils'
fxy060608's avatar
fxy060608 已提交
5

fxy060608's avatar
fxy060608 已提交
6
export interface MiniProgramCompilerOptions {
fxy060608's avatar
fxy060608 已提交
7 8 9 10
  /**
   * 需要延迟渲染的组件,通常是某个组件的某个事件会立刻触发,需要延迟到首次 render 之后,比如微信 editor 的 ready 事件,快手 switch 的 change
   */
  lazyElement?: {
fxy060608's avatar
fxy060608 已提交
11
    [name: string]: { name: 'on' | 'bind'; arg: string[] }[]
fxy060608's avatar
fxy060608 已提交
12
  }
fxy060608's avatar
fxy060608 已提交
13
  event?: {
14 15
    key?: boolean
    format?(
fxy060608's avatar
fxy060608 已提交
16 17 18 19
      name: string,
      opts: { isCatch?: boolean; isCapture?: boolean; isComponent?: boolean }
    ): string
  }
fxy060608's avatar
fxy060608 已提交
20 21 22 23 24 25
  class: {
    /**
     * 是否支持绑定 array 类型
     */
    array: boolean
  }
fxy060608's avatar
fxy060608 已提交
26
  slot: {
fxy060608's avatar
fxy060608 已提交
27 28 29 30
    /**
     * 是否支持 $slots.default 访问
     */
    $slots?: boolean
fxy060608's avatar
fxy060608 已提交
31 32 33
    /**
     * 是否支持后备内容
     */
34 35 36 37 38
    fallbackContent?: boolean
    /**
     * 是否支持动态插槽名
     */
    dynamicSlotNames?: boolean
fxy060608's avatar
fxy060608 已提交
39 40 41 42
  }
  filter?: {
    lang: string
  }
fxy060608's avatar
fxy060608 已提交
43
  component?: {
44 45 46 47
    /**
     * 平台自定义组件目录,如 wxcomponents
     */
    dir?: string
fxy060608's avatar
fxy060608 已提交
48 49 50
    /**
     * 自定义组件自定义 hidden 属性用于实现 v-show
     */
fxy060608's avatar
fxy060608 已提交
51 52 53 54 55
    vShow?: string
    /**
     * 父组件 setData 后,子组件的 properties 是否可以同步获取,目前仅 mp-weixin,mp-qq,mp-alipay 支持
     */
    getPropertySync?: boolean
56 57 58 59
    /**
     * 格式化组件名称,比如 wx-btn => weixin-btn (微信不允许以 wx 命名自定义组件)
     */
    normalizeName?: (name: string) => string
fxy060608's avatar
fxy060608 已提交
60
  }
fxy060608's avatar
fxy060608 已提交
61 62 63
  directive: string
  emitFile?: (emittedFile: EmittedAsset) => string
}
fxy060608's avatar
fxy060608 已提交
64 65
export interface MiniProgramFilterOptions {
  id: string
fxy060608's avatar
fxy060608 已提交
66
  type: string
fxy060608's avatar
fxy060608 已提交
67 68 69 70 71
  name: string
  src?: string
  code: string
}

fxy060608's avatar
fxy060608 已提交
72 73 74 75
type GenFilterFn = (
  filter: MiniProgramFilterOptions,
  filename: string
) => string | void
fxy060608's avatar
fxy060608 已提交
76 77

const templateFilesCache = new Map<string, string>()
fxy060608's avatar
fxy060608 已提交
78
const templateFiltersCache = new Map<string, MiniProgramFilterOptions[]>()
fxy060608's avatar
fxy060608 已提交
79

fxy060608's avatar
fxy060608 已提交
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
function relativeFilterFilename(
  filename: string,
  filter: MiniProgramFilterOptions
) {
  if (!filter.src) {
    return ''
  }
  return (
    './' +
    normalizeMiniProgramFilename(
      path.relative(path.dirname(filename), filter.src)
    )
  )
}

fxy060608's avatar
fxy060608 已提交
95 96 97 98 99 100 101
export function findMiniProgramTemplateFiles(genFilter?: GenFilterFn) {
  const files: Record<string, string> = Object.create(null)
  templateFilesCache.forEach((code, filename) => {
    if (!genFilter) {
      files[filename] = code
    } else {
      const filters = getMiniProgramTemplateFilters(filename)
fxy060608's avatar
fxy060608 已提交
102
      if (filters && filters.length) {
fxy060608's avatar
fxy060608 已提交
103
        files[filename] =
fxy060608's avatar
fxy060608 已提交
104 105 106 107 108
          filters
            .map((filter) =>
              genFilter(filter, relativeFilterFilename(filename, filter))
            )
            .join(LINEFEED) +
fxy060608's avatar
fxy060608 已提交
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
          LINEFEED +
          code
      } else {
        files[filename] = code
      }
    }
  })
  return files
}

export function clearMiniProgramTemplateFiles() {
  templateFilesCache.clear()
}

export function addMiniProgramTemplateFile(filename: string, code: string) {
  templateFilesCache.set(filename, code)
}

function getMiniProgramTemplateFilters(filename: string) {
fxy060608's avatar
fxy060608 已提交
128
  return templateFiltersCache.get(filename)
fxy060608's avatar
fxy060608 已提交
129 130 131 132 133 134 135 136 137 138 139 140
}

export function clearMiniProgramTemplateFilter(filename: string) {
  templateFiltersCache.delete(filename)
}

export function addMiniProgramTemplateFilter(
  filename: string,
  filter: MiniProgramFilterOptions
) {
  const filters = templateFiltersCache.get(filename)
  if (filters) {
fxy060608's avatar
fxy060608 已提交
141 142 143 144 145 146
    const filterIndex = filters.findIndex((f) => f.id === filter.id)
    if (filterIndex > -1) {
      filters.splice(filterIndex, 1, filter)
    } else {
      filters.push(filter)
    }
fxy060608's avatar
fxy060608 已提交
147
  } else {
fxy060608's avatar
fxy060608 已提交
148
    templateFiltersCache.set(filename, [filter])
fxy060608's avatar
fxy060608 已提交
149 150
  }
}