Destiny 项目使用教程

Destiny 项目使用教程

destiny Prettier for File Structures 项目地址: https://gitcode.com/gh_mirrors/de/destiny

1. 项目介绍

Destiny 是一个用于文件结构美化的开源工具，类似于 Prettier 对于代码格式化的作用。它通过扫描文件夹中的所有文件，创建一个基于 JavaScript/TypeScript 文件导入关系的定向图，并生成一个分形表示的文件结构。最终结果是一个“美化”后的文件结构，有助于更好地组织和管理项目文件。

主要功能

• 扫描文件夹中的所有文件
• 创建基于文件导入关系的定向图
• 生成分形文件结构
• 修复文件导入路径
• 删除空文件夹
• 识别并打印“未使用”的文件

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 和 npm。然后，你可以通过 npm 安装 Destiny：

npm install -g destiny

使用

安装完成后，你可以通过命令行使用 Destiny。以下是一些常用的命令：

查看帮助信息

destiny --help

模拟运行（不实际修改文件）

npx destiny "src/**/*.*"

实际运行（修改文件结构）

npx destiny -w "src/**/*.*"

示例

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

src/
├── index.js
├── utils/
│   ├── helper.js
│   └── logger.js
└── components/
    ├── Button.js
    └── Input.js

运行以下命令：

npx destiny -w "src/**/*.*"

Destiny 将会根据文件的导入关系重新组织文件结构，例如：

src/
├── index.js
├── utils/
│   ├── helper.js
│   └── logger.js
└── components/
    ├── Button.js
    └── Input.js

3. 应用案例和最佳实践

应用案例

Destiny 特别适用于大型项目，尤其是那些文件结构复杂且文件数量众多的项目。通过使用 Destiny，开发者可以更容易地理解和维护项目的文件结构，减少因文件混乱而导致的错误。

最佳实践

• 定期使用：建议在项目开发过程中定期使用 Destiny，以保持文件结构的一致性和可读性。
• 备份代码：在运行 Destiny 之前，确保你已经备份了代码，或者已经提交到版本控制系统中。
• 自定义配置：根据项目需求，可以自定义 Destiny 的配置文件，以适应特定的文件结构需求。

4. 典型生态项目

相关项目

• Prettier：一个代码格式化工具，与 Destiny 类似，但专注于代码格式化。
• ESLint：一个代码检查工具，可以帮助你发现代码中的潜在问题。
• Husky：一个 Git 钩子工具，可以在提交代码前自动运行 Destiny 或其他代码检查工具。

集成示例

你可以将 Destiny 集成到你的开发工作流中，例如在 Husky 的 pre-commit 钩子中运行 Destiny：

{
  "husky": {
    "hooks": {
      "pre-commit": "destiny -w 'src/**/*.*'"
    }
  }
}

通过这种方式，每次提交代码时，Destiny 都会自动美化你的文件结构。

destiny Prettier for File Structures 项目地址: https://gitcode.com/gh_mirrors/de/destiny