pages.js 14.2 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
} = require('./util')

fxy060608's avatar
fxy060608 已提交
11 12
const {
  getJson,
fxy060608's avatar
fxy060608 已提交
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
  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
}
fxy060608's avatar
fxy060608 已提交
35 36 37 38

function getPagesJson () {
  return processPagesJson(getJson('pages.json', true))
}
fxy060608's avatar
fxy060608 已提交
39

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
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`)
    }
  }
71 72 73 74 75
  // 将 subpackages 转换成 subPackages
  if (pagesJson.subpackages && !pagesJson.subPackages) {
    pagesJson.subPackages = pagesJson.subpackages
    delete pagesJson.subpackages
  }
fxy060608's avatar
fxy060608 已提交
76

fxy060608's avatar
fxy060608 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
  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 已提交
92
  if (uniNVuePages.length) { // 直接挂在 pagesJson 上
fxy060608's avatar
fxy060608 已提交
93
    pagesJson.nvue = {
fxy060608's avatar
fxy060608 已提交
94
      pages: uniNVuePages.reverse()
fxy060608's avatar
fxy060608 已提交
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    }
    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 已提交
114
  if (typeof page === 'string' || !page.path) { // 不合法的配置
115
    console.warn('pages.json 页面配置错误, 已被忽略, 查看文档: https://uniapp.dcloud.io/collocation/pages?id=pages')
fxy060608's avatar
fxy060608 已提交
116 117 118 119 120 121 122 123 124 125 126 127 128 129
    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 已提交
130
    const subNVues = page.style.subNVues || (page.style['app-plus'] && page.style['app-plus'].subNVues)
fxy060608's avatar
fxy060608 已提交
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    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 已提交
151
    if (process.env.UNI_USING_V3 || process.env.UNI_USING_V3_NATIVE) { // 不移除
fxy060608's avatar
fxy060608 已提交
152 153 154 155
      page.nvue = true
      return true
    } else {
      uniNVuePages.push({
fxy060608's avatar
fxy060608 已提交
156 157
        path: pagePath + '.html',
        style: page.style || {}
fxy060608's avatar
fxy060608 已提交
158 159 160
      })
      return false
    }
fxy060608's avatar
fxy060608 已提交
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  }

  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 已提交
181
const uniNVuePages = []
fxy060608's avatar
fxy060608 已提交
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

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 已提交
206
function parseEntry (pagesJson) {
fxy060608's avatar
fxy060608 已提交
207 208 209 210 211 212 213 214
  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 已提交
215
  if (process.env.UNI_USING_NATIVE || process.env.UNI_USING_V3_NATIVE) {
fxy060608's avatar
fxy060608 已提交
216 217 218 219
    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 已提交
220
  uniNVuePages.length = 0
fxy060608's avatar
fxy060608 已提交
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

  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 已提交
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 276 277 278 279 280
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 已提交
281
  return `;${importCode.join(';')};exports.default.components=Object.assign({${componentsCode.join(',')}},exports.default.components||{});`
fxy060608's avatar
fxy060608 已提交
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
}

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 已提交
309
}
fxy060608's avatar
fxy060608 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

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 已提交
326 327 328
// 存储自动组件
const autoComponentMap = {}

329 330
let lastUsingAutoImportComponentsJson = ''

fxy060608's avatar
fxy060608 已提交
331 332 333 334
let uniAutoImportComponents = []

let uniAutoImportScanComponents = []

fxy060608's avatar
fxy060608 已提交
335 336
let uniQuickAppAutoImportScanComponents = false

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

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

fxy060608's avatar
fxy060608 已提交
362 363 364 365 366
function initAutoImportScanComponents () {
  const componentsPath = path.resolve(process.env.UNI_INPUT_DIR, 'components')

  const components = getAutoComponentsByDir(componentsPath)

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

fxy060608's avatar
fxy060608 已提交
378
  uniAutoImportScanComponents = parseUsingAutoImportComponents(components)
fxy060608's avatar
fxy060608 已提交
379 380
  refreshAutoComponentMap()
}
381

382 383 384 385 386 387 388 389 390 391 392
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 = {}
  }
393 394
  // 目前仅 mp-weixin 内置支持 page-meta 等组件
  if (process.env.UNI_PLATFORM !== 'mp-weixin') {
fxy060608's avatar
fxy060608 已提交
395 396 397 398 399 400 401
    BUILT_IN_COMPONENTS.forEach(name => {
      const easycomName = `^${name}$`
      if (!usingAutoImportComponents[easycomName]) {
        usingAutoImportComponents[easycomName] =
          '@dcloudio/uni-cli-shared/components/' + name + '.vue'
      }
    })
402 403
  }

404 405 406
  const newUsingAutoImportComponentsJson = JSON.stringify(usingAutoImportComponents)
  if (newUsingAutoImportComponentsJson !== lastUsingAutoImportComponentsJson) {
    lastUsingAutoImportComponentsJson = newUsingAutoImportComponentsJson
fxy060608's avatar
fxy060608 已提交
407
    uniAutoImportComponents = parseUsingAutoImportComponents(usingAutoImportComponents)
408 409 410 411
    refreshAutoComponentMap()
  }
}

412 413 414 415 416 417 418 419 420
/**
 * UNI_AUTO_COMPONENTS 被更新,重新刷新 map
 */
function refreshAutoComponentMap () {
  Object.keys(autoComponentMap).forEach(name => {
    addAutoComponent(name)
  })
}

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

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 已提交
449

450 451 452 453
function parseUsingAutoImportComponents (usingAutoImportComponents) {
  const autoImportComponents = []
  if (usingAutoImportComponents) {
    Object.keys(usingAutoImportComponents).forEach(pattern => {
454 455 456 457 458 459 460
      const replacement = usingAutoImportComponents[pattern]
      if (replacement && typeof replacement === 'string') {
        autoImportComponents.push({
          pattern: new RegExp(pattern),
          replacement: replacement
        })
      }
461 462 463 464
    })
  }
  return autoImportComponents
}
fxy060608's avatar
fxy060608 已提交
465

466
const BUILT_IN_COMPONENTS = ['page-meta', 'navigation-bar', 'uni-match-media']
fxy060608's avatar
fxy060608 已提交
467 468 469 470 471 472 473 474 475

function isBuiltInComponent (name) {
  return BUILT_IN_COMPONENTS.includes(name)
}

function isBuiltInComponentPath (modulePath) {
  return !!BUILT_IN_COMPONENTS.find(name => modulePath.includes(name))
}

fxy060608's avatar
fxy060608 已提交
476
module.exports = {
477
  isBuiltInComponent,
fxy060608's avatar
fxy060608 已提交
478
  isBuiltInComponentPath,
fxy060608's avatar
fxy060608 已提交
479 480 481 482 483
  getMainEntry,
  getNVueMainEntry,
  parsePages,
  parseEntry,
  getPagesJson,
fxy060608's avatar
fxy060608 已提交
484
  parsePagesJson,
fxy060608's avatar
fxy060608 已提交
485
  pagesJsonJsFileName,
486
  getAutoComponents,
487
  initAutoImportComponents,
fxy060608's avatar
fxy060608 已提交
488
  initAutoImportScanComponents,
fxy060608's avatar
fxy060608 已提交
489
  addPageUsingComponents,
fxy060608's avatar
fxy060608 已提交
490 491 492
  getUsingComponentsCode,
  generateUsingComponentsCode,
  getGlobalUsingComponentsCode,
493
  parseUsingAutoImportComponents,
fxy060608's avatar
fxy060608 已提交
494
  generateGlobalUsingComponentsCode
fxy060608's avatar
fxy060608 已提交
495
}