中文简体 | English
这是用于检测文件系统命名风格的工具。 很难想象在同一应用程序中有几种不同的文件命名风格。
$ fslint --config=.fslintrc.jsonc.fslintrc.jsonc 是一个配置文件
{
"maxError": 0, // 最大的错误条数
"exclude": ["vendor", "node_modules", "bin", ".git"], // 忽略的目录名称
"include": [
{
"file": "./src/**/*.vue", // 检测 *.vue 文件，支持 Glob 语法
"level": "error",
"pattern": "PascalCase",
"ignore": ["**/index.vue"] // 在这条规则中忽略 index.vue 文件，支持 Glob 语法
},
{
"folder": "./src/**/*", // 检测文件夹
"level": "warn",
"pattern": "kebab-case"
}
]
}| Pattern | 描述 | 推荐 |
|---|---|---|
| PascalCase | 大写的驼峰式风格 | Yes |
| camelCase | 小写的驼峰式风格 | Yes |
| kebab-case | 使用 破折号(-) 连接的小写风格 |
Yes |
| snake_case | 小写开头的蛇式风格 | Yes |
| /<regexp>/ | 以 / 开头 / 结尾的正则表达式 |
- Shell (Mac/Linux)
curl -fsSL https://github.com/release-lab/install/raw/v1/install.sh | bash -s -- -r=axetroy/fslint- PowerShell (Windows):
$r="axetroy/fslint";iwr https://github.com/release-lab/install/raw/v1/install.ps1 -useb | iex- Github release page (全平台支持))
下载可执行文件，并且把它加入到
$PATH环境变量中
- 使用 Golang 从源码中构建并安装 (全平台支持)
go install github.com/axetroy/fslint/cmd/fslint- 通过 npm 安装
npm install @axetroy/fslint -g$ make testThe Anti-996 License