CLIgnore

clignorance is bliss

CLIgnore 是一个简单的命令行工具，可根据您的语言或框架查找 .gitignore 文件。它使用 GitHub API 从 GitHub 的官方 仓库 搜索模板文件，因此您可以在短时间内自动下载并使用它们。

原因

.gitignore 文件很讨厌，我讨厌它们。虽然许多 IDE 和版本控制工具会为您生成 .gitignore 文件，但并非总是如此。所以，我不再不断在 Google 上搜索 gitignore 仓库，找到合适的模板，复制模板，然后将它粘贴到我的项目中 像个傻瓜一样... 我制作了一个工具，为我（和您！）完成这项工作。

使用方法

查找

使用 clignore find 基于您的语言或框架进行搜索，并选择您需要的文件。如果 CLIgnore 只找到与您的搜索匹配的文件，它将自动下载。

其他内容

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <token>    Sets the OAuth2 token for authenticated requests [env: TOKEN=]

SUBCOMMANDS:
    authenticated    Checks the GitHub API to see if you have an authorization token present
    find             Finds files by name
    help             Prints this message or the help of the given subcommand(s)
    list             Lists all gitignore template files

设置 OAuth2 令牌

GitHub API 限制用户每小时 60 个请求。如果您需要更多的请求，CLIgnore 允许您通过环境变量设置 OAuth2 令牌。

TOKEN=<your super-secret token here> clignore find python

认证请求可以每小时进行高达 5000 次请求。更多内容请点击 这里。

安装

CLIgnore 使用 Rust 编写。建议从 官方下载页面 安装 Rust。

安装 Rust 后，使用 cargo install

cargo install clignore

Cargo 将构建 CLIgnore 可执行文件并将其放置在 $HOME/.cargo。您应该能够使用 clignore。

路线图

• 希望有一种 CI/CD
• 沿着同样的路线，如果有一个预先构建的二进制文件会很有帮助
• 尚未在 Windows 或 Mac 上进行测试。可能需要这样做。
• 需要确定构建所需的 rustc 的最小版本（添加到说明书中）
• 错误处理相当懒惰。我只是在 main 中做了一堆 unwrap，所以虽然错误会显示给用户，但看起来并不美观。
• 所有源文件都放在根目录下 src/，因为我被模块系统搞糊涂了。理想情况下，我想弄清楚这个问题，并将文件移动到文件夹中。