منصوبے کے بارے میں

Commitizen ٹیموں کو کمٹ میسج کنونشنز نافذ کرنے اور ان کی وضاحت کرنے میں مدد کرتا ہے جب کمٹ بنایا جا رہا ہو۔ غلط پیغام کو مسترد کرنے والے ہک کا انتظار کرنے کے بجائے، شراکت دار مطلوبہ فیلڈز کے پرامپٹس کے جواب دیتے ہیں، اور منتخب کردہ اڈاپٹر فارمیٹ شدہ کمٹ میسج تیار کرتا ہے۔ یہ ٹول npm کے ذریعے تقسیم کیا جاتا ہے اور اسے npm install -g commitizen کے ساتھ عالمی سطح پر انسٹال کیا جا سکتا ہے، npx cz کے ساتھ براہ راست چلایا جا سکتا ہے، یا پروجیکٹ devDependency کے طور پر انسٹال کیا جا سکتا ہے تاکہ ہر شراکت دار ایک ہی ورژن استعمال کرے۔ کنفیگر شدہ ریپوزٹری میں، صارفین git commit کی جگہ git cz، cz، یا git-cz چلا سکتے ہیں۔ اسے npm اسکرپٹ کے ذریعے بھی ظاہر کیا جا سکتا ہے۔ ریپوزٹری کو اڈاپٹر منتخب کر کے Commitizen-دوستانہ بنایا جاتا ہے۔ دستاویزی سیٹ اپ npm، Yarn، یا pnpm کے ساتھ commitizen init cz-conventional-changelog استعمال کرتا ہے، جو اڈاپٹر انسٹال کرتا ہے، اسے package.json میں محفوظ کرتا ہے، اور config.commitizen.path سیٹنگ شامل کرتا ہے۔ کنفیگریشن .czrc فائل میں بھی رکھی جا سکتی ہے۔ اڈاپٹر پاتھ npm پیکجز، مقامی JavaScript فائلیں، index.js والی ڈائریکٹریاں، رشتہ دار پاتھ، یا مطلق پاتھ حل کر سکتا ہے۔ Commitizen اڈاپٹر پر مبنی ہے، لہذا پروجیکٹس شائع شدہ آپشنز استعمال کر سکتے ہیں جیسے cz-conventional-changelog، cz-customizable، cz-emoji، cz-commitlint، cz-git، Jira پر مبنی اڈاپٹر، یا اپنا خود بنا سکتے ہیں۔ حسب ضرورت اڈاپٹرز Inquirer.js مثال حاصل کرتے ہیں اور commit کال بیک کے ذریعے حتمی کمٹ اسٹرنگ واپس کرتے ہیں۔ مینٹینرز کے لیے جو چاہتے ہیں کہ عام git commit کے دوران پرامپٹس ظاہر ہوں، Commitizen کو --hook آپشن کے ساتھ prepare-commit-msg Git ہک سے طلب کیا جا سکتا ہے۔ README روایتی Git ہکس اور Husky دونوں کے لیے مثالیں فراہم کرتا ہے، بشمول /dev/tty سے ان پٹ ری ڈائریکٹ کرنا تاکہ ہک انٹرایکٹو ہو سکے۔ Commitizen کا مقصد کمٹ ہکس اور متعلقہ ٹولز کے ساتھ مل کر کام کرنا ہے نہ کہ انہیں تبدیل کرنا۔ دیگر صلاحیتوں میں تمام ریپوزٹریوں میں استعمال کے لیے ~/.czrc کے ذریعے عالمی کنفیگریشن، معیاری git commit آپشنز جیسے git cz -a کی حمایت، اور ایک کثیر ریپوزٹری پیٹرن شامل ہے جہاں ٹیم ایک چھوٹا حسب ضرورت Node.js CLI شائع کر سکتی ہے جو Commitizen کو ایک مقررہ اڈاپٹر کے ساتھ بوٹسٹریپ کرتا ہے۔ git cz --retry کمانڈ ناکام ہک یا ٹیسٹ رن کے بعد پچھلی کوشش شدہ کمٹ کو دوبارہ استعمال کر سکتی ہے، جس میں ریٹری ڈیٹا ریپوزٹری پاتھ سے منسلک ہوتا ہے اور اپ گریڈ یا کیش فائل ڈیلیٹ ہونے سے ممکنہ طور پر صاف ہو سکتا ہے۔ README میں آزمائے گئے Node.js ورژن 12، 14، اور 16 درج ہیں اور npm 6 یا اس سے زیادہ درکار ہے، جبکہ یہ نوٹ کیا گیا ہے کہ یہ پرانے Node.js ورژنز پر بھی کام کر سکتا ہے۔ ذکر کردہ متعلقہ پروجیکٹس میں چینج لاگ تیار کرنے کے لیے conventional-changelog اور کمٹ میسجز کی جانچ کے لیے commitlint شامل ہیں۔