VSCode的Gitignore插件:轻松生成`.gitignore`文件

12次阅读

vscode中快速生成.gitignore文件有四种方法:一、安装GitIgnore插件图形化选择模板;二、用gitignore-cli命令行工具生成后粘贴;三、配置用户代码片段快捷插入;四、从github官方仓库直接下载模板。

VSCode的Gitignore插件:轻松生成`.gitignore`文件

如果您在使用 VSCode 进行项目开发时,需要快速为项目生成符合规范的 .gitignore 文件,但手动编写易出错且耗时,则可能是由于缺乏对常用模板的结构化支持。以下是实现该目标的多种方法:

本文运行环境:macbook Air,macos Sequoia。

一、安装并使用 gitignore 插件(GitIgnore by knisterpeter)

该插件提供图形化模板选择界面,支持数百种语言、框架和工具的预置规则,可一键生成标准 .gitignore 内容并自动写入项目根目录。

1、打开 VSCode,点击左侧活动栏的扩展图标(或按 Cmd+Shift+X)。

2、在搜索框中输入 gitignore,找到名称为 GitIgnore、作者为 knisterpeter 的插件。

3、点击“安装”按钮完成插件部署。

4、按下 Cmd+Shift+P 打开命令面板,输入并选择 GitIgnore: Create .gitignore

5、在弹出的多选列表中,勾选项目所依赖的环境,例如 nodepythonmacOSVisualStudioCode

6、确认后,插件将在当前工作区根目录自动生成 .gitignore 文件,并填充对应规则。

二、使用命令行工具 gitignore-cli 配合 VSCode

该方式通过终端调用开源命令行工具 gitignore-cli 生成内容,再粘贴至 VSCode 编辑器,适用于偏好 CLI 操作或需批量生成的场景。

1、在终端中执行 npm install -g gitignore-cli 安装全局工具(需已安装 Node.js)。

2、进入项目根目录,运行命令 gitignore node python macos vscode

3、命令将输出完整 .gitignore 内容到终端,复制全部文本。

4、在 VSCode 中新建文件,粘贴内容,保存为 .gitignore(注意无文件扩展名)。

三、利用 VSCode 内置代码片段快速插入常用规则

通过配置用户代码片段,可为不同语言类型定义快捷插入的 .gitignore 片段,无需额外插件,适合轻量级或离线环境。

1、在 VSCode 中按下 Cmd+Shift+P,输入并选择 Preferences: Configure User Snippets

2、选择 New Global Snippets file,命名为 gitignore.code-snippets

3、在打开的 jsON 文件中,填入如下结构:

“node-gitignore”: {
“prefix”: “gitignore-node”,
“body”: [“node_modules/”, “.DS_Store”, “npm-debug.log”, “.env.local”]
}

4、保存文件后,在任意 .gitignore 文件中输入 gitignore-node 并按 Tab 键,即可展开对应规则。

四、从 GitHub gitignore 仓库直接拉取模板

GitHub 官方维护的 github/gitignore 仓库包含最权威、持续更新的各类模板,可直接下载原始内容并导入 VSCode。

1、访问 https://github.com/github/gitignore 页面。

2、在仓库中定位到所需模板,例如 Python.gitignoreNode.gitignore

3、点击该文件,再点击右上角 Raw 按钮,进入纯文本页面。

4、全选并复制全部内容。

5、在 VSCode 中新建文件,粘贴内容,保存为 .gitignore

text=ZqhQzanResources