ক্ল্যাং-ফরম্যাট ইন্ডেন্টেশনের সাথে কিভাবে C++ চেইনড মেথড কল সারিবদ্ধ করবেন

পারফেক্ট ইন্ডেন্টেশনের জন্য ক্ল্যাং-ফরম্যাট আয়ত্ত করা

প্রতিটি বিকাশকারী পরিষ্কার, পঠনযোগ্য কোড পছন্দ করে, বিশেষ করে যখন কাজ করে শৃঙ্খলিত পদ্ধতি কল C++ এ। তবুও, আমরা সকলেই যেমন সরঞ্জামের সম্মুখীন হয়েছি ঝনঝন-ফরম্যাট যে কখনও কখনও আমাদের পছন্দ মতো কোড সারিবদ্ধ করতে অস্বীকার করে। একটি সাধারণ চ্যালেঞ্জ হল পূর্ববর্তী লাইনের সাথে সুন্দরভাবে সারিবদ্ধ করার জন্য শৃঙ্খলযুক্ত পদ্ধতির ইন্ডেন্টেশন পাওয়া, প্রারম্ভিক ফাংশন নয়।

কল্পনা করুন আপনি একটি বিল্ডার প্যাটার্ন দিয়ে একটি বস্তু তৈরি করছেন। আপনি এই মত একটি ঝরঝরে আউটপুট চান:

auto foo = FooBuilder()
.WithSomething()
.WithSomethingAlse()
.বিল্ড();

কিন্তু ক্ল্যাং-ফরম্যাট আপনার পদ্ধতিগুলিকে ডানদিকে ঠেলে দেওয়ার জন্য জোর দেয়, পরিষ্কার কোডটিকে একটি প্রসারিত জগাখিচুড়িতে পরিণত করে। হঠাৎ, আপনার একবার সংগঠিত লাইনগুলি অসামঞ্জস্যপূর্ণ দেখাচ্ছে এবং চাক্ষুষ প্রবাহ ভেঙে গেছে। হতাশাজনক, তাই না? 🤯

একটি API পরিষেবা রিফ্যাক্টর করার সময় আমি এই সমস্যার সম্মুখীন হয়েছি মনে আছে। আমার নিখুঁতভাবে সারিবদ্ধ পদ্ধতির কলগুলি এমন কিছুতে পরিণত হয়েছে যা একটি সিঁড়ির অনুরূপ — প্রতিটি লাইন আরও ডানদিকে ঠেলে দিয়েছে। এটি কোড পর্যালোচনাগুলিকে আরও কঠিন করে তোলে এবং আমার চোখ ক্লান্ত হয়ে পড়ে। এই নিবন্ধে, আমি চেইনড কলের জন্য ক্ল্যাং-ফরম্যাট ইন্ডেন্টেশনের উপর নিয়ন্ত্রণ পুনরুদ্ধার করতে ব্যবহারিক অন্তর্দৃষ্টি শেয়ার করব যাতে আপনার কোডটি স্টাইলিশ এবং পঠনযোগ্য উভয়ই থাকে। 🛠️

# Step 1: Create a .clang-format file in your project root
# Step 2: Add the following configuration to control indentation
BasedOnStyle: Google
ContinuationIndentWidth: 4
AlignAfterOpenBracket: false
AllowShortFunctionsOnASingleLine: Empty
BreakBeforeBraces: Attach
# Align method calls relative to the previous line
ColumnLimit: 0 # Disables column wrapping
# Save and format your code

// Use clang-format directives to skip specific code regions
auto foo = FooBuilder()
    // clang-format off
    .WithSomething()
    .WithSomethingElse()
    .Build();
    // clang-format on
// clang-format will ignore indentation inside the marked section
// Useful for one-off adjustments without changing global settings
// Combine with other tools for consistency

import re
# Python script to reformat chained method calls
def adjust_indentation(input_file, output_file):
    with open(input_file, 'r') as f:
        lines = f.readlines()
    with open(output_file, 'w') as f_out:
        for line in lines:
            if re.search(r'^\s*\..*', line):
                f_out.write('    ' + line.strip() + '\n')
            else:
                f_out.write(line)
# Usage: adjust_indentation('input.cpp', 'output.cpp')

#include <gtest/gtest.h>
// Example function to validate chaining format
TEST(IndentationTest, ChainedMethods) {
    std::string expected =
        "auto foo = FooBuilder()\n"
        "    .WithSomething()\n"
        "    .WithSomethingElse()\n"
        "    .Build();";
    std::string actual = FooBuilder()
        .WithSomething()
        .WithSomethingElse()
        .Build();
    ASSERT_EQ(expected, actual);
}

সুনির্দিষ্ট পদ্ধতি চেইনিংয়ের জন্য ফাইন-টিউনিং ক্ল্যাং-ফরম্যাট

উপরে প্রদত্ত স্ক্রিপ্টগুলিতে, আমরা কীভাবে সামঞ্জস্য করব তা অনুসন্ধান করেছি ঝনঝন-ফরম্যাট C++-এ পঠনযোগ্য এবং পরিষ্কার চেইন মেথড কল বজায় রাখতে। এই সমস্যাটি দেখা দেয় কারণ ক্ল্যাং-ফরম্যাট সারিবদ্ধ পদ্ধতিটি আগের লাইনের পরিবর্তে প্রথম ফাংশন আহ্বানের সাথে সম্পর্কিত কল করে। এটি সমাধান করার জন্য, আমরা যেমন নির্দিষ্ট কমান্ড ব্যবহার করেছি ContinuationIndentWidth, নির্দেশ মত ঝনঝন-ফরম্যাট বন্ধ/চালু, এবং Python-এ লেখা পোস্ট-প্রসেসিং স্ক্রিপ্ট। বিকাশকারীদের জন্য সর্বাধিক নমনীয়তা নিশ্চিত করতে প্রতিটি পদ্ধতি একটি সামান্য ভিন্ন ব্যবহারের ক্ষেত্রে লক্ষ্য করে।

প্রথম সমাধান একটি তৈরি জড়িত ঝনঝন-ফরম্যাট ফাইল এই ফাইলটি বিকাশকারীদের তাদের C++ প্রকল্পগুলির জন্য বিন্যাস নিয়ম কাস্টমাইজ করার অনুমতি দেয়। মূল সেটিংস অন্তর্ভুক্ত ContinuationIndentWidth, যা লাইনের ধারাবাহিকতার জন্য স্থানের সংখ্যা নির্দিষ্ট করে, এবং AlignAfterOpenBracket, যা বন্ধনীর পরে অপ্রয়োজনীয়ভাবে কোড সারিবদ্ধ করা থেকে ক্ল্যাং-ফরম্যাটকে বাধা দেয়। উদাহরণস্বরূপ, সেটিং কলামের সীমা: 0 লাইন ব্রেকিং অক্ষম করে, নিশ্চিত করে যে শৃঙ্খলিত পদ্ধতিগুলি সঠিকভাবে সারিবদ্ধ থাকে এবং দৃশ্যত আকর্ষণীয় থাকে।

দ্বিতীয় পদ্ধতির ব্যবহার ম্যানুয়াল নিয়ন্ত্রণ জড়িত ঝনঝন-ফরম্যাট বন্ধ/চালু নির্দেশাবলী এগুলি হল ইনলাইন মন্তব্য যা অস্থায়ীভাবে স্বয়ংক্রিয় বিন্যাস অক্ষম করে৷ পদ্ধতি চেইনের আগে এবং পরে কৌশলগতভাবে এই নির্দেশাবলী স্থাপন করে, বিকাশকারীরা ইন্ডেন্টেশনের সম্পূর্ণ নিয়ন্ত্রণ পুনরুদ্ধার করে। উদাহরণ স্বরূপ, মেথড কলের আগে "// ক্ল্যাং-ফরম্যাট অফ" ঢোকানো নিশ্চিত করে ক্ল্যাং-ফরম্যাট হস্তক্ষেপ করে না, এটি একটি বাস্তব এক-অফ সমাধান যখন বিশ্বব্যাপী সেটিংস আদর্শ না হয়। এটি সহযোগিতামূলক পরিবেশে বিশেষভাবে সহায়ক যেখানে অন্যদের ভিন্ন ফর্ম্যাটিং নিয়ম থাকতে পারে। ✨

অবশেষে, আমরা ক্ল্যাং-ফরম্যাট চালানোর পরে পোস্ট-প্রসেস ফর্ম্যাটিং সমস্যাগুলির জন্য একটি পাইথন স্ক্রিপ্ট চালু করেছি। এই স্ক্রিপ্ট চেইনড মেথড কলের জন্য স্ক্যান করে এবং আগের লাইনের সাপেক্ষে স্পেস যোগ করে তাদের ইন্ডেন্টেশন সামঞ্জস্য করে। রেগুলার এক্সপ্রেশন ব্যবহার করে, স্ক্রিপ্টটি ডট দিয়ে শুরু হওয়া লাইনগুলিকে চিহ্নিত করে (যেমন, ".WithSomething()") এবং সামঞ্জস্যপূর্ণ ইন্ডেন্টেশন প্রয়োগ করে। এই ধরনের অটোমেশন বড় কোডবেসের জন্য বিশেষভাবে উপযোগী যেখানে ম্যানুয়াল হস্তক্ষেপ সময়সাপেক্ষ হবে। উপরন্তু, আমরা একাধিক পরিবেশ জুড়ে দৃঢ়তা নিশ্চিত করে, ফরম্যাট করা কোডটি উদ্দেশ্যমূলক শৈলীর সাথে মেলে তা যাচাই করার জন্য Google টেস্টে লিখিত ইউনিট পরীক্ষা অন্তর্ভুক্ত করেছি। 🛠️

ক্ল্যাং-ফর্ম্যাটের সাথে নিখুঁত চেইনড মেথড ইন্ডেন্টেশন

ব্যবহারের একটি প্রায়ই উপেক্ষিত দিক ঝনঝন-ফরম্যাট জটিল কোডবেসে চেইনড মেথড কলের সাথে এর মিথস্ক্রিয়া। যখন আমরা বিল্ডার বা সাবলীল API-এর সাথে কাজ করি, তখন সঠিক প্রান্তিককরণ পঠনযোগ্যতা বাড়ায়। বিকাশকারীরা চান যে পদ্ধতির চেইনগুলি আগের লাইনের তুলনায় পরিষ্কারভাবে সারিবদ্ধ হোক, কিন্তু ক্ল্যাং-ফরম্যাটের ডিফল্ট আচরণ তাদের বেস পদ্ধতি বা ফাংশন কলের অধীনে সারিবদ্ধ করে। এটি বিশৃঙ্খল, কঠিন-পঠন কোডের দিকে নিয়ে যেতে পারে যা পদ্ধতি চেইনিংয়ের যৌক্তিক প্রবাহকে ভেঙে দেয়।

এটি মোকাবেলা করার জন্য, কীভাবে তা বোঝা গুরুত্বপূর্ণ ঝনঝন-ফরম্যাট প্রসেস কোড। ডিফল্টরূপে, এটি মত পরামিতি উপর নির্ভর করে ContinuationIndentWidth এবং AlignAfterOpenBracket. যাইহোক, এই কনফিগারেশনগুলি মাল্টি-লাইন কলগুলি সম্পূর্ণরূপে নিয়ন্ত্রণ করতে পারে না। উদাহরণস্বরূপ, সেটিং 0 থেকে 0 স্বয়ংক্রিয় লাইন ব্রেকিং প্রতিরোধ করে কিন্তু ইন্ডেন্টেশন ঠিক করে না। সূক্ষ্ম নিয়ন্ত্রণের জন্য, নির্দেশাবলী মত // clang-format off এবং // clang-format on কোডের নির্দিষ্ট এলাকায় বিন্যাসকে বাইপাস করার জন্য কৌশলগতভাবে স্থাপন করা যেতে পারে।

কখনও কখনও, প্রকল্পগুলির জন্য যেখানে দলগুলির মধ্যে সামঞ্জস্যপূর্ণ বিন্যাস অপরিহার্য, পোস্ট-প্রসেসিং স্ক্রিপ্ট বা কাস্টম IDE কনফিগারেশনের মতো সরঞ্জামগুলি প্রয়োজনীয় হয়ে ওঠে। উদাহরণস্বরূপ, একটি পাইথন স্ক্রিপ্ট যা শৃঙ্খলিত কলগুলি সনাক্ত করে এবং ইন্ডেন্টেশনকে পুনরায় সাজায় একটি ব্যাকআপ সমাধান হিসাবে কাজ করতে পারে। এই পদ্ধতি নিশ্চিত করে যে এমনকি যদি ঝনঝন-ফরম্যাট চিহ্নটি মিস করে, বিকাশকারীরা কোড পরিবর্তনের পরে স্বয়ংক্রিয়ভাবে পছন্দসই শৈলী প্রয়োগ করতে পারে। 🚀