程序框架项目配置文件说明

网友投稿 220 2024-07-02

项目配置文件

项目根目录中的 project.config.json文件可以对项目进行配置。

#1. 配置项

属性类型描述
miniprogramRootPath String指定小程序源码的目录(需为相对路径)
pluginRootPath String指定插件项目的目录(需为相对路径)
compileTypeString编译类型
appidString项目的 appid
projectnameString项目名字
packOptionsObject打包配置选项
settingObject项目设置

小程序框架项目配置文件说明

请注意

以下配置项暂不支持

名称功能说明
qcloudRoot指定腾讯云项目的目录(需为相对路径)
cloudbaseRoot云开发代码根目录(需为相对路径)
cloudfunctionRoot云函数代码根目录(需为相对路径)
cloudfunctionTemplateRoot云函数本地调试请求模板的根目录(需为相对路径)
cloudcontainerRoot云托管代码根目录(需为相对路径)
libVersion基础库版本
debugOptions调试配置选项
watchOptions文件监听配置设置
scripts自定义预处理
staticServerOptions仅在小游戏项目中有效
editorSetting指定自动生成的文件的 tabIndent 和 tabSize
skeletonConfig骨架屏相关设置

#compileType

编译类型作用于开发工具的以下设置

名字说明
miniprogram当前为普通小程序项目
plugin当前为小程序插件项目
game当前为小游戏项目

#packOptions

packOptions 用以配置项目在打包过程中的选项。打包是预览、上传时对项目进行的必须步骤。

目前可以指定 packOptions.include 字段,用以配置打包时需要强制带上的文件(仅限后缀名白名单内)或者文件夹,匹配的这些文件或文件夹将一定会出现在预览或上传的结果内。(该字段的优先级高于 packOptions.ignore

同时可以指定 packOptions.ignore 字段,用以配置打包时对符合指定规则的文件或文件夹进行忽略,以跳过打包的过程,这些文件或文件夹将不会出现在预览或上传的结果内。如果packOptions.ignore设置了使用到的页面文件,那么在编译的过程中就会报错,无法进行后续的预览和上传。

packOptions.ignore 和 packOptions.include 为一对象数组,对象元素类型如下:

字段名类型说明
valuestring路径或取值
typestring类型

其中,type 可以取的值为 folder、file、suffix、prefix、regexp2、glob2,分别对应文件夹、文件、后缀、前缀、正则表达式、Glob 规则。所有规则值都会自动忽略大小写。

注: value 字段的值若表示文件或文件夹路径,以小程序目录 (miniprogramRoot) 为根目录。

示例配置如下。

{
  "packOptions": {
    "ignore": [{
      "type": "file",
      "value": "test/test.js"
    }, {
      "type": "folder",
      "value": "test"
    }, {
      "type": "suffix",
      "value": ".webp"
    }, {
      "type": "prefix",
      "value": "test-"
    }, {
      "type": "glob",
      "value": "test/**/*.js"
    }, {
      "type": "regexp",
      "value": "\\.jsx$"
    }]
  }
}
        已复制代码

注: 这部分设置的更改可能需要清除缓存才能生效。

#setting

项目的额外设置,可以指定以下设置。

字段名类型说明
loginUUIDstring设置 ft.login 接口所用到 UUID , 用于获取 code,可在项目详情中设置
skipCompileWatchBoolean设置 IDE 是否会在修改文件时触发 watch 热更新
es6Boolean编译时是否启用 es6 转 es5,部分低版本安卓系统无法识别较新的语法,有这部分设备上线需求的话建议勾选开启
enhanceBoolean是否打开增强编译
postcssBoolean上传代码时样式是否自动补全
minifiedBoolean上传代码时是否自动压缩脚本文件

以下字段是开发者工具的隐式设置

字段名类型说明
useCompilerPluginsString[] 或 false编译插件配置
packNpmManuallyBoolean是否手动配置构建 npm 的路径
packNpmRelationListArray仅 packNpmManually 为 true 时生效,详细参考构建 npm 文档


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:如何导入字节小程序示例
下一篇:小程序框架全局配置说明
相关文章

 发表评论

暂时没有评论,来抢沙发吧~