TOML排序库
toml-sort的Python项目详细描述
TOML排序
一个命令行实用程序,可以对toml文件进行排序和格式化。需要Python3.6或更高版本。
安装
# With pip pip install toml-sort # With poetry poetry add toml-sort
动机
此库通过提供以下功能来对toml文件进行排序:
- 排序表和表数组(AOT)
- 对非表/非AOT排序或不排序的选项
- 保留内联注释
- 是否保留顶级文档注释的选项
- 标准化空白和缩进
我写这个库是因为找不到任何“好的”toml文件排序工具。
用法
此项目可以用作命令行实用程序或python库。
命令行界面
Stdin -> Stdout : cat input.toml | toml-sort
Disk -> Disk : toml-sort -o output.toml input.toml
Linting : toml-sort --check input.toml
Inplace Disk : toml-sort --in-place input.toml
示例
以下示例显示了具有默认选项的cli的输入和输出。
未格式化、未排序的输入
# My great TOML exampletitle="The example"[[a-section.hello]]ports=[ 8001, 8001, 8002 ]dob=1979-05-27T07:32:00Z# First class dates? Why not?[b-section]date="2018"name="Richard Stallman"[[a-section.hello]]ports=[ 80 ]dob=1920-05-27T07:32:00Z# Another date![a-section]date="2019"name="Samuel Roeca"
格式化、排序输出
# My great TOML exampletitle="The example"[a-section]date="2019"name="Samuel Roeca"[[a-section.hello]]ports=[ 8001, 8001, 8002 ]dob=1979-05-27T07:32:00Z# First class dates? Why not?[[a-section.hello]]ports=[ 80 ]dob=1920-05-27T07:32:00Z# Another date![b-section]date="2018"name="Richard Stallman"
地方发展
这个项目的本地开发非常简单。
依赖项
手动安装以下工具。
推荐
设置开发环境
make setup
运行测试
make test
作者
塞缪尔·罗卡samuel.roeca@gmail.com