شما هرگز مجبور نخواهید بود دوباره با نظرات قدیمی TODO سر و کار داشته باشید

آیا تا به حال متوجه قدیمی بودن آن شده اید // TODO: نظراتی در پایگاه کد شما که باید از سنین قبل به آن پرداخته می شد؟ 🤔

خب پس این چطوره:

// This will raise an error:
// TODO: 2020-01-01: This is an expired TODO comment.

عالی به نظر می رسد، ها؟

بیایید بحث کنیم که چگونه می توانیم چنین کاری را انجام دهیم.

معرفی eslint-plugin-no-expired-todo-comments، ابزاری مفید که از به هم ریختن نظرات TODO با تاریخ منقضی شده در کد شما جلوگیری می کند.

در این پست وبلاگ، نصب، استفاده و مزایای استفاده از آن پلاگین کوچک برای حفظ یک پایگاه کد تمیزتر را بررسی خواهیم کرد.

Btw، کار الهام گرفته شده است @parker_codes‘s parker-codes/todo-by، آن را نیز بررسی کنید!

چیست؟

این eslint-plugin-no-expired-todo-comments یک پلاگین ESLint است که قانون جدیدی برای تشخیص نظرات TODO با تاریخ منقضی شده ارائه می دهد. این افزونه تضمین می کند که هیچ نظر TODO قدیمی در پایگاه کد خود ندارید و به شما کمک می کند کد خود را تمیز و منظم نگه دارید.

نصب و راه اندازی

می توانید به راحتی افزونه را با استفاده از npm، yarn یا pnpm نصب کنید، هر آنچه که اساساً استفاده می کنید، همانطور که در زیر نشان داده شده است:

npm install eslint-plugin-no-expired-todo-comments --save-dev
# or
yarn add eslint-plugin-no-expired-todo-comments --dev
# or
pnpm add eslint-plugin-no-expired-todo-comments --save-dev

استفاده

پس از نصب افزونه، زمان شروع استفاده از آن است! به سادگی اضافه کنید no-expired-todo-comments قانون پیکربندی ESLint شما:

// .eslintrc.js
module.exports = {
  plugins: ["no-expired-todo-comments"],
  rules: {
    "no-expired-todo-comments/no-expired-todo-comments": "error",
  },
};

اکنون، هر زمان که یک نظر TODO با تاریخ منقضی شده در پایگاه کد خود داشته باشید، ESLint خطایی ایجاد می‌کند و از شما می‌خواهد قبل از حرکت به جلو به آن بپردازید:

// This will raise an error:
// TODO: 2020-01-01: This is an expired TODO comment.

به همین سادگی!

فواید

با استفاده از eslint-plugin-no-expired-todo-comments، تو می توانی:

1. با حذف نظرات غیر ضروری و قدیمی TODO، پایگاه کد خود را تمیز و منظم نگه دارید.
2. اطمینان حاصل کنید که تیم شما در بالای وظایف خود باقی می ماند، زیرا نظرات TODO منقضی شده اکنون باعث ایجاد خطا می شود.
3. با پرداختن به موقع نظرات TODO کیفیت کد را بهبود بخشید.

کمک کردن

این پروژه از کمک های جامعه استقبال می کند! اگر با اشکال یا مشکلی مواجه شدید، لطفاً یک مشکل را در صفحه GitHub پروژه باز کنید. اگر می‌خواهید کد را به اشتراک بگذارید، لطفاً پروژه را منشعب کنید و یک درخواست کشش همراه با تغییرات خود ارسال کنید.

نتیجه

به طور خلاصه، افزونه بالا ابزار مفیدی برای حفظ یک پایگاه کد تمیز و سازمان یافته با جلوگیری از نظرات قدیمی TODO است. با استفاده از این افزونه، هرگز نگران فراموش کردن یا نادیده گرفتن وظایف مهم مدفون در کد خود نخواهید بود.

و در نهایت، یک جوک برنامه نویسی برای جمع بندی همه چیز:

چرا برنامه نویسان همیشه کریسمس و هالووین را با هم ترکیب می کنند؟ 🎃 🎄

زیرا 31 اکتبر == 25 دسامبر! 😂

برنامه نویسی مبارک، و ممکن است نظرات TODO شما دیگر هرگز فراموش نشوند! 😉

PS: اگر این چیزها را دوست داشتید – ممکن است چیز جالب دیگری را که اخیرا ساخته ام دوست داشته باشید:

من اکشن GitHub مجهز به هوش مصنوعی خود را منبع باز کرده ام که هر دوشنبه صبح لاگ ها را مستقیماً در Slack تغییر می دهد.

همچنین، بیایید در توییتر متصل شویم @maxprilutsky. 👈 😉