配置文件

在使用 Qingkuai 构建应用时,你通常无需进行复杂的配置即可获得开箱即用的开发体验。不过在实际项目中,为了适应不同的开发需求或行为定制,Qingkuai 提供了灵活的配置文件机制,帮助你更精细地控制其工作方式。统一的配置机制不仅提升了项目的一致性,也让多人协作更加顺畅,是构建可维护应用的重要基础。


运行配置

Qingkuai 的运行配置通过 .qingkuairc 文件修改,组件文件会被当前目录或其最近的上级目录中的运行配置文件影响。例如下面的目录结构中 Hello 组件文件会被自身目录中的配置文件影响,而 App 组件则会被项目根目录中的配置文件影响:

txt
qingkuai-app
├── src
│   ├── Components
│   │   ├── Hello.qk
│   │   └── .qingkuairc
│   └── App.qk
└── .qingkuairc

extends

该属性用于继承另一个 JSON 配置文件,字符串,值为目标文件路径,相对于当前配置文件所在目录解析。

假设有一份 .qingkuairc 配置文件:

json
{
    "extends": "./base.json",
    "whitespace": "preserve"
}

其中 base.json 内容如下:

json
{
    "reactivityMode": "shallow",
    "whitespace": "collapse"
}

那么实际应用的配置如下:

json
{
    "reactivityMode": "shallow",
    "whitespace": "preserve"
}

reactivityMode

该属性用于配置 Qingkuai 默认推导的响应性模式,字符串,可选值:reactive、shallow,默认值为 reactive:

whitespace

该属性用于配置模板中空白字符的处理方式,字符串,可选值:preserve、trim、collapse、trim-collapse,默认值为 trim-collapse:

preserveHtmlComments

该属性用于配置是否保留 HTML 注释节点,字符串,可选值:never、always、development、production,默认值为 development。

requireReactivityMark

该属性用于配置是否要求脚本块顶层的变量声明显式使用响应性内建方法(raw、reactive、shallow、derived、alias)进行标记,布尔值,默认值为 false。启用后,未显式标记的顶层变量声明会导致编译错误。

resolveImportExtension

该属性用于配置在组件文件的导入语句中是否可省略 .qk 扩展名,布尔值,默认值为 true:

js
// 被解析为 ./Component.qk
import Component from "./Component"

allowConstReactive

该属性用于配置是否允许将常量声明标记为响应式,布尔值,默认值为 true。改为 false 时,常量声明的变量不会被推导为具有响应性,且显式使用 reactive 或 shallow 标记常量声明会导致编译错误。

interpretiveComments

该属性用于配置是否在编译结果中插入解释性注释,布尔值,默认值为 true


格式化配置

Qingkuai 语言服务的格式化功能基于 prettier-plugin-qingkuai 实现,这是一个 Prettier 插件,组件文件的格式化遵循常规的 Prettier 配置。其中有一些仅对组件文件生效的附加配置选项,它们与常规 Prettier 选项一样直接写在配置文件的一级属性中,例如:

json
{
    "tabWidth": 4,
    "printWidth": 80,
    "spaceAroundInterpolation": true
}

spaceAroundInterpolation

该属性用于配置是否在插值块开始和结束处插入空格,布尔值,默认值为 false,改为 true 时整理风格如下:

qk
<div #for={ item, index of 3 }>{ index }: { item }</div>

selfCloseEmptySlotTags

该属性用于配置是否将空 slot 标签转换为自闭合格式,布尔值,默认值为 true。改为 true 时,空 slot 标签会被转换为自闭合格式,改为 false 时则保留原始格式,不做任何修改:

qk
<slot />

componentTagFormatPreference

该属性用于配置组件标签的风格偏好,字符串,可选值为 camel、kebab,默认值为 camel,修改该属性会影响 Qingkuai 语言服务器给出的补全建议中组件标签的格式。

componentAttributeFormatPreference

该属性用于配置组件属性的风格偏好,字符串,可选值为 camel、kebab,默认值为 camel,修改该属性会影响 Qingkuai 语言服务器给出的补全建议中组件属性的格式。


在github上编辑此页面