پرش به محتوای اصلی

راهنمای سازنده‌ی ‎.gitignore

زمان مطالعه: ۲ دقیقه

این ابزار چیست؟

فایل ‎.gitignore به git می‌گوید کدام فایل‌ها نباید وارد مخزن شوند: پوشه‌ی node_modules، خروجی ساخت، فایل‌های موقت ویرایشگر، فایل .DS_Store مک و مهم‌تر از همه فایل‌های .env که رمز و کلید دارند. نوشتن دستی این فهرست برای هر پروژه خسته‌کننده است و چیزی از قلم می‌افتد.

این ابزار الگوهای رسمی مخزن github/gitignore (با مجوز CC0) را برای زبان‌ها، فریم‌ورک‌ها، ویرایشگرها و سیستم‌عامل‌ها ترکیب می‌کند و خط‌های تکراری را حذف می‌کند. الگوها همراه سایت آمده‌اند و از جای دیگری بارگیری نمی‌شوند.

گام‌به‌گام

  1. الگوها را انتخاب کنید

    از «زبان‌ها و فریم‌ورک‌ها» و «ویرایشگرها و سیستم‌عامل‌ها» هر چه پروژه‌تان دارد را انتخاب کنید؛ با «جست‌وجوی الگو» سریع‌تر پیدا می‌کنید.

  2. تکراری‌ها را حذف کنید

    «حذف خط‌های تکراری» را روشن نگه دارید تا خطی که در دو الگو آمده فقط یک بار بماند؛ تعداد خط‌های حذف‌شده نمایش داده می‌شود.

  3. خروجی را بردارید

    «خروجی gitignore» را کپی یا دانلود کنید و در ریشه‌ی مخزن با نام ‎.gitignore ذخیره کنید. نشانی صفحه انتخاب‌ها را نگه می‌دارد تا برای پروژه‌ی بعدی هم به کار ببرید.

نمونه‌های کاربردی

  • پروژه‌ی Node روی مک با VS Code

    سه الگو کنار هم، هر کدام با عنوان جدا؛ یک خط که در دو الگو تکرار شده بود حذف می‌شود.

    نتیجه: سه بخش Node، macOS و VisualStudioCode · ۱ خط تکراری حذف شد

اشتباه‌های رایج

  • افزودن .gitignore پس از کامیت فایل: فایلی که پیش‌تر وارد مخزن شده با افزودن به .gitignore بیرون نمی‌رود. آن را با git rm --cached از نمایه بردارید.
  • کامیت کردن .env: حتی اگر بعداً پاکش کنید، در تاریخچه‌ی git می‌ماند. اگر چنین شد، همه‌ی رمزها و کلیدهای داخلش را عوض کنید.
  • گذاشتن الگوی ویرایشگر شخصی در مخزن مشترک: برای تنظیم‌های خودتان می‌توانید از فایل سراسری git در خانه‌ی کاربر استفاده کنید تا فایل پروژه شلوغ نشود.
  • نادیده گرفتن کل پوشه‌ای که بخشی از آن لازم است: اگر فقط چند فایل از پوشه را می‌خواهید، پس از الگوی پوشه با ! استثنا بگذارید.

قاعده‌های کوتاه الگوها

هر خط یک الگو است. * هر نام را می‌پذیرد، ** در هر عمقی از پوشه‌ها، اسلش پایانی یعنی فقط پوشه و ! استثنا می‌سازد. خطی که با # شروع شود توضیح است.

الگوها نسبت به جای فایل ‎.gitignore خوانده می‌شوند؛ پس می‌توانید در زیرپوشه‌ها هم فایل جدا داشته باشید که فقط برای همان بخش اعمال می‌شود.

پرسش‌های متداول

الگوها از کجا آمده‌اند؟
از مخزن github/gitignore با مجوز CC0 (دامنه‌ی عمومی). شناسه‌ی commit و تاریخ برداشت در پایین صفحه آمده است.
خط‌های تکراری چطور حذف می‌شوند؟
اگر یک الگوی دقیقاً یکسان در چند الگو باشد فقط اولین بار می‌ماند. خط‌های توضیح، خط خالی و الگوهای نفی (که با ! شروع می‌شوند) همیشه حفظ می‌شوند، چون ترتیبشان معنا دارد.
فایل‌های محرمانه را هم نادیده می‌گیرد؟
الگوها فقط جلوی افزودن فایل‌ها به git را می‌گیرند. اگر فایلی قبلاً commit شده باشد باید جداگانه با git rm --cached از ردیابی خارج شود و رمزهای لو رفته باید عوض شوند.

ابزارهای مرتبط