git-ignore

使用www.gitignore.io的模板、自己的别名和模板创建.gitignore文件

• 简单：使用git ignore node来打印node模板。
• 离线优先：自动缓存模板以支持离线。
• 别名、模板：为常用组合的模板创建别名，或者创建自己的自定义模板。
• 魔法：通过将常见文件与模板匹配来自动生成您的.gitignore。

是什么以及为什么

厌倦了每次都访问gitignore.io来获取您的.gitignore模板？我也是。所以我自动化了它。

git ignore允许您轻松快速地从gitignore.io获取所有可用的模板，即使离线也可以。您还可以为常用模板组合定义自己的别名，或者创建更强大的完全自定义模板。

使用方法

注意：类似于nix-search命令，此程序会向stderr打印有关使用缓存结果的消息。这不会干扰管道操作，纯粹是信息性的。您还可以选择使用--write自动将生成的忽略文件写入$CWD/.gitignore而不是管道。

更新模板

要下载和缓存所有可用的模板，请使用--update。这也可以与任何其他标志/参数组合使用，或者作为一个独立的标志运行。

$ git ignore -u
Info: Update successful

自动匹配

通过与项目或语言特定的文件和扩展名匹配，您可以自动为您生成 .gitignore。您当前目录中有 package.json 和 Cargo.toml 吗？--auto 将自动将 node 和 rust 添加到模板输出。

$ git ignore -a

### Created by https://www.gitignore.io
### Rust ###

[...]

# These are backup files generated by rustfmt
**/*.rs.bk

列出模板

要列出所有可用的模板

$ git ignore --list
  1c
  1c-bitrix
  a-frame
  actionscript
  ada
  [...]
  zukencr8000

--list 选项也用于搜索与您的输入匹配的模板。匹配是通过执行 template.contains(短语) 来完成的，因此搜索 intellij 将列出包含该短语的所有模板。您也可以一次性搜索多个模板

$ git ignore -l rust intellij

  intellij
  intellij+all
  intellij+iml
  rust

打印模板

找到模板后，您可以通过省略 -l|--list 来打印它们。**注意**：列出和搜索模板是不精确的，但打印它们需要精确匹配。

$ git ignore rust intellij+all

### Created by https://www.gitignore.io
### Rust ###

[...]

# These are backup files generated by rustfmt
**/*.rs.bk

别名

别名是合并常用模板组合的一种方式。如果您总是在前端项目中使用 node 和 visualstudiocode，您可以创建一个别名来方便访问。别名比来自 www.gitignore.io 的模板有更高的优先级，因此名为 node 的别名将用于模板。在列出所有可用的模板时，别名以黄色显示，以便您区分它们和常规模板。

列出

$ git ignore alias list
Available aliases:
node => ["node", "nextjs", "visualstudiocode"]
rust => ["rust", "intellij+all"]

添加

$ git ignore alias add node node nextjs visualstudiocode
Created alias node for ["node", "nextjs", "visualstudiocode"]

删除

$ git ignore alias remove node
Removed alias node

模板

模板是您为没有现有模板定义的事物创建的定制模板。在列出和搜索模板时具有最高优先级（templates > alias > normal）。模板以蓝色列出，以区分别名和常规模板。

列出

文件名是位于 $HOME/.config/git-ignore/templates 的文件名称。

$ git ignore template list
Available templates:
docs => "docs.txt"

添加

所有模板都是在 $HOME/.config/git-ignore/templates 中创建的。因此，您为文件提供的名称是此目录中使用的文件名。

$ git ignore template add docs docs.txt
Created template docs at ~/.config/git-config/templates/docs.txt

删除

$ git ignore template remove node
Removed template node

配置

您可以通过运行 git ignore init 来创建配置文件和目录。这将创建 $HOME/.config/git-ignore/config.toml 和 $HOME/.config/git-ignore/templates/。

配置文件是一个简单的 TOML 文件

[aliases]
node = [
    'node',
    'nextjs',
    'visualstudiocode',
]

[templates]
docs = 'docs.txt'

完成

如果您的安装方法不包括shell完成，您可以通过运行 git ignore completion <shell> 命令手动源或保存它们。