13.9. تحلیل ایستا
نیکس برای تحلیل ایستای کد C++ از clang-tidy استفاده میکند. این کار به شناسایی اشکالها، اعمال استانداردهای کدنویسی و حفظ کیفیت کد کمک میکند.
اجرای محلی clang-tidy
برای اجرای clang-tidy روی کل پایگاهکد در شل توسعه:
$ nix develop .#native-clangStdenv
$ configurePhase
$ meson compile -C build clang-tidyاین کار تمامی فایلهای کدهای منبع C++ را تحلیل کرده و هرگونه هشدار را گزارش میکند.
برای اعمال خودکار اصلاحات مربوط به هشدارهای خاص:
$ meson compile -C build clang-tidy-fixهشدار
پیش از کامیت کردن، تغییرات را بررسی کنید، زیرا اصلاحات خودکار ممکن است همیشه درست نباشند.
ادغام CI
ابزار clang-tidy بهطور خودکار در هر پول ریکوئست (pull request) از طریق GitHub Actions اجرا میشود.
کار CI عبارت .#hydraJobs.clangTidy.x86_64-linux را میسازد که کارهای زیر را انجام میدهد:
- تمام کامپوننتها را در حالت دیباگ (برای کامپایل سریعتر) میسازد.
- ابزار clang-tidy را روی هر کامپوننت اجرا میکند.
- اگر هرگونه هشداری پیدا شود، با خطا مواجه میشود (هشدارها بهعنوان خطا در نظر گرفته میشوند).
پیکربندی
پیکربندی clang-tidy در فایل .clang-tidy در ریشه مخزن قرار دارد (که یک پیوند نمادین از nix-meson-build-support/common/clang-tidy/.clang-tidy است).
سرکوب هشدارها
اگر یک هشدار مثبت کاذب (false positive) باشد، میتوانید آن را به چندین روش سرکوب کنید:
- سرکوب درونخطی (برای موارد خاص ترجیح داده میشود):
// NOLINTBEGIN(bugprone-some-check)
... code ...
// NOLINTEND(bugprone-some-check)یا برای یک خط تکی:
int x = something(); // NOLINT(bugprone-some-check)- فایل پیکربندی (برای غیرفعالسازی در سطح کل پروژه):
این بررسی را به فهرست غیرفعالشده در
.clang-tidyاضافه کنید:
Checks:
- -bugprone-some-check # Reason for disabling- بررسی گزینهها (برای پیکربندی رفتار بررسی):
CheckOptions:
bugprone-reserved-identifier.AllowedIdentifiers: '__some_identifier'افزودن بررسیهای جدید
برای فعال کردن بررسیهای اضافی:
- فایل
nix-meson-build-support/common/clang-tidy/.clang-tidyرا ویرایش کنید. - بررسی مورد نظر را به فهرست
Checksاضافه کنید. - ابزار
clang-tidyرا به صورت محلی اجرا کنید تا تأثیر آن را ببینید. - هرگونه هشدار جدید را برطرف کنید یا در صورت نیاز، زیرمجموعه بررسیهای خاصی را غیرفعال کنید.
افزونه سفارشی clang-tidy
پروژه Nix شامل زیرساختی برای بررسیهای سفارشی clang-tidy در پوشهٔ src/clang-tidy-plugin/ است.
این بررسیها میتوانند الگوهای کدنویسی مخصوص Nix را اعمال کنند که توسط بررسیهای استاندارد clang-tidy پوشش داده نمیشوند.
برای افزودن یک بررسی سفارشی جدید:
- پیادهسازی بررسی را در
src/clang-tidy-plugin/اضافه کنید. - آن را در
nix-clang-tidy-checks.ccثبت کنید. - آن را در فایل
.clang-tidyبا پیشوندnix-فعال کنید.