🤜🏽 🧑🏻‍🤝‍🧑🏻 👨🏼‍🎓 यास्का के लिए एक प्लगइन विकसित करने में अनुभव 👩‍👩‍👧‍👧 🦔 😼

इस लेख में मैं एक उपयोगी उपयोगिता का उपयोग करने के अनुभव को साझा करना चाहता हूं जो आपको कोड गुणवत्ता के संयोजन और विश्लेषण को स्वचालित करने की अनुमति देता है। हम Yasca के बारे में बात कर रहे हैं - मुफ्त सॉफ्टवेयर, जो कि एक छोटा PHP इंजन और जावा, C ++ या PHP कोड के विश्लेषण के लिए उपयोगिताओं का एक सेट है, जिसमें PMD, JLint और RATS शामिल हैं। इन उपयोगिताओं के निष्पादन का एकीकरण PHP भाषा में छोटे प्लगइन्स को विकसित करके किया जाता है। इस तरह के प्लगइन को विकसित करने की प्रक्रिया पर बाद में चर्चा की जाएगी।

आरंभ करने के लिए, हमें कार्य करने के लिए यास्का प्राप्त करना होगा। यह करना बहुत आसान है। हम डाउनलोड पृष्ठ पर जाते हैं और वास्तविक यास्का और कोडेक्स में से एक को डाउनलोड करते हैं। एक स्थानीय निर्देशिका बनाएं (उदाहरण के लिए c: / yasca) और बस एक-एक करके सभी अभिलेखागार को खोल दें। उसके तुरंत बाद, उपकरण उपयोग के लिए तैयार है। हम कमांड लाइन में टाइप करते हैं (या cmd-file में सेव करते हैं) कमांड (कुछ जावा या C ++ प्रोजेक्ट के साथ डायरेक्टरी के लिए एलिप्स को रिप्लेस करते हैं):

yasca.exe -o ./Report ...

कुछ समय के लिए काम करने के बाद, यास्का हमारे प्रोजेक्ट की कोडिंग शैली पर टिप्पणी करने वाली एक रिपोर्ट। रिपोर्ट लाइनों में स्रोत कोड के लिंक होते हैं, और केवल एक चीज जो असुविधाजनक होती है वह यह है कि जब हम लिंक पर क्लिक करते हैं, तो हम फ़ाइल की शुरुआत में पहुंच जाते हैं, और संख्या द्वारा वांछित रेखा की तलाश करना थोड़ा थकाऊ हो सकता है। यह वही है जो मैं तय करने का प्रस्ताव देता हूं। स्रोत कोड की इच्छित लाइन पर लिंक को तुरंत हमें स्थिति दें।

यह स्पष्ट है कि हम इस तरह के फोकस को सीधे स्रोत ग्रंथों के साथ क्रैंक नहीं कर पाएंगे, लेकिन हम उनके आधार पर अस्थायी HTML फ़ाइलों का निर्माण कर सकते हैं, नाम के रूप में लाइन नंबर का उपयोग करके प्रत्येक पंक्ति में एक बुकमार्क का गठन किया है। उसी समय, बाईं ओर, हम लाइन नंबर डालेंगे ताकि यह नेविगेट करने में अधिक सुविधाजनक हो। यह डरावना लगता है, लेकिन वास्तव में, यह काफी सरल है। प्लगइन खुद को (इसे मिरर फोल्डर में मिरर .php नाम देना होगा) इस तरह दिखेगा:

 <?php /** * @extends Plugin * @package Yasca */ class Plugin_Mirror extends Plugin { public $valid_file_types = array("java", "c", "cpp", "h", "cs", "sql"); function rmdir_recurse($path) { $path= rtrim($path, '/').'/'; $handle = opendir($path); for (;false !== ($file = readdir($handle));) if($file != "." and $file != ".." ) { $fullpath= $path.$file; if( is_dir($fullpath) ) { $this->rmdir_recurse($fullpath); rmdir($fullpath); } else unlink($fullpath); } closedir($handle); } function execute() { $yasca =& Yasca::getInstance(); static $once = true; if ($once) { $this->rmdir_recurse('./Mirror'); } $once = false; if (!check_in_filetype($this->filename, $this->valid_file_types)) { return; } $filename = preg_replace('/\w:/', './Mirror', $this->filename) . ".html"; $dir_name = preg_replace('/[\\\\\\/][^\\\\\\/]+$/', '', $filename); if (!file_exists($dir_name)) { if (!mkdir($dir_name, 0777, true)) return; } if (file_exists($filename)) { unlink($filename); } if (!$handle = fopen($filename, 'w+', true) ) return; fwrite($handle,"<html><meta http-equiv=\"Content-Type\" content=\"text/html;charset=windows-1251\" /><head></head><body><pre>\n"); $line = 1; foreach ($this->file_contents as $file_line) { $str = $line; while (strlen($str)<5) { $str = " " . $str; } fwrite($handle,"<a name=$line></a>$str: $file_line<br>\n"); $line++; } fwrite($handle,"</pre></body></html>"); fclose($handle); } } ?>

अब, यास्का के अगले लॉन्च के बाद, हमें एचटीएमएल-तैयार फॉर्म में मिरर निर्देशिका में सभी विश्लेषण की गई फ़ाइलों की प्रतियां मिलती हैं। इन फ़ाइलों को उपयोगी बनाने के लिए, हमें रिपोर्ट के निर्माण की प्रक्रिया में हस्तक्षेप करना होगा और उन लिंक्स को बदलना होगा जो हमारे संस्करण के साथ उत्पन्न होते हैं। सौभाग्य से, यह कोड PHP में भी लिखा गया है। हम कार्यशील निर्देशिका में जाते हैं और वहाँ HTMLGroupReport.php फ़ाइल को डिफ़ॉल्ट रूप से रिपोर्ट बनाने के लिए उपयोग करते हैं। इस फ़ाइल में, हम टुकड़ा पाते हैं:

 fwrite($handle, "<a style=\"margin-right: 12px;\" source_code_link=\"true\" href=\"file://$filename\" target=\"_blank\" title=\"$filename\">$filename_base$line_number_field</a>" . "</td>");

और इसे बदलें:

 $chg_file_name = getcwd(); $chg_file_name = preg_replace('/\\\\/', '/', $chg_file_name); $chg_file_name = preg_replace('/^\w:/', $chg_file_name . '/Mirror', $filename); if (preg_match('/\.java$|\.c$|\.cpp$|\.h$|\.cs$|\.sql$/i', $chg_file_name)) { fwrite($handle, "<a style=\"margin-right: 12px;\" source_code_link=\"true\" href=\"file://$chg_file_name.html#$line_number\" target=\"code\" title=\"$filename\">$filename_base$line_number_field</a>" . "</td>"); } else { fwrite($handle, "<a style=\"margin-right: 12px;\" source_code_link=\"true\" href=\"file://$filename\" target=\"_blank\" title=\"$filename\">$filename_base$line_number_field</a>" . "</td>"); }

फिर हम यास्का को फिर से लॉन्च करते हैं और सुनिश्चित करते हैं कि सब कुछ काम करता है। आगे स्वचालन के संदर्भ में, हमारी कल्पना बहुत सीमित नहीं है। उदाहरण के लिए, हमारे पास एक प्लग-इन था जो MSBuild का उपयोग करके विंडोज के लिए एक बड़े C ++ प्रोजेक्ट की असेंबली को स्वचालित करता है। चूंकि असेंबली में लगभग एक घंटे का समय लगता था, इसलिए यास्का और कोडेक्स के काम से जुड़ी थोड़ी सी भी सुस्ती नहीं थी। लेकिन आउटपुट में हमें एक रिपोर्ट मिली, जिसमें कोड स्टाइल पर वार्निंग और कमेंट दोनों थे, सोर्स कोड में सुविधाजनक पोजिशनिंग के साथ।

यास्का के लिए एक प्लगइन विकसित करने में अनुभव

More articles: