5 个版本 (3 个稳定版)

2.2.0	2019年4月21日
2.1.0	2019年4月8日
2.0.0	2019年4月1日
0.1.1	2019年3月27日
0.1.0	2019年3月27日

在文件系统中排名 #792

Apache-2.0

195KB
1.5K SLoC

Flint

你认为代码审查中没有地方可以讨论文件命名约定吗？使用 flint（文件系统检查器）强制执行一致的文件和目录命名规则。

安装
Docker镜像
用法
默认约定
贡献
许可证

安装

使用Rust

$ cargo install flint

Docker镜像

quay.io/bloom42/flint

$ docker run -v `pwd`:/flint quay.io/bloom42/flint:latest

用法

配置存储在项目（仓库）根目录下的 .flint.sane 文件中（有关SANE配置格式的更多信息，请参阅此处）。

运行时，flint将递归地在当前目录开始处向上搜索配置文件。

$ cat .flint.sane

rules = [
  {
    pattern = "*.rs", # optional, default to "*"
    convention = "snake_case", # mandatory, one the default conventions below or a Rust regex https://docs.rs/regex/1.1.4/regex/
  },
  {
    pattern = "*.go",
    convention = "^[a-z][a-z_\\d]*[a-z\\d]$",
  },
]

默认约定

名称	描述
`any`	允许任何文件名 `.*`
`snake_case`	强制名称遵守 `snake_case` 约定 `^[a-z][a-z_\d]*[a-z\d]$`
`kebab_case`	强制名称遵守 `kebab-case` 约定 `^[a-z][a-z\-\d]*[a-z\d]$`
`upper_snake_case`	强制名称遵守 `UPPER_SNAKE_CASE` 约定 `^[A-Z][A-Z_\d]*$`
`camel_case`	强制名称遵守 `camelCase` 约定 `^[a-z][A-Za-z\d]*$`
`pascal_case`	强制名称遵守 `PascalCase` 规范 `^[A-Z][A-Za-z\d]*$`

贡献

感谢您对贡献的兴趣！请参考 https://opensource.bloom.sh/contributing 以获取指导。

许可证

请参阅 LICENSE.txt 和 https://opensource.bloom.sh/licensing

依赖关系

~5–15MB
~163K SLoC