okam-build
Version:
The build tool for Okam develop framework
591 lines (544 loc) • 18.6 kB
JavaScript
/**
* @file The base config for building small application
* @author sparklewhy@gmail.com
*/
'use strict';
module.exports = {
/**
* 是否打印详细的构建信息，默认 false，该选项设为 true，等价于 logLevel 设为 `info`
*
* @type {boolean}
*/
verbose: false,
/**
* 项目构建的根目录，其它配置指定的路径信息，默认都是相对于该根目录
*
* @type {string}
*/
root: process.cwd(),
/**
* 设计稿尺寸
*
* @type {number}
*/
designWidth: 750,
/**
* 扩展的原生小程序的框架，目前只支持 `okam-core` 提供的扩展：
* data: 支持 vue 数据操作方式及computed
* broadcast: 支持广播事件
* ref 扩展：允许模板指定 ref 属性，组件实例 $refs 获取引用类似 Vue
* watch: 支持 watch 配置 和 $watch API，依赖 data 扩展需要一起配置
* redux: 支持 redux 状态管理库，依赖 data 扩展需要一起配置
* vuex: 支持 vuex 状态管理库，依赖 data 扩展需要一起配置
* behavior: 支持组件包括 page 的 mixin 支持
* filter: 支持 Vue filter 语法，filter 定义通过组件 filters 属性定义
* 可选。e.g., ['data', 'broadcast', 'ref']
* 对于插件支持选项，可以传入数组形式：
* [ ['behavior', '{useNativeBehavior: true}'] ]
* 注意：第二个参数为插件选项代码的字符串形式
*
* @type {Array.<string|Array.<string>>}
*/
framework: null,
/**
* 要注册的 API，可选，会挂载到组件、页面、App 实例上下文 `this.$api`
* 结构：
* {
* 'audio': '@system.audio', // 导入外部依赖
* 'myRequest': './common/request', // 相对模块，相对于项目源目录
* }
*
* key: 为对应要导出的 api 名称，value 为对应的该 API 的实现
* 导入后，可以 `this.$api.audio` 访问到对应的注册的 API
*
* @type {Object}
*/
api: null,
/**
* 要增加的语法 API polyfill，可选，目前框架默认支持两种:
* `promise` (依赖 promise-polyfill)
* `async` (依赖 regenerator-runtime)
*
* @type {Array.<string>}
*/
polyfill: null,
/**
* 要增加的语法 API polyfill，通过引入局部变量方式而不是全局对象挂载变量方式引入
* 优先级高于 `polyfill`，可选，目前框架默认支持两种: `promise`、`async`
*
* @type {Array}
*/
localPolyfill: null,
/**
* 模块路径 resolve 选项，可选
* {
* extensions: ['xx'], // 查找的模块文件后缀名，会跟默认查找的后缀名做合并
* alias: {'common/': 'src/common/'}, // 模块别名设置，同 webpack#resolve.alias
* modules: ['node_modules', 'dep'], // 模块查找目录，如果传入绝对路径不会递归查找
* // 要忽略 resolve 的模块 id，可以传入正则，或者字符串数组，也可以是一个 function
* // 返回 true 表示要忽略，返回 false 表示不忽略。
* ignore: /^@system/ | ['@system/xx', /^@xxx/] | (moduleId, appType) => return true;
* onResolve(depModId, file) {} // resolve dep 时候事件监听回调
* }
*
* @type {Object}
*/
resolve: {
alias: {
'okam$': 'okam-core/src/index'
}
},
/**
* 执行的脚本命令，目前提供了两个钩子来执行命令： `onBuildStart` `onBuildDone`
*
* {
* onBuildStart: 'npm run init', // 构建开始要执行的命令
* onBuildStart: { // 也可以是对象形式
* cmd: 'node',
* args: ['init.js'], // 如果提供了 args， cmd 必须是命令名称
* options: {cwd: __dirname}
* },
* onBuildStart(opts) { // 可以是 function 形式，返回特定的要执行的脚本命令，
* // 如果多个，返回数组
* return [
* {
* cmd: opts.watch ? 'npm run watch' : 'npm run build',
* options: {cwd: __dirname}
* }
* ];
* }
* }
*
* @type {?Object}
*/
script: null,
/**
* 项目源代码位置信息
*
* @type {Object}
*/
source: {
/**
* 项目源代码根目录
*
* @type {string}
*/
dir: 'src',
/**
* 要 exclude 的文件
*
* @type {Array.<string|RegExp>}
*/
exclude: [],
/**
* 要 include 的文件，支持 glob pattern，相对于 root，如果是正则，只支持
* root 下文件 或者 source 下文件 的 match
*
* @type {Array.<string|RegExp>}
*/
include: [/^project\.\w+$/]
},
/**
* 小程序入口配置
*
* @type {Object}
*/
entry: {
/**
* 入口脚本文件
*
* @type {string|RegExp}
*/
script: /^src\/app\.(js|es|es6|ts)$/,
/**
* 入口样式文件
*
* @type {string|RegExp}
*/
style: /^src\/app\.(css|styl|less|sass|scss)$/,
/**
* 项目配置文件
*
* @type {string|RegExp}
*/
projectConfig: /^project\.\w+$/
},
/**
* 项目构建输出配置信息
*
* @type {Object}
*/
output: {
/**
* 输出的目标目录
*
* @type {string}
*/
dir: 'dist',
/**
* 输出的 NPM 依赖文件存放的目录
* 也支持设置成对象形式：
* {
* node_modules: 'src/dep', // 依赖文件路径前缀为 node_modules/ 挪到 src/dep 下
* bower_components: 'src/dep' // 依赖文件路径前缀为 bower_components/ 挪到 src/dep 下
* }
* 如果设置为字符串，默认为将依赖文件路径前缀为 node_modules/ 挪到 src/dep 下
*
* @type {string}
*/
depDir: 'src/dep',
/**
* 自定义输出文件路径。
* 如果该文件不输出，返回 `false`。
*
* @param {string} path 要输出的文件相对路径
* @param {Object} file 要输出的文件对象
* @param {Function=} next 父配置的文件输出处理方法，如果想保留父（基础）配置，可以
* 在自己过滤处理后调用该方法
* @return {boolean|string}
*/
file(path, file, next) {
if (file.isStyle && file.extname !== 'css' && !file.compiled) {
return false;
}
// do not output not processed file and sfc file component
if (!file.allowRelease || file.isComponent) {
return false;
}
path = path.replace(/^src\//, '');
return path;
},
/**
* The mini program app base class definition
*
* @type {?Object}
*/
appBaseClass: {
app: 'App',
component: 'Component',
page: 'Page'
}
},
/**
* SFC (Single File Components) 单文件组件的配置
*
* @type {Object}
*/
component: {
/**
* 要自动注入的全局组件定义，可选
* 定义结构：
* {
* // key 为要引入的组件名，同组件定义的 `components` 属性定义
* // value 为对应的组件定义的路径，相对于项目的源目录，必须 `.` 开头
* // 如果是 npm 模块，则为对应的 npm 模块引用模块 id，同脚本 import 规则
* MyButton: './components/MyButton',
* Button: 'npm_package/dist/Button'
* }
*
* @type {Object}
*/
global: null,
/**
* 组件的后缀名
*
* @type {string}
*/
extname: 'okm',
/**
* 组件内 模板相关配置项
*
* @type {Object}
*/
template: {
/**
* vue v- 前缀支持
*
* @type {Boolean}
*/
useVuePrefix: false,
/**
* 组件 v-model 配置项
*
* @type {Object}
*
* 不同平台已内置相应的表单元素
* 以及默认自定义组件值，无特殊场景可以不配置
*
* 设置 default 可以替换 所有自定义组件默认属性
* {
* // 设置所有自定义组件
* 'default': {
* // 必填 事件类型
* event: 'change',
* // 必填 对应 props 的属性名
* prop: 'value',
* // 对于event.detail 中的字段值的key
* // 不传表示为 event.detail 本身
* detailProp: 'value'
* },
*
* // 配置特定组件的 v-model 对应值
* 'sp_component': {
* event: 'spchange',
* prop: 'valuex'
* }
* eg:
* <sp_component v-model="xxx" />
* }
*/
modelMap: null,
/**
* 标签转换支持
*
* @type {string|Object}
*
* `key`: 被转的标签名，类型为：`string`
* `value`: 根据情况可配置为：`string|Object|` 类型
* 取值为 `string` 时，表示转为的 `tag`
* 取值为 `Object` 时，`Object` 的 `key` 可为：
* `tag`: 转为的 `tag`,
* `class`: `class` 需额外附加 `classname`，`classname` 的样式需自行定义；
* 其他属性: 需替换的属性名
*
* eg:
*
* a {
* tag: 'navigator',
* class: 'inline',
* href: 'url'
* }
*
* <a class="home-link" href='xxx'></a>
* 转为:
* <navigator class="inline" url='xxx'></navigator>
*/
transformTags: null,
/**
* 定义模板依赖的本地资源信息获取的标签属性信息，
* 如果不想获取某个标签依赖资源信息，可以配置为 false
*
* {
* img: 'src',
* import: true, // 设为 true，默认为 src 属性获取依赖的资源
* include: false // 设为 false，不会分析该标签的依赖资源
* }
*
* @type {?Object}
*/
resourceTags: null
}
},
/**
* 是否启用微信组件转换成 swan 组件处理，可选，默认 false
* 可以传入对象，控制各个部分转换选项
* {
* js: {
* plugins: [], // babel plugins using，重写内部使用的 plugins
* processor: 'babel' // 使用的 babel 处理器，默认 babel（即 babel6），
* // 如果整个项目转换使用 babel7，这里改成 babel7
* },
* tpl: {}, // 模板转换选项，具体可以参考模板处理器选项
* css: {}, // 样式转换选项，具体可以参考 postcss 处理器选项
* }
*
* @type {boolean|Object}
*/
wx2swan: false,
/**
* 是否启用原生转换处理，可选，默认 true。
* 也可以传入配置对象：
* {
* js: {
* plugins: [], // babel plugins using，重写内部使用的 plugins
* processor: 'babel' // 使用的 babel 处理器，默认 babel（即 babel6），
* // 如果整个项目转换使用 babel7，这里改成 babel7
* }
* }
*
* @type {boolean|Object}
*/
native: true,
/**
* 自定义的构建处理器
*
* 处理器定义：
* {
* name: 'myProcessor',
* processor: 'processorPath', // 可以指定处理器 npm 包名、路径、或者实现（直接 require）
* deps: ['xxx'], // 处理器依赖的 NPM 包名，可选
* extnames: ['abc'], // 要使用该处理器处理的文件后缀名，可选
* rext: 'efg', // 处理完输出的文件的后缀名，可选
* options: {} // 默认的处理器选项，可选
* }
*
* 这里定义的处理器，后续的处理规则 rules 里，可以直接通过处理器名称 `myProcessor` 引用
*
* 如果要重写预定义的处理器，比如 less
* {
* name: 'less', // 指定要重写的处理器名
* processor: 'xxx' // 重写实现的处理器
* }
*
* 如果要基于现有处理器定义别名处理器：
* {
* name: 'new-processor',
* processor: 'less', // 指定现有处理器名
* deps: [], // 将同已有处理器 deps 做 merge
* options: {} // 覆盖已有处理器的选项信息
* }
*
* 也可以直接传入对象非数组，key 为对应的 processor name:
* {
* less: {
* processor: 'xxx',
* options: {}
* }
* }
*
* @type {Object|Array.<Object>}
*/
processors: null,
/**
* 构建处理规则定义
*
* @type {Array.<Object>}
*/
rules: [
{
/**
* 自定义文件是否要处理，match 也可以传要匹配的文件的 glob pattern 或者 正则
*
* e.g.,
* match: '*.vue'
* match: /^src\/components\/*.vue/
*
* 注意：这里匹配的是处理文件的源路径，不会匹配处理后的路径。比如 less 样式文件处理后
* 变成 css 样式文件，如果指定 *.css 是没法匹配到的
*
* @param {Object} file 要处理的文件
* @return {boolean}
*/
match(file) {
if (file.isStyle && file.extname !== 'css' && !file.isEntryStyle && !file.owner) {
// 默认不处理非入口样式及单文件组件的样式文件
return false;
}
return !!file.processor;
},
/* eslint-disable fecs-valid-jsdoc */
/**
* 处理的文件要使用的处理器列表,
* 可以指定预定义的处理器名称，比如 less，stylus，具体参考 lib/processor/type.js 定义
*
* e.g.,
* processors: ['less']
* processors: [
* { // 自定义处理器选项写法
* name: 'less',
* options: {}
* },
* ['less', {}] // 另外一种自定义处理器包含选项写法
* ]
* processors: { // 也可以传对象形式
* less: {
* }
* }
*
* @type {Array|Object}
*/
processors: [
/**
* 动态确定要使用的处理器，返回默认的处理器名称
*
* @param {Object} file 要处理的文件
* @return {string|Array.<string>}
*/
function (file) {
return file.processor;
}
]
},
{
match(file) {
return file.isConfig || file.isProjectConfig;
},
processors: ['configJson']
},
{
match(file) {
return file.isComponentConfig;
},
processors: ['componentJson']
}
],
/**
* 是否监听文件变化，自动构建，如果对文件变更监听可以直接设置为对象：
* {
* ready() {},
* fileChange(filePath) {},
* fileAdd(filePath) {},
* fileDel(filePath) {},
* dirDel(dir) {},
* dirAdd(dir) {},
* error(err) {}
* }
*
* 注意：开启 watch 功能，需要在命令行提供 `--watch` 选项
*
* @type {boolean|Object}
*/
watch: false,
/**
* 自定义的开发 server 配置，可选
*
* 注意：开启 server 功能，需要在命令行提供 `--server` 选项，
* 如果要指定启动端口，可以这里配置也可以命令行指定 `--port 9090`
* {
* // 开发 server 端口，可选，默认 8080
* port: 8080,
*
* // server 类型，默认支持：connect/express/koa 实现的 server
* // 可选，默认 `connect`，对于使用的 server 类型，需要安装相应的依赖
* type: 'connect',
*
* // server 的中间件，可选
* // 中间件定义：
* // {
* // name: 'xx' // 中间件的 npm 包名
* // options: {} // 创建中间件实例的选项
* // }
* // or
* // ['xxx', {}] // 第一个参数，中间件 npm 包名，第二个为对应的选项
* // or
* // function () {} // 直接传入对应的中间件函数
* middlewares: []
* }
*
* @type {Object}
*/
server: null,
/**
* 附加的开发配置，开发配置使用依赖于环境变量 `NODE_ENV`
* 配置为 `dev` 或者 `development`
* 可选。
*
* {
* // 自定义的处理器，同外层 processors，可选
* processors: {},
*
* // 发环境附加的处理规则配置，同外层 rules，可选
* rules: [],
* }
*
* @type {Object}
*/
dev: {}
/**
* 附加的环境配置，开发配置使用依赖于环境变量 `NODE_ENV` 值：env，值同 dev
* 可选。
*
* @type {Object}
*/
// <env>: {},
};