纯前端实现的 .gitignore 生成器技术实现

关键词:.gitignore、Git 忽略规则、技术栈勾选、纯前端、JavaScript、版本控制


一、背景与需求

在使用 Git 进行版本控制时,.gitignore 文件用于告知 Git 哪些文件或目录不应被追踪。正确配置 .gitignore 可以避免将依赖目录、编译产物、日志文件、环境变量文件等不应提交的内容纳入版本控制,保持仓库整洁。

但手动编写 .gitignore 存在以下痛点:

  • 不同语言和框架的忽略规则各不相同,开发者需要反复查阅文档或从其他项目复制;
  • 容易遗漏某些常见产物(如 .DS_Store、node_modules/、target/、.env 等);
  • 多技术栈混合项目(如前后端分离)需要合并多个规则集,手动合并容易出错;
  • 部分在线生成工具需要注册登录,或将选择的技术栈上传到服务器,项目技术栈信息泄露风险较高。

基于此,我开发了 Toolion .gitignore 生成器 (toolion.cn/gitignore-g... .gitignore 文件生成工具,支持按编程语言和框架勾选生成,全部处理在浏览器本地完成,无需登录,免费使用。


二、核心功能

功能模块 说明
按技术栈勾选 支持操作系统、编辑器/IDE、前端、后端、移动端、环境与配置六大类,共计数十种技术栈
全选与清空 一键全选所有技术栈,或清空当前选择
实时生成 勾选变化后立即生成 .gitignore 内容,右侧实时预览
一键复制 将生成的内容复制到剪贴板,支持 navigator.clipboard 与 execCommand 降级
文件下载 将生成的内容下载为 .gitignore 文件,文件名固定为 .gitignore
默认勾选 页面加载时自动勾选 Node.js、macOS、Windows、Env 文件等常用项
纯前端本地处理 所有规则拼接与生成在浏览器内完成,不上传任何数据,支持离线运行
免费无需注册 打开页面即可使用,无登录、无订阅、无水印
深色/浅色主题 CSS 变量适配深色模式,状态持久化到本地存储

三、技术实现

3.1 整体架构

该工具是一个纯前端单页面应用(单 HTML 文件),未引入 Vue/React 等前端框架,全部逻辑使用原生 JavaScript 实现:

go 复制代码
浏览器端(纯原生 JavaScript)
├── 数据层:TEMPLATES 规则库(6 大类、数十种技术栈、数百条忽略规则)
├── 输入层:复选框勾选面板(分类标题 + 复选框网格)、全选/清空按钮
├── 生成层:按勾选项拼接 `.gitignore` 内容(带分类标题注释与空行分隔)
├── 输出层:结果文本框、复制按钮、下载按钮(生成 Blob + URL.createObjectURL)
└── 渲染层:勾选 UI 状态(checked 类)、按钮禁用状态、深色/浅色主题

3.2 规则库设计

规则库 TEMPLATES 按类别组织,每个类别下包含多种技术栈,每种技术栈对应一组忽略规则数组:

javascript 复制代码
const TEMPLATES = {
  '操作系统': {
    'macOS': ['.DS_Store', '._*', '.Spotlight-V100', '.Trashes', 'ehthumbs.db', 'Thumbs.db'],
    'Windows': ['Thumbs.db', 'ehthumbs.db', 'Desktop.ini', '$RECYCLE.BIN/', '*.cab', '*.msi', '*.msm', '*.msp'],
    'Linux': ['*~', '.directory', '.fuse_hidden*', '.Trash-*']
  },
  '编辑器/IDE': {
    'VS Code': ['.vscode/', '!.vscode/extensions.json', '!.vscode/settings.json'],
    'IntelliJ IDEA': ['.idea/', '*.iml', '*.iws', '*.ipr', 'out/', '.idea_modules/'],
    'Vim': ['*.swp', '*.swo', '*~', '.vim/'],
    'Sublime Text': ['*.sublime-workspace', '*.sublime-project'],
    'Eclipse': ['.metadata/', 'bin/', 'tmp/', '*.tmp', '*.bak', '*.swp', '.classpath', '.project', '.settings/']
  },
  '前端': {
    'Node.js': ['node_modules/', 'npm-debug.log*', 'yarn-debug.log*', 'yarn-error.log*', 'pnpm-debug.log*', '.pnpm-debug.log*', 'lerna-debug.log*', '.npm', '.eslintcache', '.nyc_output'],
    'React/Vue/Next.js': ['.next/', 'out/', 'build/', 'dist/', '.cache/', '.temp/', '.nuxt/', '.vuepress/dist/', '.docusaurus/'],
    'Vite': ['.vite/', 'dist-ssr/'],
    'Yarn / NPM': ['.yarn/*', '!.yarn/patches', '!.yarn/releases', '!.yarn/plugins', '!.yarn/sdks', '!.yarn/versions']
  },
  '后端': {
    'Python': ['__pycache__/', '*.py[cod]', '*$py.class', '*.so', '.Python', 'build/', 'develop-eggs/', 'dist/', 'downloads/', 'eggs/', '.eggs/', 'lib/', 'lib64/', 'parts/', 'sdist/', 'var/', 'wheels/', 'share/python-wheels/', '*.egg-info/', '.installed.cfg', '*.egg', 'MANIFEST', '.env', '.venv', 'env/', 'venv/', 'ENV/', 'env.bak/', 'venv.bak/', '.pytest_cache/', '.coverage', 'htmlcov/'],
    'Java': ['*.class', '*.log', '*.jar', '*.war', '*.nar', '*.ear', '*.zip', '*.tar.gz', '*.rar', 'hs_err_pid*', 'target/', 'build/', 'out/', '.gradle/', '.mvn/'],
    'Go': ['*.exe', '*.exe~', '*.dll', '*.so', '*.dylib', '*.test', '*.out', 'vendor/', 'go.work', 'go.work.sum'],
    'Rust': ['target/', 'Cargo.lock', '**/*.rs.bk', '*.pdb'],
    'PHP': ['vendor/', 'composer.lock', '.env', '.phpunit.result.cache', 'storage/*.key', 'public/storage']
  },
  '移动端': {
    'Android': ['*.apk', '*.aar', '*.aab', '*.ap_', '*.dex', 'local.properties', 'bin/', 'gen/', 'out/', '.gradle/', 'captures/', '.externalNativeBuild/', '.cxx/'],
    'iOS / Swift': ['xcuserdata/', '*.xcworkspace/xcuserdata/', '*.xcodeproj/xcuserdata/', 'DerivedData/', 'build/', '*.moved-aside', '*.hmap', '*.ipa', '*.dSYM.zip', '*.dSYM', 'Pods/', 'Carthage/Build/']
  },
  '环境与配置': {
    'Env 文件': ['.env', '.env.local', '.env.*.local', '.env.development.local', '.env.test.local', '.env.production.local'],
    '配置与缓存': ['*.log', 'logs/', '*.pid', '*.seed', '*.pid.lock', '.cache/', '.tmp/', '.temp/', 'tmp/', 'temp/', 'coverage/', '.sass-cache/', '.eslintcache']
  }
};

关键点:

  • 分类清晰:操作系统、编辑器/IDE、前端、后端、移动端、环境与配置,覆盖主流开发场景;
  • 规则精准:每个技术栈包含该栈常见的构建产物、依赖目录、日志文件、配置文件等;
  • 否定模式支持 :VS Code 模式中包含 !.vscode/extensions.json 等否定规则,保留部分配置文件不被忽略。

3.3 复选框 UI 渲染

规则库渲染为分类标题 + 复选框网格,每个复选框的 value 采用 category|tech 格式,便于后续拆分:

javascript 复制代码
function renderCheckboxes() {
  let html = '';
  let idx = 0;
  for (const category in TEMPLATES) {
    html += `<div class="category-title">${category}</div>`;
    html += `<div class="checkbox-grid">`;
    for (const tech in TEMPLATES[category]) {
      // 使用累加索引生成 ID,避免纯中文名称处理后为空
      const id = 'chk-' + idx++;
      html += `
        <label class="checkbox-label" for="${id}">
          <input type="checkbox" id="${id}" value="${category}|${tech}">
          <span>${tech}</span>
        </label>
      `;
    }
    html += `</div>`;
  }
  container.innerHTML = html;

  container.querySelectorAll('input[type="checkbox"]').forEach(chk => {
    chk.addEventListener('change', (e) => {
      const label = e.target.closest('.checkbox-label');
      if (label) {
        label.classList.toggle('checked', e.target.checked);
      }
      updateOutput();
    });
  });
}

关键点:

  • ID 唯一性修复 :早期版本使用 tech.replace(/[^a-zA-Z0-9]/g, '') 生成 ID,纯中文名称(如「配置与缓存」)处理后会变成空字符串,导致 ID 为 chk-,既不唯一也不规范。修复后使用累加索引 chk-0、chk-1 等,保证 ID 唯一且合法;
  • UI 状态联动 :勾选/取消勾选时,通过 classList.toggle('checked', ...) 更新标签样式,提供视觉反馈;
  • 实时更新 :每次勾选变化均触发 updateOutput(),右侧结果立即刷新。

3.4 .gitignore 内容生成

updateOutput 函数按勾选项拼接最终内容:

javascript 复制代码
function updateOutput() {
  const checkboxes = container.querySelectorAll('input[type="checkbox"]:checked');
  if (checkboxes.length === 0) {
    outputData.value = '';
    outputData.placeholder = '请在上方勾选技术栈...';
    btnCopy.disabled = true;
    btnDownload.disabled = true;
    return;
  }

  let resultLines = ['# 由 Toolion .gitignore 生成器生成', ''];

  checkboxes.forEach(chk => {
    const val = chk.value;
    const sepIdx = val.indexOf('|');
    const category = val.slice(0, sepIdx);
    const tech = val.slice(sepIdx + 1);
    const rules = TEMPLATES[category] && TEMPLATES[category][tech];

    if (!rules) return;

    resultLines.push(`# --- ${tech} ---`);
    rules.forEach(rule => resultLines.push(rule));
    resultLines.push(''); // 空行分隔
  });

  outputData.value = resultLines.join('\n').trim();
  btnCopy.disabled = false;
  btnDownload.disabled = false;
}

关键点:

  • 文件头注释 :生成内容以 # 由 Toolion .gitignore 生成器生成 开头,标注来源;
  • 技术栈分节 :每个选中的技术栈以 # --- ${tech} --- 作为分节标题,便于阅读和定位;
  • 空行分隔:各技术栈规则之间插入空行,提高可读性;
  • 按钮状态控制:未勾选任何项时,复制和下载按钮保持禁用,避免无效操作。

3.5 全选与清空

javascript 复制代码
btnSelectAll.addEventListener('click', () => {
  container.querySelectorAll('input[type="checkbox"]').forEach(chk => {
    chk.checked = true;
    const label = chk.closest('.checkbox-label');
    if (label) label.classList.add('checked');
  });
  updateOutput();
});

btnClear.addEventListener('click', () => {
  container.querySelectorAll('input[type="checkbox"]').forEach(chk => {
    chk.checked = false;
    const label = chk.closest('.checkbox-label');
    if (label) label.classList.remove('checked');
  });
  updateOutput();
});

3.6 默认勾选

页面加载后自动勾选 Node.js、macOS、Windows、Env 文件等常用项,减少用户重复操作:

javascript 复制代码
const defaultChecked = ['Node.js', 'macOS', 'Windows', 'Env 文件'];
container.querySelectorAll('input[type="checkbox"]').forEach(chk => {
  const val = chk.value;
  const sepIdx = val.indexOf('|');
  const tech = val.slice(sepIdx + 1);
  if (defaultChecked.includes(tech)) {
    chk.checked = true;
    const label = chk.closest('.checkbox-label');
    if (label) label.classList.add('checked');
  }
});
updateOutput();

3.7 复制与下载

复制 :优先使用 navigator.clipboard.writeText,非 HTTPS 环境或权限被拒时降级为临时 textarea 配合 document.execCommand('copy'):

javascript 复制代码
btnCopy.addEventListener('click', () => {
  const text = outputData.value;
  if (!text) return;

  const done = function () {
    btnCopy.textContent = '已复制';
    setTimeout(function () { btnCopy.textContent = '复制'; }, 1500);
  };

  if (navigator.clipboard && window.isSecureContext) {
    navigator.clipboard.writeText(text).then(done).catch(function () {
      fallbackCopy(text, done);
    });
  } else {
    fallbackCopy(text, done);
  }
});

function fallbackCopy(text, done) {
  try {
    const ta = document.createElement('textarea');
    ta.value = text;
    ta.style.cssText = 'position:fixed;top:-9999px;left:-9999px;opacity:0;';
    document.body.appendChild(ta);
    ta.select();
    const ok = document.execCommand('copy');
    document.body.removeChild(ta);
    if (ok) done();
    else alert('复制失败,请手动选择复制。');
  } catch (e) {
    alert('复制失败,请手动选择复制。');
  }
}

下载 :将内容封装为 Blob,通过 URL.createObjectURL 创建下载链接,文件名固定为 .gitignore:

javascript 复制代码
btnDownload.addEventListener('click', () => {
  const text = outputData.value;
  if (!text) return;

  const blob = new Blob([text], { type: 'text/plain;charset=utf-8' });
  const url = URL.createObjectURL(blob);
  const a = document.createElement('a');
  a.href = url;
  a.download = '.gitignore';
  document.body.appendChild(a);
  a.click();
  document.body.removeChild(a);
  // 延迟释放 URL,避免 Safari / 部分 Firefox 下载尚未开始 URL 即被回收
  setTimeout(function () { URL.revokeObjectURL(url); }, 1000);
});

关键点:

  • Blob MIME 类型 :使用 text/plain;charset=utf-8,确保中文注释正确编码;
  • 延迟 revoke :URL.revokeObjectURL 延迟 1000ms 释放,避免部分浏览器(Safari / 部分 Firefox)在下载尚未开始时 URL 就被释放导致下载失败;
  • 文件名固定 :.gitignore 是 Git 约定的文件名,直接使用。

3.8 主题适配

全站使用 CSS 变量定义配色,深色模式下自动切换为深色配色方案,状态持久化到 localStorage:

css 复制代码
:root { --bg: #f4f6fa; --card: #fff; --ink: #14213d; --brand: #0f4c81; ... }
[data-theme="dark"] { --bg: #0f172a; --card: #1e293b; --ink: #f8fafc; --brand: #38bdf8; ... }

四、关键技术挑战与解决方案

挑战 解决方案
纯中文技术栈名称生成 ID 为空 改用累加索引 chk-N 生成复选框 ID,保证唯一性与合法性
未勾选任何项时复制/下载无反应 检测 checkboxes.length === 0,禁用两个按钮并显示占位提示
非 HTTPS 环境下剪贴板 API 不可用 navigator.clipboard 优先,失败后降级为临时 textarea + execCommand('copy')
Safari / 部分 Firefox 下载失败 URL.revokeObjectURL 延迟 1000ms 释放,确保下载已开始
多技术栈规则合并可读性差 每个技术栈以 # --- tech --- 分节,之间插入空行
纯前端无后端依赖 所有规则拼接与文件生成在浏览器本地完成,不上传任何数据

五、使用示例

场景 1:为 Node.js + Vue + macOS 项目生成 .gitignore

  1. 打开 https://toolion.cn/gitignore-generator/;

  2. 在左侧勾选面板中勾选"macOS"、"Node.js"、"React/Vue/Next.js"、"Env 文件";

  3. 右侧实时生成内容: # 由 Toolion .gitignore 生成器生成

    lua 复制代码
    # --- macOS ---
    .DS_Store
    ._*
    .Spotlight-V100
    .Trashes
    ehthumbs.db
    Thumbs.db
    
    # --- Node.js ---
    node_modules/
    npm-debug.log*
    ...
    
    # --- React/Vue/Next.js ---
    .next/
    out/
    build/
    dist/
    ...
    
    # --- Env 文件 ---
    .env
    .env.local
    ...
  4. 点击"复制"将内容复制到剪贴板,或点击"下载文件"保存为 .gitignore。

场景 2:Java + IntelliJ IDEA + Maven 项目

  1. 勾选"Windows"、"IntelliJ IDEA"、"Java"、"Env 文件";
  2. 生成内容包含 .idea/、*.iml、target/、*.class、*.jar、.env 等规则;
  3. 下载 .gitignore 并放置在项目根目录。

场景 3:全选所有技术栈

  1. 点击"全选"按钮,所有复选框被选中;
  2. 右侧生成包含所有类别规则的完整 .gitignore,适用于复杂的多技术栈仓库;
  3. 根据实际项目需求删除不需要的规则后再使用。

注意事项:

  • 生成的规则为行业通用标准,具体项目应根据实际需求进行增删调整;
  • .gitignore 仅对未被 Git 追踪的文件生效,已提交的文件需要先使用 git rm --cached 移出缓存区;
  • 所有数据仅在浏览器本地处理,技术栈选择不会上传到服务器,适合处理一般项目配置;
  • 页面刷新后选择将丢失,生成的文件建议及时下载保存。

六、免责声明

本文仅提供技术实现分享,相关工具仅供学习与日常便利使用,不构成任何商业建议。生成的 .gitignore 规则为行业通用标准,不同项目构建工具和版本可能存在差异,使用前请根据实际项目需求进行调整。所有数据仅在浏览器本地内存中处理,不上传服务器,页面关闭后即从内存释放。


七、总结

本文介绍了一种纯前端实现的 .gitignore 生成方案。核心设计思路:

  1. 技术栈勾选生成:按操作系统、编辑器/IDE、前端、后端、移动端、环境与配置六大类勾选,灵活组合;
  2. 规则库结构化 :TEMPLATES 对象按类别和技术栈组织忽略规则,维护与扩展方便;
  3. ID 唯一性保障:复选框 ID 使用累加索引,避免纯中文名称处理后为空;
  4. 分节生成内容:每个技术栈以注释标题分节,之间插入空行,提高可读性;
  5. 按钮状态控制:无勾选项时禁用复制和下载按钮,避免无效操作;
  6. 复制与下载 :navigator.clipboard 优先,execCommand 降级;下载使用 Blob + 延迟 revoke,兼容 Safari / Firefox;
  7. 隐私优先:全部处理在浏览器本地完成,技术栈选择不上传服务器,无需登录,免费使用;
  8. 主题适配:CSS 变量支持深色/浅色模式切换,状态持久化。

该方案适合需要轻量级、纯前端 .gitignore 生成能力的场景,可作为前端开发辅助工具页面的技术参考。


#.gitignore #Git忽略规则 #纯前端 #JavaScript #版本控制 #本地处理 #隐私安全 #开发者工具 #前端开发 #工具开发


相关推荐
bai2739 分钟前
同一个 JSON,Node 读出了三种坏法:Windows 上四种写法的编码实测
前端
小y的笔记18 分钟前
Vue 3 异步搜索实战:watch、请求取消与竞态控制
前端·javascript
sanxing三省39 分钟前
DeepSeek Harness 到底是什么?标题里最重的词其实不是「DeepSeek」
前端·人工智能·deepseek
jianqiang.xue41 分钟前
把Agent塞进MCU:工具次数和上下文长度怎么卡
java·前端·网络·单片机·esp32·ai编程
前端小万2 小时前
思考,行动,复盘|2026
前端·后端·面试
拖孩2 小时前
# 我又用 AI 做了个小程序:24 天,记录我这辈子认识的人
前端·后端·微信小程序
徐小夕2 小时前
深度拆解 Design Agent:LangChain 出品,AI 设计从「好看」走向「可用」
前端·vue.js·github
1-1=03 小时前
Vue 表单数据和过滤器
前端·javascript·vue.js
oil欧哟3 小时前
Oil UI 的设计思路与日常使用方式:让 AI 摆脱默认模板并保持多页面风格统一
前端