Skip to main content
版本: 0.7

代码格式化工具

KCL 支持通过内置的命令行工具一键格式化多个 KCL 文件文档。本文展示 KCL 编码风格和 KCL 格式化工具的使用方式。

KCL 编码风格

KCL 格式化对文件的修改样式具体见 KCL 编码风格:Style Guide for KCL Code

使用方式

  • 单文件格式化
kcl fmt your_config.k
  • 文件夹内多文件格式化
kcl fmt your_config_path -R
  • 命令行参数
    • -R|--recursive 设置是否递归遍历子文件夹
    • -w|--fmt-output 设置是否输出到标准输出流,不加 -w 表示原地格式化 KCL 文件

格式化文件效果展示

  • 格式化前
import     math
mixin DeploymentMixin:
service:str ="my-service"
schema DeploymentBase:
name: str
image : str
schema Deployment[replicas] ( DeploymentBase ) :
mixin[DeploymentMixin]
replicas : int = replicas
command: [str ]
labels: {str: str}
deploy = Deployment(replicas = 3){}
  • 格式化后
import math

mixin DeploymentMixin:
service: str = "my-service"

schema DeploymentBase:
name: str
image: str

schema Deployment[replicas](DeploymentBase):
mixin [DeploymentMixin]
replicas: int = replicas
command: [str]
labels: {str:str}

deploy = Deployment(replicas=3) {}

参数说明

This command formats all kcl files of the current crate.

Usage:
kcl fmt [flags]

Examples:
# Format the single file
kcl fmt /path/to/file.k

# Format all files in this folder recursively
kcl fmt ./...

Flags:
-h, --help help for fmt