bc-code-intelligence-mcp 1.3.3 → 1.3.4

package/embedded-knowledge/domains/roger-reviewer/samples/al-separate-if-else-formatting.md

@@ -1,280 +0,0 @@
-# AL Separate If-Else Formatting - Code Examples
-
-## Good Examples
-
-### Proper If-Else Separation with Clear Structure
-```al
-procedure ProcessCustomerStatus(CustomerNo: Code[20])
-var
-    Customer: Record Customer;
-begin
-    if Customer.Get(CustomerNo) then
-    begin
-        if not Customer.Blocked then
-        begin
-            Customer."Last Contact Date" := Today;
-            Customer.Modify();
-            Message('Customer %1 updated successfully', CustomerNo);
-        end
-        else
-        begin
-            Message('Customer %1 is blocked and cannot be updated', CustomerNo);
-        end;
-    end
-    else
-    begin
-        Error('Customer %1 does not exist', CustomerNo);
-    end;
-end;
-```
-
-### Multiple If-Else Conditions with Proper Separation
-```al
-procedure HandleOrderStatus(var SalesHeader: Record "Sales Header")
-begin
-    if SalesHeader.Status = SalesHeader.Status::Open then
-    begin
-        EnableEditingActions();
-        SetStatusColor('Green');
-        ShowMessage('Order is open for editing');
-    end
-    else if SalesHeader.Status = SalesHeader.Status::Released then
-    begin
-        DisableEditingActions();
-        SetStatusColor('Blue');
-        ShowMessage('Order has been released');
-    end
-    else if SalesHeader.Status = SalesHeader.Status::"Pending Approval" then
-    begin
-        DisableEditingActions();
-        SetStatusColor('Yellow');
-        ShowMessage('Order is pending approval');
-        RequestApproval(SalesHeader);
-    end
-    else
-    begin
-        DisableAllActions();
-        SetStatusColor('Red');
-        ShowMessage('Order status is invalid');
-    end;
-end;
-```
-
-### Nested If-Else with Clear Block Structure
-```al
-procedure ValidateAndProcessOrder(OrderNo: Code[20])
-var
-    SalesHeader: Record "Sales Header";
-    Customer: Record Customer;
-begin
-    if SalesHeader.Get(SalesHeader."Document Type"::Order, OrderNo) then
-    begin
-        if Customer.Get(SalesHeader."Sell-to Customer No.") then
-        begin
-            if not Customer.Blocked then
-            begin
-                if SalesHeader."Order Date" <> 0D then
-                begin
-                    ProcessValidOrder(SalesHeader);
-                    Message('Order processed successfully');
-                end
-                else
-                begin
-                    Error('Order date is required');
-                end;
-            end
-            else
-            begin
-                Error('Customer %1 is blocked', Customer."No.");
-            end;
-        end
-        else
-        begin
-            Error('Customer does not exist');
-        end;
-    end
-    else
-    begin
-        Error('Order %1 not found', OrderNo);
-    end;
-end;
-```
-
-### Complex Business Logic with Proper If-Else Structure
-```al
-procedure CalculateDiscount(CustomerNo: Code[20]; OrderAmount: Decimal): Decimal
-var
-    Customer: Record Customer;
-    DiscountPct: Decimal;
-begin
-    if Customer.Get(CustomerNo) then
-    begin
-        if Customer."Customer Posting Group" = 'VIP' then
-        begin
-            if OrderAmount >= 10000 then
-            begin
-                DiscountPct := 15;
-            end
-            else if OrderAmount >= 5000 then
-            begin
-                DiscountPct := 10;
-            end
-            else
-            begin
-                DiscountPct := 5;
-            end;
-        end
-        else if Customer."Customer Posting Group" = 'PREMIUM' then
-        begin
-            if OrderAmount >= 5000 then
-            begin
-                DiscountPct := 8;
-            end
-            else
-            begin
-                DiscountPct := 3;
-            end;
-        end
-        else
-        begin
-            if OrderAmount >= 1000 then
-            begin
-                DiscountPct := 2;
-            end
-            else
-            begin
-                DiscountPct := 0;
-            end;
-        end;
-    end
-    else
-    begin
-        DiscountPct := 0;
-    end;
-
-    exit(DiscountPct);
-end;
-```
-
-## Bad Examples
-
-### Cramped If-Else on Same Lines
-```al
-procedure BadIfElseFormatting(CustomerNo: Code[20])
-var
-    Customer: Record Customer;
-begin
-    if Customer.Get(CustomerNo) then begin Customer."Last Contact Date" := Today; Customer.Modify(); end else begin Error('Customer not found'); end;  // Bad: entire if-else on one line
-
-    if not Customer.Blocked then Message('Active customer') else Message('Blocked customer');  // Bad: no begin-end blocks, single line
-end;
-```
-
-### Poor Else Positioning
-```al
-procedure PoorElsePositioning(OrderNo: Code[20])
-var
-    SalesHeader: Record "Sales Header";
-begin
-    if SalesHeader.Get(SalesHeader."Document Type"::Order, OrderNo) then
-    begin
-        ProcessOrder(SalesHeader);
-    end else begin  // Bad: else on same line as end
-        Error('Order not found');
-    end;
-
-    if SalesHeader.Status = SalesHeader.Status::Open then
-    begin
-        EnableEditing();
-    end
-        else  // Bad: else indented incorrectly
-    begin
-        DisableEditing();
-    end;
-end;
-```
-
-### Missing Begin-End Blocks
-```al
-procedure MissingBeginEnd(CustomerNo: Code[20])
-var
-    Customer: Record Customer;
-begin
-    if Customer.Get(CustomerNo) then
-        Customer."Last Contact Date" := Today;
-        Customer.Modify();  // Bad: this executes regardless of if condition
-    else
-        Error('Customer not found');  // Bad: this causes compilation error
-
-    if Customer.Blocked then
-        Customer.Blocked := false;
-        Message('Customer unblocked');  // Bad: this executes regardless of if condition
-    else
-        Message('Customer is active');
-end;
-```
-
-### Inconsistent Formatting Styles
-```al
-procedure InconsistentFormatting(OrderNo: Code[20])
-var
-    SalesHeader: Record "Sales Header";
-    Customer: Record Customer;
-begin
-    // Style 1: proper formatting
-    if SalesHeader.Get(SalesHeader."Document Type"::Order, OrderNo) then
-    begin
-        ProcessOrder(SalesHeader);
-    end
-    else
-    begin
-        Error('Order not found');
-    end;
-
-    // Style 2: cramped formatting
-    if Customer.Get(SalesHeader."Sell-to Customer No.") then begin ProcessCustomer(Customer); end else begin Error('Customer not found'); end;
-
-    // Style 3: missing blocks
-    if SalesHeader."Order Date" = Today then
-        Message('Today order')
-    else
-        Message('Past order');
-end;
-```
-
-### Complex Nested Logic Without Clear Structure
-```al
-procedure PoorNestedStructure(OrderNo: Code[20])
-var
-    SalesHeader: Record "Sales Header";
-    Customer: Record Customer;
-begin
-    if SalesHeader.Get(SalesHeader."Document Type"::Order, OrderNo) then if Customer.Get(SalesHeader."Sell-to Customer No.") then if not Customer.Blocked then if SalesHeader."Order Date" <> 0D then ProcessValidOrder(SalesHeader) else Error('No order date') else Error('Customer blocked') else Error('Customer not found') else Error('Order not found');  // Bad: entire nested structure on one line
-end;
-```
-
-### Poor Else-If Chain Formatting
-```al
-procedure PoorElseIfChain(Status: Option Open,Released,Pending,Cancelled)
-begin
-    if Status = Status::Open then begin
-        EnableEditing();
-    end else if Status = Status::Released then begin  // Bad: else if on same line as end
-        DisableEditing();
-    end
-    else if Status = Status::Pending then  // Bad: inconsistent else positioning
-    begin
-        RequestApproval();
-    end else begin  // Bad: else on same line as end
-        ShowError();
-    end;
-end;
-```
-
-## Best Practices
-
-1. **Separate if and else blocks** with proper line breaks
-2. **Use begin-end blocks** for all multi-statement conditions
-3. **Consistent else positioning** - always on its own line aligned with corresponding if
-4. **Clear visual hierarchy** through proper indentation
-5. **Avoid cramping** multiple conditions or statements on single lines

package/embedded-knowledge/domains/roger-reviewer/samples/al-statement-per-line-rule.md

@@ -1,188 +0,0 @@
-# AL Statement Per Line Rule - Code Examples
-
-## Good Examples
-
-### Single Statement Per Line
-```al
-procedure ProcessCustomerOrder(CustomerNo: Code[20])
-var
-    Customer: Record Customer;
-    SalesHeader: Record "Sales Header";
-    OrderNo: Code[20];
-begin
-    // Each statement on its own line for clarity
-    Customer.Get(CustomerNo);
-    Customer.CalcFields("Balance (LCY)");
-
-    SalesHeader.Init();
-    SalesHeader."Document Type" := SalesHeader."Document Type"::Order;
-    SalesHeader."Sell-to Customer No." := CustomerNo;
-    SalesHeader."Order Date" := Today;
-    SalesHeader.Insert(true);
-
-    OrderNo := SalesHeader."No.";
-    Message('Order %1 created successfully', OrderNo);
-end;
-```
-
-### Variable Declarations - One Per Line
-```al
-procedure CalculateOrderTotals(OrderNo: Code[20])
-var
-    SalesHeader: Record "Sales Header";
-    SalesLine: Record "Sales Line";
-    TotalAmount: Decimal;
-    TotalQuantity: Decimal;
-    LineCount: Integer;
-    DiscountAmount: Decimal;
-begin
-    SalesHeader.Get(SalesHeader."Document Type"::Order, OrderNo);
-
-    SalesLine.SetRange("Document Type", SalesLine."Document Type"::Order);
-    SalesLine.SetRange("Document No.", OrderNo);
-
-    if SalesLine.FindSet() then
-        repeat
-            TotalAmount += SalesLine."Line Amount";
-            TotalQuantity += SalesLine.Quantity;
-            LineCount += 1;
-            DiscountAmount += SalesLine."Line Discount Amount";
-        until SalesLine.Next() = 0;
-
-    SalesHeader."Total Amount" := TotalAmount;
-    SalesHeader."Total Quantity" := TotalQuantity;
-    SalesHeader.Modify();
-end;
-```
-
-### Control Flow Statements
-```al
-procedure ValidateOrderData(var SalesHeader: Record "Sales Header"): Boolean
-var
-    Customer: Record Customer;
-    ValidationResult: Boolean;
-begin
-    ValidationResult := true;
-
-    if SalesHeader."Sell-to Customer No." = '' then
-        ValidationResult := false;
-
-    if ValidationResult then
-        if not Customer.Get(SalesHeader."Sell-to Customer No.") then
-            ValidationResult := false;
-
-    if ValidationResult then
-        if Customer.Blocked then
-            ValidationResult := false;
-
-    if ValidationResult then
-        if SalesHeader."Order Date" = 0D then
-            ValidationResult := false;
-
-    exit(ValidationResult);
-end;
-```
-
-### Complex Expressions Broken Down
-```al
-procedure CalculateComplexPricing(ItemNo: Code[20]; CustomerNo: Code[20]; Quantity: Decimal): Decimal
-var
-    Item: Record Item;
-    Customer: Record Customer;
-    BasePrice: Decimal;
-    CustomerDiscount: Decimal;
-    VolumeDiscount: Decimal;
-    FinalPrice: Decimal;
-begin
-    Item.Get(ItemNo);
-    Customer.Get(CustomerNo);
-
-    BasePrice := Item."Unit Price";
-    CustomerDiscount := GetCustomerDiscount(CustomerNo);
-    VolumeDiscount := GetVolumeDiscount(Quantity);
-
-    FinalPrice := BasePrice;
-    FinalPrice := FinalPrice * (1 - CustomerDiscount / 100);
-    FinalPrice := FinalPrice * (1 - VolumeDiscount / 100);
-
-    exit(FinalPrice);
-end;
-```
-
-## Bad Examples
-
-### Multiple Statements Per Line
-```al
-procedure BadMultipleStatements(CustomerNo: Code[20])
-var
-    Customer: Record Customer; SalesHeader: Record "Sales Header"; OrderNo: Code[20];  // Bad: multiple declarations
-begin
-    Customer.Get(CustomerNo); Customer.CalcFields("Balance (LCY)"); SalesHeader.Init();  // Bad: multiple statements
-    SalesHeader."Document Type" := SalesHeader."Document Type"::Order; SalesHeader."Sell-to Customer No." := CustomerNo; SalesHeader.Insert(true);  // Bad: cramped assignments
-    OrderNo := SalesHeader."No."; Message('Order %1 created', OrderNo);  // Bad: multiple statements
-end;
-```
-
-### Cramped Control Flow
-```al
-procedure BadControlFlow(OrderNo: Code[20])
-var
-    SalesLine: Record "Sales Line"; Total: Decimal;  // Bad: multiple declarations
-begin
-    SalesLine.SetRange("Document No.", OrderNo); if SalesLine.FindSet() then repeat Total += SalesLine."Line Amount"; until SalesLine.Next() = 0;  // Bad: entire loop on one line
-    if Total > 1000 then Message('Large order') else Message('Small order');  // Bad: if-else on one line
-end;
-```
-
-### Complex Expressions on Single Lines
-```al
-procedure BadComplexExpressions(ItemNo: Code[20]; CustomerNo: Code[20]; Qty: Decimal): Decimal
-var
-    Item: Record Item; Customer: Record Customer;  // Bad: multiple declarations
-begin
-    Item.Get(ItemNo); Customer.Get(CustomerNo);  // Bad: multiple statements
-    exit(Item."Unit Price" * (1 - GetCustomerDiscount(CustomerNo) / 100) * (1 - GetVolumeDiscount(Qty) / 100) * Qty);  // Bad: complex calculation on one line
-end;
-```
-
-### Nested Structures Cramped
-```al
-procedure BadNesting(OrderNo: Code[20])
-var
-    SalesLine: Record "Sales Line"; Item: Record Item;  // Bad: multiple declarations
-begin
-    SalesLine.SetRange("Document No.", OrderNo); if SalesLine.FindSet() then repeat if SalesLine.Type = SalesLine.Type::Item then if Item.Get(SalesLine."No.") then if Item.Inventory < SalesLine.Quantity then Error('Low inventory') else Item.Modify(); until SalesLine.Next() = 0;  // Bad: complex nested logic on one line
-end;
-```
-
-### Variable Assignments and Calculations Cramped
-```al
-procedure BadCalculations()
-var
-    Price, Discount, Tax, Total: Decimal;  // Bad: multiple declarations on one line
-    Qty1, Qty2, Qty3: Integer;  // Bad: multiple declarations
-begin
-    Price := 100; Discount := 0.1; Tax := 0.08; Qty1 := 5; Qty2 := 3; Qty3 := 2;  // Bad: multiple assignments
-    Total := (Price * (Qty1 + Qty2 + Qty3)) * (1 - Discount) * (1 + Tax);  // Bad: complex calculation
-    Message('Total: %1', Total); Exit(Total);  // Bad: multiple statements
-end;
-```
-
-### Poor Error Handling Structure
-```al
-procedure BadErrorHandling(CustomerNo: Code[20])
-var
-    Customer: Record Customer; ErrorMsg: Text;  // Bad: multiple declarations
-begin
-    if not Customer.Get(CustomerNo) then ErrorMsg := 'Customer not found'; if Customer.Blocked then ErrorMsg += ' and blocked'; if ErrorMsg <> '' then Error(ErrorMsg);  // Bad: complex error logic on one line
-end;
-```
-
-## Best Practices
-
-1. **One statement per line** - each operation should have its own line
-2. **One variable declaration per line** - easier to read and maintain
-3. **Break complex expressions** into multiple assignment statements
-4. **Separate logical operations** even if they could be combined
-5. **Use meaningful intermediate variables** for complex calculations
-6. **Structure control flow** with proper line breaks and indentation

package/embedded-knowledge/domains/roger-reviewer/samples/al-unnecessary-else-elimination.md

@@ -1,245 +0,0 @@
-# Unnecessary Else Elimination - AL Code Examples
-
-## Good Examples
-
-### Early Return Pattern
-```al
-procedure ValidateCustomerCredit(CustomerNo: Code[20]): Boolean
-var
-    Customer: Record Customer;
-    CustLedgerEntry: Record "Cust. Ledger Entry";
-    TotalOutstanding: Decimal;
-begin
-    // Early exit for invalid customer
-    if not Customer.Get(CustomerNo) then
-        exit(false);
-
-    // Early exit if credit check disabled
-    if not Customer."Credit Limit (LCY)" > 0 then
-        exit(true);
-
-    // Calculate outstanding amount
-    CustLedgerEntry.SetRange("Customer No.", CustomerNo);
-    CustLedgerEntry.SetRange(Open, true);
-    CustLedgerEntry.CalcSums("Remaining Amt. (LCY)");
-    TotalOutstanding := CustLedgerEntry."Remaining Amt. (LCY)";
-
-    // Direct return without else
-    exit(TotalOutstanding <= Customer."Credit Limit (LCY)");
-end;
-```
-
-### Guard Clause Implementation
-```al
-procedure ProcessSalesOrder(DocumentNo: Code[20]): Boolean
-var
-    SalesHeader: Record "Sales Header";
-    SalesLine: Record "Sales Line";
-begin
-    // Guard clause - early exit
-    if DocumentNo = '' then
-        exit(false);
-
-    // Guard clause - record validation
-    if not SalesHeader.Get(SalesHeader."Document Type"::Order, DocumentNo) then
-        exit(false);
-
-    // Guard clause - status validation
-    if SalesHeader.Status <> SalesHeader.Status::Open then
-        exit(false);
-
-    // Main processing logic
-    SalesLine.SetRange("Document Type", SalesHeader."Document Type");
-    SalesLine.SetRange("Document No.", SalesHeader."No.");
-    if SalesLine.FindSet() then
-        repeat
-            ProcessSalesLine(SalesLine);
-        until SalesLine.Next() = 0;
-
-    exit(true);
-end;
-```
-
-### Streamlined Control Flow
-```al
-procedure CalculateItemCost(ItemNo: Code[20]; Quantity: Decimal): Decimal
-var
-    Item: Record Item;
-    ItemLedgerEntry: Record "Item Ledger Entry";
-begin
-    // Early validation without nested else
-    if ItemNo = '' then
-        exit(0);
-
-    if Quantity <= 0 then
-        exit(0);
-
-    if not Item.Get(ItemNo) then
-        exit(0);
-
-    // Calculate based on costing method
-    case Item."Costing Method" of
-        Item."Costing Method"::FIFO:
-            exit(CalculateFIFOCost(ItemNo, Quantity));
-        Item."Costing Method"::LIFO:
-            exit(CalculateLIFOCost(ItemNo, Quantity));
-        Item."Costing Method"::Average:
-            exit(Item."Unit Cost" * Quantity);
-        else
-            exit(Item."Last Direct Cost" * Quantity);
-    end;
-end;
-```
-
-## Bad Examples
-
-### Unnecessary Else Chains
-```al
-procedure ValidateCustomerCredit(CustomerNo: Code[20]): Boolean
-var
-    Customer: Record Customer;
-    CustLedgerEntry: Record "Cust. Ledger Entry";
-    TotalOutstanding: Decimal;
-begin
-    if CustomerNo = '' then begin
-        exit(false);
-    end else begin
-        if Customer.Get(CustomerNo) then begin
-            if Customer."Credit Limit (LCY)" > 0 then begin
-                CustLedgerEntry.SetRange("Customer No.", CustomerNo);
-                CustLedgerEntry.SetRange(Open, true);
-                CustLedgerEntry.CalcSums("Remaining Amt. (LCY)");
-                TotalOutstanding := CustLedgerEntry."Remaining Amt. (LCY)";
-                if TotalOutstanding <= Customer."Credit Limit (LCY)" then begin
-                    exit(true);
-                end else begin
-                    exit(false);
-                end;
-            end else begin
-                exit(true);
-            end;
-        end else begin
-            exit(false);
-        end;
-    end;
-end;
-```
-
-### Nested Else Complexity
-```al
-procedure ProcessDocument(DocumentType: Integer; DocumentNo: Code[20]): Boolean
-var
-    ProcessingResult: Boolean;
-begin
-    if DocumentType = 1 then begin
-        ProcessingResult := ProcessSalesDocument(DocumentNo);
-        if ProcessingResult then begin
-            exit(true);
-        end else begin
-            exit(false);
-        end;
-    end else begin
-        if DocumentType = 2 then begin
-            ProcessingResult := ProcessPurchaseDocument(DocumentNo);
-            if ProcessingResult then begin
-                exit(true);
-            end else begin
-                exit(false);
-            end;
-        end else begin
-            if DocumentType = 3 then begin
-                ProcessingResult := ProcessServiceDocument(DocumentNo);
-                if ProcessingResult then begin
-                    exit(true);
-                end else begin
-                    exit(false);
-                end;
-            end else begin
-                exit(false);
-            end;
-        end;
-    end;
-end;
-```
-
-## Best Practices
-
-### Boolean Return Simplification
-```al
-procedure IsItemBlocked(ItemNo: Code[20]): Boolean
-var
-    Item: Record Item;
-begin
-    // Good: Direct boolean return
-    if not Item.Get(ItemNo) then
-        exit(true);
-
-    exit(Item.Blocked);
-
-    // Avoid: Unnecessary if-then-else for boolean
-    // if Item.Blocked then
-    //     exit(true)
-    // else
-    //     exit(false);
-end;
-```
-
-### Case Statement Optimization
-```al
-procedure GetDocumentStatus(Status: Option Open,Released,Pending): Text
-begin
-    // Good: Case with early returns
-    case Status of
-        Status::Open:
-            exit('OPEN');
-        Status::Released:
-            exit('RELEASED');
-        Status::Pending:
-            exit('PENDING');
-        else
-            exit('UNKNOWN');
-    end;
-
-    // Avoid: Nested if-else chains
-    // if Status = Status::Open then
-    //     exit('OPEN')
-    // else if Status = Status::Released then
-    //     exit('RELEASED')
-    // else if Status = Status::Pending then
-    //     exit('PENDING')
-    // else
-    //     exit('UNKNOWN');
-end;
-```
-
-### Exception Handling Pattern
-```al
-procedure SafelyProcessRecord(RecordID: RecordID): Boolean
-var
-    RecordRef: RecordRef;
-begin
-    // Early exit on invalid input
-    if RecordID.TableNo = 0 then
-        exit(false);
-
-    // Early exit if record doesn't exist
-    if not RecordRef.Get(RecordID) then
-        exit(false);
-
-    // Early exit if record is already processed
-    if IsRecordProcessed(RecordRef) then
-        exit(true);
-
-    // Main processing
-    exit(ProcessRecord(RecordRef));
-end;
-```
-
-## Implementation Guidelines
-
-1. **Replace nested if-else with early returns** - Reduce cognitive complexity
-2. **Use guard clauses for validation** - Handle edge cases at procedure start
-3. **Simplify boolean returns** - Return boolean expressions directly
-4. **Prefer case statements** - For multiple discrete value comparisons
-5. **Apply consistent patterns** - Use same structure across similar procedures
-6. **Test thoroughly** - Ensure refactored logic maintains original behavior