godu：快速发现大型文件的Golang工具

godu：快速发现大型文件的Golang工具

godu Simple golang utility helping to discover large files/folders. 项目地址: https://gitcode.com/gh_mirrors/go/godu

一、项目目录结构及介绍

godu项目遵循简洁明了的组织原则，其基本结构如下：

godu/
├── goreleaser.yaml      # goreleaser配置文件，用于自动化发布流程
├── travis.yml           # Travis CI的配置文件，用于持续集成
├── .gitignore           # Git忽略文件列表
├── CONTRIBUTING.md      # 贡献指南，指导开发者如何参与项目
├── LICENSE.md           # 项目的MIT授权协议文件
├── README.md            # 项目的主要文档，介绍功能、安装、使用等
├── godu.go              # 主程序入口文件
├── godu_architecture.drawio # 项目架构图源文件
├── godu_architecture.png # 项目架构的图片展示
├── parser.go            # 解析相关逻辑实现文件
├── state_model.go       # 状态模型的定义文件
├── state_presenter.go   # 状态呈现相关的代码
└── tests相关的目录及文件    # 包含测试用例和辅助函数

• gorelease.yaml 和 travis.yml 分别用于自动化构建和部署，以及持续集成环境的设置。
• .gitignore 定义了在版本控制中不需要跟踪的文件类型。
• CONTRIBUTING.md 引导潜在贡献者了解参与项目的方式。
• LICENSE.md 明确了软件的许可条款，本项目采用MIT许可证。
• README.md 是项目的入门文档，涵盖了安装、配置和使用方法。
• godu.go 作为核心，是启动项目执行的入口点。
• 其余的.go文件则是业务逻辑、数据处理和状态管理的核心部分。

二、项目的启动文件介绍

项目的启动主要依赖于godu.go文件。这是一个简单的命令行应用程序，通过调用此文件并传递适当参数，可以执行扫描磁盘以寻找大型文件的任务。无需手动编译即可使用预编译的二进制文件或通过Go语言环境直接运行。典型的执行方式如下：

go run main.go [命令行参数]

但在实际应用中，用户通常会通过系统的包管理器（如Homebrew）安装或者直接下载预编译好的可执行文件进行使用，比如：

godu ~

三、项目的配置文件介绍

godu支持一个名为goduignore的配置文件来指定应该被忽视的文件夹名。这个文件默认位于用户的主目录下（~/goduignore）。它允许用户列出不想让godu扫描的文件夹，例如常见的大型且频繁更新的node_modules：

# 示例goduignore内容
node_modules

这使得扫描过程更加高效，尤其是当忽略掉那些含有大量小文件的文件夹时。请注意，目前goduignore仅支持完全匹配的文件夹名称排除，而未像.gitignore那样具备模式匹配的功能。

通过这种方式，godu提供了一种灵活但相对简单的方式来定制扫描行为，从而帮助用户快速定位占空间的大文件，优化存储空间。

godu Simple golang utility helping to discover large files/folders. 项目地址: https://gitcode.com/gh_mirrors/go/godu