n98n سازنده خطایابی نود

سازنده خطایابی نود n8n، eslint-plugin-n8n-nodes-base، به صورت استاتیک کد منبع نودها و اعتبارنامه‌های n98n در مخزن رسمی و بسته‌های کامیونیتی را تحلیل (lint) می‌کند. این ابزار مشکلات را شناسایی کرده و به صورت خودکار آن‌ها را اصلاح می‌کند تا به شما در رعایت بهترین شیوه‌ها کمک کند.

eslint-plugin-n8n-nodes-base حاوی مجموعه‌ای از قوانین برای فایل‌های نود (*.node.ts)، فایل‌های توضیحات منابع (*Description.ts)، فایل‌های اعتبارنامه (*.credentials.ts) و package.json بسته‌های کامیونیتی است.

راه‌اندازی

اگر از نود استارت n98n استفاده می‌کنید: در پروژه استارت، دستور npm install را اجرا کنید تا تمامی وابستگی‌ها نصب شود. پس از اتمام نصب، خطایابی در دسترس خواهد بود.

اگر از VS Code استفاده می‌کنید، افزونه ESLint VS Code را نصب کنید. برای سایر IDEها، به روش‌های یکپارچه‌سازی ESLint آنها مراجعه کنید.

ویرایش فایل پیکربندی ممنوع

.eslintrc.js شامل پیکربندی برای eslint-plugin-n8n-nodes-base است. این فایل را ویرایش نکنید.

نحوه استفاده

می‌توانید از خطایابی در یک بسته کامیونیتی یا در مخزن اصلی n98n استفاده کنید.

خطایابی

در یک بسته کامیونیتی، خطایابی خودکار پس از نصب وابستگی‌ها و قبل از انتشار بسته به npm انجام می‌شود. در مخزن اصلی n8n، خطایابی در صورت پاره‌گذاشتن کد توسط GitHub Actions به صورت خودکار اجرا می‌شود.

در هر دو حالت، VS Code در پس‌زمینه هنگام کار روی پروژه، خطاها را بررسی می‌کند. برای دیدن توضیحات کامل خطایابی و لینک‌های مربوط، بر روی خطا نگه دارید.

همچنین می‌توانید خطایابی را به صورت دستی اجرا کنید:

• اجرای npm run lint برای خطایابی و مشاهده مشکلات در کنسول خود.
• اجرای npm run lintfix برای خطایابی و اصلاح خودکار مشکلات. این ابزار تخلفات قوانین قابل اصلاح خودکار را برطرف می‌کند.

هر دو دستور می‌توانند در دایرکتوری ریشه بسته کامیونیتی یا در /packages/nodes-base/ در مخزن اصلی اجرا شوند.

استثناها

به جای اصلاح یک خطای قانون، می‌توانید برای آن استثنا قائل شوید تا خطایابی آن‌را flag نکند.

برای اضافه کردن استثنای خطایابی در VS Code: بر روی مشکل نگه دارید و روی Quick fix کلیک کنید (یا cmd+. در macOS) و گزینه Disable {rule} for this line را انتخاب کنید. تنها قوانینی که دلیل منطقی برای غیرفعال کردن دارند، برای یک خط غیرفعال شوند. اگر فکر می‌کنید خطایابی نادرست گزارشی ارائه می‌دهد، لطفاً آن را در مخزن خطایابی گزارش دهید.

برای افزودن استثنای خطایابی به یک فایل خاص، یک کامنت کد اضافه کنید. به ویژه، قوانین TSLint ممکن است در VS Code نشان داده نشوند و نیاز به غیرفعال‌سازی با کامنت دارند. برای راهنمایی بیشتر، به مستندات TSLint مراجعه کنید.