pages.js 13.7 KB
Newer Older
fxy060608's avatar
fxy060608 已提交
1 2 3 4 5
const fs = require('fs')
const path = require('path')

const {
  removeExt,
fxy060608's avatar
fxy060608 已提交
6 7 8
  normalizePath,
  camelize,
  capitalize
fxy060608's avatar
fxy060608 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
} = require('./util')

const {
  getJson,
  parseJson
} = require('./json')

let mainEntry = ''
let nvueMainEntry = ''

function getMainEntry () {
  if (!mainEntry) {
    mainEntry = fs.existsSync(path.resolve(process.env.UNI_INPUT_DIR, 'main.ts')) ? 'main.ts' : 'main.js'
  }
  return mainEntry
}

function getNVueMainEntry () {
  if (!nvueMainEntry) {
    nvueMainEntry = fs.existsSync(path.resolve(process.env.UNI_INPUT_DIR, 'main.js')) ? 'main.js' : '.main.js'
    if (nvueMainEntry === '.main.js') {
      fs.writeFileSync(path.resolve(process.env.UNI_INPUT_DIR, '.main.js'), '')
    }
  }
  return nvueMainEntry
}

function getPagesJson () {
  return processPagesJson(getJson('pages.json', true))
}

fxy060608's avatar
fxy060608 已提交
40 41
function parsePagesJson (content, loader) {
  return processPagesJson(parseJson(content, true), loader)
fxy060608's avatar
fxy060608 已提交
42 43 44 45 46 47 48 49 50 51 52
}

function filterPages (pages = [], root) {
  for (let i = pages.length - 1; i >= 0; i--) {
    const page = pages[i]
    if (!isValidPage(page, root)) {
      pages.splice(i, 1)
    }
  }
}

fxy060608's avatar
fxy060608 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
const pagesJsonJsFileName = 'pages.js'

function processPagesJson (pagesJson, loader = {
  addDependency: function () {}
}) {
  const pagesJsonJsPath = path.resolve(process.env.UNI_INPUT_DIR, pagesJsonJsFileName)
  if (fs.existsSync(pagesJsonJsPath)) {
    delete require.cache[pagesJsonJsPath]
    const pagesJsonJsFn = require(pagesJsonJsPath)
    if (typeof pagesJsonJsFn === 'function') {
      pagesJson = pagesJsonJsFn(pagesJson, loader)
      if (!pagesJson) {
        console.error(`${pagesJsonJsFileName}  必须返回一个 json 对象`)
      }
    } else {
      console.error(`${pagesJsonJsFileName} 必须导出 function`)
    }
  }

fxy060608's avatar
fxy060608 已提交
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
  let uniNVueEntryPagePath
  if (pagesJson.pages && pagesJson.pages.length) { // 如果首页是 nvue
    if (isNVuePage(pagesJson.pages[0])) {
      uniNVueEntryPagePath = pagesJson.pages[0].path
    }
  }
  // pages
  filterPages(pagesJson.pages)
  // subPackages
  if (Array.isArray(pagesJson.subPackages) && pagesJson.subPackages.length) {
    pagesJson.subPackages.forEach(subPackage => {
      filterPages(subPackage.pages, subPackage.root)
    })
  }

fxy060608's avatar
fxy060608 已提交
87
  if (uniNVuePages.length) { // 直接挂在 pagesJson 上
fxy060608's avatar
fxy060608 已提交
88
    pagesJson.nvue = {
fxy060608's avatar
fxy060608 已提交
89
      pages: uniNVuePages.reverse()
fxy060608's avatar
fxy060608 已提交
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
    }
    if (uniNVueEntryPagePath) {
      pagesJson.nvue.entryPagePath = uniNVueEntryPagePath
    }
  }
  return pagesJson
}

function isNVuePage (page, root = '') {
  if (process.env.UNI_PLATFORM === 'app-plus') {
    const pagePath = path.join(root, page.path)
    if (fs.existsSync(path.resolve(process.env.UNI_INPUT_DIR, pagePath + '.nvue'))) { // cache一下结果?如果文件被删除,cache 就会出现错误
      return true
    }
  }
  return false
}

function isValidPage (page, root = '') {
fxy060608's avatar
fxy060608 已提交
109
  if (typeof page === 'string') { // 不合法的配置
fxy060608's avatar
fxy060608 已提交
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    console.warn(`${page} 配置错误, 已被忽略, 查看文档: https://uniapp.dcloud.io/collocation/pages?id=pages`)
    return false
  }
  let pagePath = page.path

  if (pagePath.indexOf('platforms') === 0) { // 平台相关
    if (pagePath.indexOf('platforms/' + process.env.UNI_PLATFORM) === -1) { // 非本平台
      return false
    }
  }

  if (
    process.env.UNI_PLATFORM === 'app-plus' &&
    page.style
  ) {
fxy060608's avatar
fxy060608 已提交
125
    const subNVues = page.style.subNVues || (page.style['app-plus'] && page.style['app-plus'].subNVues)
fxy060608's avatar
fxy060608 已提交
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
    if (Array.isArray(subNVues)) {
      subNVues.forEach(subNVue => {
        let subNVuePath = subNVue.path
        if (subNVuePath) {
          subNVuePath = subNVue.path.split('?')[0]
          const subNVuePagePath = removeExt(path.join(root, subNVuePath))
          process.UNI_NVUE_ENTRY[subNVuePagePath] = getNVueMainJsPath(subNVuePagePath)
        }
      })
    }
  } else {
    page.style && (delete page.style.subNVues)
  }

  if (isNVuePage(page, root)) {
    // 存储 nvue 相关信息
    pagePath = normalizePath(path.join(root, pagePath))

    process.UNI_NVUE_ENTRY[pagePath] = getNVueMainJsPath(pagePath)

fxy060608's avatar
fxy060608 已提交
146
    if (process.env.UNI_USING_V3 || process.env.UNI_USING_V3_NATIVE) { // 不移除
fxy060608's avatar
fxy060608 已提交
147 148 149 150
      page.nvue = true
      return true
    } else {
      uniNVuePages.push({
fxy060608's avatar
fxy060608 已提交
151 152
        path: pagePath + '.html',
        style: page.style || {}
fxy060608's avatar
fxy060608 已提交
153 154 155
      })
      return false
    }
fxy060608's avatar
fxy060608 已提交
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  }

  return true
}

function getMainJsPath (page) {
  return path.resolve(process.env.UNI_INPUT_DIR, getMainEntry() + '?' + JSON.stringify({
    page: encodeURIComponent(page)
  }))
}

function getNVueMainJsPath (page) {
  return path.resolve(process.env.UNI_INPUT_DIR, getNVueMainEntry() + '?' + JSON.stringify({
    page: encodeURIComponent(page)
  }))
}

process.UNI_ENTRY = {}
process.UNI_NVUE_ENTRY = {}

fxy060608's avatar
fxy060608 已提交
176
const uniNVuePages = []
fxy060608's avatar
fxy060608 已提交
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200

function parsePages (pagesJson, pageCallback, subPageCallback) {
  if (!pagesJson) {
    pagesJson = getPagesJson()
  }

  // pages
  pagesJson.pages.forEach(page => {
    pageCallback && pageCallback(page)
  })
  // subPackages
  if (Array.isArray(pagesJson.subPackages) && pagesJson.subPackages.length) {
    pagesJson.subPackages.forEach((subPackage) => {
      const {
        root,
        pages
      } = subPackage
      pages.forEach(page => {
        root && subPageCallback && subPageCallback(root, page, subPackage)
      })
    })
  }
}

fxy060608's avatar
fxy060608 已提交
201
function parseEntry (pagesJson) {
fxy060608's avatar
fxy060608 已提交
202 203 204 205 206 207 208 209
  process.UNI_ENTRY = {
    'common/main': path.resolve(process.env.UNI_INPUT_DIR, getMainEntry())
  }

  process.UNI_SUB_PACKAGES_ROOT = {}

  process.UNI_NVUE_ENTRY = {}

fxy060608's avatar
fxy060608 已提交
210
  if (process.env.UNI_USING_NATIVE || process.env.UNI_USING_V3_NATIVE) {
fxy060608's avatar
fxy060608 已提交
211 212 213 214
    process.UNI_NVUE_ENTRY['app-config'] = path.resolve(process.env.UNI_INPUT_DIR, 'pages.json')
    process.UNI_NVUE_ENTRY['app-service'] = path.resolve(process.env.UNI_INPUT_DIR, getMainEntry())
  }

fxy060608's avatar
fxy060608 已提交
215
  uniNVuePages.length = 0
fxy060608's avatar
fxy060608 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

  if (!pagesJson) {
    pagesJson = getPagesJson() // 会检测修改 nvue entry
  }

  // pages
  pagesJson.pages.forEach(page => {
    process.UNI_ENTRY[page.path] = getMainJsPath(page.path)
  })
  // subPackages
  if (Array.isArray(pagesJson.subPackages) && pagesJson.subPackages.length) {
    pagesJson.subPackages.forEach(({
      root,
      pages
    }) => {
      Array.isArray(pages) && pages.forEach(page => {
        if (root) {
          const pagePath = normalizePath(path.join(root, page.path))
          process.UNI_ENTRY[pagePath] = getMainJsPath(pagePath)
          process.UNI_SUB_PACKAGES_ROOT[pagePath] = root
        }
      })
    })
  }
}

fxy060608's avatar
fxy060608 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
function parseUsingComponents (usingComponents = {}) {
  const components = []
  Object.keys(usingComponents).forEach(name => {
    const identifier = capitalize(camelize(name))
    let source = usingComponents[name]
    if (source.indexOf('/') === 0) { // 绝对路径
      source = '@' + source
    } else if (source.indexOf('.') !== 0) { // 相对路径
      source = './' + source
    }
    components.push({
      name,
      identifier,
      source
    })
  })
  return components
}

function generateUsingComponentsCode (usingComponents) {
  const components = parseUsingComponents(usingComponents)
  const importCode = []
  const componentsCode = []
  components.forEach(({
    name,
    identifier,
    source
  }) => {
    importCode.push(`import ${identifier} from '${source}.vue'`)
    componentsCode.push(`'${name}':${identifier}`)
  })
  if (!importCode.length) {
    return ''
  }
fxy060608's avatar
fxy060608 已提交
276
  return `;${importCode.join(';')};exports.default.components=Object.assign({${componentsCode.join(',')}},exports.default.components||{});`
fxy060608's avatar
fxy060608 已提交
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
}

function generateGlobalUsingComponentsCode (usingComponents) {
  const components = parseUsingComponents(usingComponents)
  const importCode = []
  const componentsCode = []
  components.forEach(({
    name,
    identifier,
    source
  }) => {
    importCode.push(`import ${identifier} from '${source}.vue'`)
    componentsCode.push(`Vue.component('${name}',${identifier})`)
  })
  if (!importCode.length) {
    return ''
  }
  return `${importCode.join(';')};${componentsCode.join(';')};`
}

function getGlobalUsingComponentsCode () {
  const pagesJson = getPagesJson()
  const usingComponents = pagesJson.globalStyle && pagesJson.globalStyle.usingComponents
  if (!usingComponents) {
    return ''
  }
  return generateGlobalUsingComponentsCode(usingComponents)
fxy060608's avatar
fxy060608 已提交
304
}
fxy060608's avatar
fxy060608 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320

function getUsingComponentsCode (pagePath) {
  const usingComponents = usingComponentsPages[pagePath]
  if (!usingComponents) {
    return ''
  }
  return generateUsingComponentsCode(usingComponents)
}

const usingComponentsPages = Object.create(null)

function addPageUsingComponents (pagePath, usingComponents) {
  if (usingComponents && Object.keys(usingComponents).length) {
    usingComponentsPages[pagePath] = usingComponents
  }
}
fxy060608's avatar
fxy060608 已提交
321 322 323
// 存储自动组件
const autoComponentMap = {}

324 325
let lastUsingAutoImportComponentsJson = ''

fxy060608's avatar
fxy060608 已提交
326 327 328 329
let uniAutoImportComponents = []

let uniAutoImportScanComponents = []

fxy060608's avatar
fxy060608 已提交
330 331
let uniQuickAppAutoImportScanComponents = false

fxy060608's avatar
fxy060608 已提交
332 333
const isDirectory = source => fs.lstatSync(source).isDirectory()

fxy060608's avatar
fxy060608 已提交
334
function getAutoComponentsByDir (componentsPath, absolute = false) {
fxy060608's avatar
fxy060608 已提交
335 336
  const components = {}
  try {
fxy060608's avatar
fxy060608 已提交
337
    fs.existsSync(componentsPath) && fs.readdirSync(componentsPath).forEach(name => {
fxy060608's avatar
fxy060608 已提交
338
      const folder = path.resolve(componentsPath, name)
fxy060608's avatar
fxy060608 已提交
339 340 341
      if (!isDirectory(folder)) {
        return
      }
fxy060608's avatar
fxy060608 已提交
342
      const importDir = absolute ? normalizePath(folder) : `@/components/${name}`
fxy060608's avatar
fxy060608 已提交
343 344 345
      // 读取文件夹文件列表,比对文件名(fs.existsSync在大小写不敏感的系统会匹配不准确)
      const files = fs.readdirSync(folder)
      if (files.includes(name + '.vue')) {
fxy060608's avatar
fxy060608 已提交
346
        components[`^${name}$`] = `${importDir}/${name}.vue`
fxy060608's avatar
fxy060608 已提交
347
      } else if (files.includes(name + '.nvue')) {
fxy060608's avatar
fxy060608 已提交
348
        components[`^${name}$`] = `${importDir}/${name}.nvue`
fxy060608's avatar
fxy060608 已提交
349 350
      }
    })
fxy060608's avatar
fxy060608 已提交
351 352 353
  } catch (e) {
    console.log(e)
  }
fxy060608's avatar
fxy060608 已提交
354 355
  return components
}
fxy060608's avatar
fxy060608 已提交
356

fxy060608's avatar
fxy060608 已提交
357 358 359 360 361
function initAutoImportScanComponents () {
  const componentsPath = path.resolve(process.env.UNI_INPUT_DIR, 'components')

  const components = getAutoComponentsByDir(componentsPath)

fxy060608's avatar
fxy060608 已提交
362
  if (process.env.UNI_PLATFORM === 'quickapp-vue') {
fxy060608's avatar
fxy060608 已提交
363 364
    if (!uniQuickAppAutoImportScanComponents) {
      uniQuickAppAutoImportScanComponents = getAutoComponentsByDir(
fxy060608's avatar
fxy060608 已提交
365
        path.resolve(require.resolve('@dcloudio/uni-quickapp-vue'), '../../components'),
fxy060608's avatar
fxy060608 已提交
366 367 368 369 370 371
        true
      )
    }
    // 平台内置组件优先级高
    Object.assign(components, uniQuickAppAutoImportScanComponents)
  }
372

fxy060608's avatar
fxy060608 已提交
373
  uniAutoImportScanComponents = parseUsingAutoImportComponents(components)
fxy060608's avatar
fxy060608 已提交
374 375
  refreshAutoComponentMap()
}
376

377 378 379 380 381 382 383 384 385 386 387
const _toString = Object.prototype.toString

function isPlainObject (obj) {
  return _toString.call(obj) === '[object Object]'
}

function initAutoImportComponents (easycom = {}) {
  let usingAutoImportComponents = easycom.custom || easycom || {}
  if (!isPlainObject(usingAutoImportComponents)) {
    usingAutoImportComponents = {}
  }
388 389
  // 目前仅 mp-weixin 内置支持 page-meta 等组件
  if (process.env.UNI_PLATFORM !== 'mp-weixin') {
fxy060608's avatar
fxy060608 已提交
390 391
    if (!usingAutoImportComponents['^page-meta$']) {
      usingAutoImportComponents['^page-meta$'] =
392 393
        '@dcloudio/uni-cli-shared/components/page-meta.vue'
    }
fxy060608's avatar
fxy060608 已提交
394 395
    if (!usingAutoImportComponents['^navigation-bar$']) {
      usingAutoImportComponents['^navigation-bar$'] =
396 397 398 399
        '@dcloudio/uni-cli-shared/components/navigation-bar.vue'
    }
  }

400 401 402
  const newUsingAutoImportComponentsJson = JSON.stringify(usingAutoImportComponents)
  if (newUsingAutoImportComponentsJson !== lastUsingAutoImportComponentsJson) {
    lastUsingAutoImportComponentsJson = newUsingAutoImportComponentsJson
fxy060608's avatar
fxy060608 已提交
403
    uniAutoImportComponents = parseUsingAutoImportComponents(usingAutoImportComponents)
404 405 406 407
    refreshAutoComponentMap()
  }
}

408 409 410 411 412 413 414 415 416
/**
 * UNI_AUTO_COMPONENTS 被更新,重新刷新 map
 */
function refreshAutoComponentMap () {
  Object.keys(autoComponentMap).forEach(name => {
    addAutoComponent(name)
  })
}

fxy060608's avatar
fxy060608 已提交
417
function addAutoComponent (name) {
fxy060608's avatar
fxy060608 已提交
418 419 420 421
  let opt = uniAutoImportComponents.find(opt => opt.pattern.test(name))
  if (!opt) {
    opt = uniAutoImportScanComponents.find(opt => opt.pattern.test(name))
  }
fxy060608's avatar
fxy060608 已提交
422 423 424 425 426 427
  if (!opt) { // 不匹配
    return (autoComponentMap[name] = true) // cache
  }
  return (autoComponentMap[name] = {
    name,
    identifier: capitalize(camelize(name + '-auto-import')),
fxy060608's avatar
fxy060608 已提交
428
    source: name.replace(opt.pattern, opt.replacement)
fxy060608's avatar
fxy060608 已提交
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
  })
}

function getAutoComponents (autoComponents) {
  const components = []
  autoComponents.forEach(name => {
    let autoComponent = autoComponentMap[name]
    if (!autoComponent) {
      autoComponent = addAutoComponent(name)
    }
    if (autoComponent !== true) {
      components.push(autoComponent)
    }
  })
  return components
}
fxy060608's avatar
fxy060608 已提交
445

446 447 448 449
function parseUsingAutoImportComponents (usingAutoImportComponents) {
  const autoImportComponents = []
  if (usingAutoImportComponents) {
    Object.keys(usingAutoImportComponents).forEach(pattern => {
450 451 452 453 454 455 456
      const replacement = usingAutoImportComponents[pattern]
      if (replacement && typeof replacement === 'string') {
        autoImportComponents.push({
          pattern: new RegExp(pattern),
          replacement: replacement
        })
      }
457 458 459 460
    })
  }
  return autoImportComponents
}
fxy060608's avatar
fxy060608 已提交
461 462 463 464 465 466
module.exports = {
  getMainEntry,
  getNVueMainEntry,
  parsePages,
  parseEntry,
  getPagesJson,
fxy060608's avatar
fxy060608 已提交
467
  parsePagesJson,
fxy060608's avatar
fxy060608 已提交
468
  pagesJsonJsFileName,
469
  getAutoComponents,
470
  initAutoImportComponents,
fxy060608's avatar
fxy060608 已提交
471
  initAutoImportScanComponents,
fxy060608's avatar
fxy060608 已提交
472
  addPageUsingComponents,
fxy060608's avatar
fxy060608 已提交
473 474 475
  getUsingComponentsCode,
  generateUsingComponentsCode,
  getGlobalUsingComponentsCode,
476
  parseUsingAutoImportComponents,
fxy060608's avatar
fxy060608 已提交
477
  generateGlobalUsingComponentsCode
fxy060608's avatar
fxy060608 已提交
478
}