Flutter文件夹校验与管理插件folderslint的使用

FoldersLint

目录结构检查器，适用于前端项目。

• ✅ 轻松配置，只需简单的规则在一个文件中。
• ✅ 极其快速。
• ✅ 支持Windows、MacOS和Linux。
• ✅ 可以与lint-staged一起使用。

为什么

通过目录结构检查使项目更加整洁。 🗂

目录结构规则是任何项目的重要部分。这些规则有助于提高项目的清晰度并减少复杂性。明确的结构可以使开发人员始终知道在哪里放置文件以及在哪里查找它们。如果项目足够大，则有必要避免混乱。

folderslint 允许你配置目录结构规则，并检查已存在或新文件是否符合这些规则。

快速概述

全局安装 folderslint：

pub global activate folderslint

或者将其作为开发依赖项安装：

pub add dev:folderslint 

在项目的根目录下设置一个配置文件 .folderslintrc。

运行 folderslint 检查整个项目或某个目录（例如 /components）：

（如果全局安装）

folderslint components

如果作为开发依赖项安装

dart run folderslint components

配置

folderslint 需要在项目的根目录下有一个名为 .folderslintrc 的配置文件。

配置文件的示例：

{
  "root": "src", // 可选
  "rules": [
    "components/*",
    "pages/components/*/utils",
    "hooks",
    "legacy/**"
   ]
}

root 是要检查结构的目录。

rules 是定义允许的目录路径的规则数组。

根目录

如果你想要检查特定目录的结构，则必须指定 root。不在 root 范围内的目录将不会被检查。如果你想检查项目中的所有目录，则不需要指定 root。

规则语法

有三种方式来指定规则：

• 目录的确切路径，
• 使用 * 替换目录名称，表示该层接受任何目录，
• 在规则的末尾使用 ** 替换目录名称，表示该层以下的所有层级都接受任何目录。

⚠️ ** 只能在规则的末尾使用，因为它在中间使用没有意义。它会使得路径中间的任意数量嵌套目录被接受，这与明确定义的目录结构规则的想法不符。

例如：

⚠️ 类似于 components/*/utils 的规则会自动使 components 和 components/* 规则生效。因此，不需要为每个层级的目录指定规则。你需要指定最深层级的路径。

⚠️ 不建议过度使用 ** 模式。它会让项目缺乏结构。然而，对于某些自然结构混乱的目录（如 node_modules 或未维护的遗留目录）可能是有用的。

完整示例Demo

假设我们有一个项目结构如下：

my_project/
├── src/
│   ├── components/
│   │   ├── component1/
│   │   │   └── index.js
│   │   ├── component2/
│   │   │   └── utils/
│   │   │       └── helper.js
│   ├── hooks/
│   │   └── useComponent.js
│   ├── legacy/
│   │   └── old-component/
│   │       └── old-helper.js
└── .folderslintrc

.folderslintrc 文件内容如下：

{
  "root": "src",
  "rules": [
    "components/*",
    "pages/components/*/utils",
    "hooks",
    "legacy/**"
  ]
}

运行命令：

dart run folderslint components