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

راهنمای فرمت‌کننده‌ی کد

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

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

کدی که از جایی کپی کرده‌اید، در یک خط فشرده شده یا هر کس در تیم با سلیقه‌ی خودش نوشته، خواندنش سخت است. این ابزار کد را با Prettier، قالب‌بند رایج دنیای وب، مرتب می‌کند: تورفتگی یکسان، شکستن خطوط بلند، فاصله‌گذاری استاندارد و نقل‌قول یکدست. JavaScript، JSX، TypeScript، TSX، CSS، SCSS، Less، HTML، Markdown، YAML، GraphQL و JSON پشتیبانی می‌شوند.

قالب‌بندی در یک Web Worker داخل مرورگر شما انجام می‌شود و کد جایی فرستاده نمی‌شود. تنظیم‌ها در نشانی صفحه می‌مانند تا با همکارانتان یکسان باشند.

گام‌به‌گام

  1. زبان را انتخاب کنید

    زبان کد را از فهرست بردارید؛ هر زبان افزونه‌ی Prettier خودش را فقط وقتی لازم شد بارگیری می‌کند.

  2. کد را بچسبانید

    کد را در «کد ورودی» بگذارید؛ حجم ورودی تا یک مگابایت است.

  3. سبک را تنظیم کنید

    پهنای خط، اندازه‌ی تورفتگی، «تب به‌جای فاصله»، «نقطه‌ویرگول پایان دستور»، «نقل‌قول تکی»، ویرگول پایانی و «فاصله داخل آکولاد» را مطابق سبک پروژه‌تان بگذارید.

  4. قالب‌بندی کنید

    «قالب‌بندی» را بزنید. اگر کد خطای نحوی داشته باشد، پیام خطا نمایش داده می‌شود؛ وگرنه خروجی را کپی یا دانلود کنید.

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

  • جاوااسکریپت یک‌خطی

    یک شیء و یک تابع که در یک خط فشرده شده‌اند، با تنظیم پیش‌فرض باز می‌شوند؛ پس از بارگذاری «قالب‌بندی» را بزنید.

    const a={b:1,c:[1,2,3]};function f(x){return x*2}

    نتیجه: const a = { b: 1, c: [1, 2, 3] }; function f(x) { return x * 2; }

  • CSS فشرده

    هر ویژگی در خط خودش می‌نشیند و تورفتگی دو فاصله‌ای می‌گیرد.

    a{color:red;margin:0 auto}

    نتیجه: a { color: red; margin: 0 auto; }

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

  • انتخاب زبان اشتباه: کد TypeScript با زبان JavaScript ممکن است خطای نحوی بدهد. زبان را دقیق انتخاب کنید، به‌ویژه برای JSX و TSX.
  • انتظار اصلاح خطای منطقی: قالب‌بند فقط ظاهر کد را عوض می‌کند، نه رفتارش را. اگر کد خطای نحوی دارد، اول آن را رفع کنید.
  • قالب‌بندی با تنظیمی جدا از پروژه: اگر پروژه فایل پیکربندی Prettier دارد، همان تنظیم‌ها را این‌جا بگذارید تا تفاوت بی‌دلیل در مخزن نسازید.
  • چسباندن کد محرمانه در ابزارهای آنلاین ناشناخته: این ابزار کد را جایی نمی‌فرستد، اما این عادت را در جاهای دیگر نداشته باشید.

چرا قالب‌بند خودکار؟

بحث درباره‌ی فاصله و نقل‌قول در بازبینی کد وقت تیم را می‌گیرد و چیزی به کیفیت اضافه نمی‌کند. قالب‌بند خودکار یک سبک ثابت را به همه‌ی کدها اعمال می‌کند تا بازبینی فقط روی منطق متمرکز شود.

Prettier کد را تجزیه می‌کند و دوباره از صفر می‌نویسد؛ برای همین خروجی برای یک ورودی و یک تنظیم همیشه یکسان است، مهم نیست کد اول چطور نوشته شده بود.

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

کد من به سرور فرستاده می‌شود؟
نه. Prettier در یک وب‌ورکر داخل مرورگر شما اجرا می‌شود و کد هیچ‌جا ارسال نمی‌شود.
چرا خطای نحوی می‌گیرم؟
Prettier فقط کدی را قالب‌بندی می‌کند که معتبر باشد. شماره‌ی سطر و ستون خطا نمایش داده می‌شود تا بتوانید آن را اصلاح کنید.
تنظیمات در نشانی صفحه ذخیره می‌شود؟
بله، فقط تنظیمات (زبان، پهنای سطر و…) در نشانی می‌آید تا بتوانید پیکربندی را به اشتراک بگذارید؛ خود کد هرگز در نشانی نیست.

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