دستورالعملهای مشارکت: کد قالب و لینتینگ

Summarize this content to 400 words in Persian Lang
مقدمه
در طول این هفته آزمایشگاه ما وظیفه داشتیم اضافه کنیم CONTRIBUTING.md فایلی که در آن باید دستورالعمل هایی را برای همه مشارکت کنندگان در مورد نحوه مشارکت در پروژه PolyglotCode اضافه کنیم. علاوه بر این، ما قرار بود یک را اضافه کنیم Code Formatter تا کد خود را ساختارمندتر کنیم و a را اضافه کنیم Linter تا مطمئن شوید که کد از استایل پیروی می کند.
ابزارهایی که استفاده کردم
ما فهرستی از ابزارهای پیشنهادی تشکیل کد داشتیم، زیرا کد من در آن نوشته شده بود Java تصمیم گرفتم از قالبکننده پیشنهادی GoogleJavaFormat استفاده کنم. با این حال، من تصمیم به انتخاب ابزار پیشنهادی برای Linter. من Checkstyle را انتخاب کردم. به این دلیل که SpotBugs در دسترس نبود برای JDK 22.
راه اندازی
برای راه اندازی هر دوی این ابزارها از داخل آن استفاده کردم pom.xml فایل
GoogleJavaFormat:
CheckStyle:
برای تعیین قوانین CheckStyle ما باید یک فایل به نام ایجاد کنیم checkstyle.xml:
چه ابزارهایی پیدا شد
GoogleJavaFormat فقط ظاهر کد را تغییر داد، عملکردی مشابه دارد Prettier. CheckStyle چند مشکل در واردات استفاده نشده پیدا شد.
به این دلیل، که من استفاده می کنم Maven من از دستورات استفاده کردم:
mvn spotless:apply
وارد حالت تمام صفحه شوید
از حالت تمام صفحه خارج شوید
و
mvn checkstyle:check
وارد حالت تمام صفحه شوید
از حالت تمام صفحه خارج شوید
نحوه ادغام با IDE
برای ادغام همه آن با IDE ما از Intellij IDEA Marketplace استفاده می کنیم و همه آنها را دانلود می کنیم.
چی یاد گرفتم
امروز یاد گرفتم که داشتن ابزارهایی مانند این بسیار مهم است Code Formatter و Linter برای اطمینان از اینکه سایر مشارکت کنندگان پس از اتمام مشارکت خود می توانند همان سبک کد را حفظ کنند.
مقدمه
در طول این هفته آزمایشگاه ما وظیفه داشتیم اضافه کنیم CONTRIBUTING.md
فایلی که در آن باید دستورالعمل هایی را برای همه مشارکت کنندگان در مورد نحوه مشارکت در پروژه PolyglotCode اضافه کنیم. علاوه بر این، ما قرار بود یک را اضافه کنیم Code Formatter
تا کد خود را ساختارمندتر کنیم و a را اضافه کنیم Linter
تا مطمئن شوید که کد از استایل پیروی می کند.
ابزارهایی که استفاده کردم
ما فهرستی از ابزارهای پیشنهادی تشکیل کد داشتیم، زیرا کد من در آن نوشته شده بود Java
تصمیم گرفتم از قالبکننده پیشنهادی GoogleJavaFormat استفاده کنم.
با این حال، من تصمیم به انتخاب ابزار پیشنهادی برای Linter
. من Checkstyle را انتخاب کردم. به این دلیل که SpotBugs
در دسترس نبود برای JDK 22
.
راه اندازی
برای راه اندازی هر دوی این ابزارها از داخل آن استفاده کردم pom.xml
فایل
GoogleJavaFormat
:
CheckStyle
:
برای تعیین قوانین CheckStyle
ما باید یک فایل به نام ایجاد کنیم checkstyle.xml
:
چه ابزارهایی پیدا شد
GoogleJavaFormat
فقط ظاهر کد را تغییر داد، عملکردی مشابه دارد Prettier
. CheckStyle
چند مشکل در واردات استفاده نشده پیدا شد.
به این دلیل، که من استفاده می کنم Maven
من از دستورات استفاده کردم:
mvn spotless:apply
و
mvn checkstyle:check
نحوه ادغام با IDE
برای ادغام همه آن با IDE ما از Intellij IDEA Marketplace استفاده می کنیم و همه آنها را دانلود می کنیم.
چی یاد گرفتم
امروز یاد گرفتم که داشتن ابزارهایی مانند این بسیار مهم است Code Formatter
و Linter
برای اطمینان از اینکه سایر مشارکت کنندگان پس از اتمام مشارکت خود می توانند همان سبک کد را حفظ کنند.