@jwikman/bc-code-intelligence-mcp 1.5.7-dev.1

package/embedded-knowledge/domains/roger-reviewer/samples/al-comment-spacing-standards.md

@@ -0,0 +1,209 @@
+# AL Comment Spacing Standards - Code Examples
+
+## Good Examples
+
+### Single-Line Comments with Proper Spacing
+```al
+procedure ProcessCustomerOrder(CustomerNo: Code[20])
+var
+    Customer: Record Customer;
+    SalesHeader: Record "Sales Header";
+begin
+    // Validate customer exists and is not blocked
+    if not Customer.Get(CustomerNo) then
+        Error('Customer %1 does not exist', CustomerNo);
+
+    // Check customer credit limit before processing
+    Customer.CalcFields("Balance (LCY)");
+    if Customer."Credit Limit (LCY)" < Customer."Balance (LCY)" then
+        Error('Customer %1 has exceeded credit limit', CustomerNo);
+
+    // Create new sales order
+    SalesHeader.Init();
+    SalesHeader."Document Type" := SalesHeader."Document Type"::Order;
+    SalesHeader."Sell-to Customer No." := CustomerNo;
+    SalesHeader.Insert(true);
+end;
+```
+
+### Multi-Line Comments with Consistent Formatting
+```al
+codeunit 50100 "Order Processing"
+{
+    /*
+     * ProcessBulkOrders procedure handles multiple order processing
+     * with validation and error handling for each order in the batch.
+     * Returns count of successfully processed orders.
+     */
+    procedure ProcessBulkOrders(var OrderList: List of [Code[20]]): Integer
+    var
+        ProcessedCount: Integer;
+        OrderNo: Code[20];
+    begin
+        ProcessedCount := 0;
+
+        /*
+         * Iterate through each order in the list
+         * and attempt to process with error recovery
+         */
+        foreach OrderNo in OrderList do begin
+            if TryProcessSingleOrder(OrderNo) then
+                ProcessedCount += 1;
+        end;
+
+        exit(ProcessedCount);
+    end;
+}
+```
+
+### Inline Comments with Proper Spacing
+```al
+procedure CalculateDiscount(Amount: Decimal; CustomerType: Option Regular,Premium,VIP): Decimal
+var
+    DiscountPct: Decimal;
+begin
+    case CustomerType of
+        CustomerType::Regular:
+            DiscountPct := 0.05;    // 5% discount for regular customers
+        CustomerType::Premium:
+            DiscountPct := 0.10;    // 10% discount for premium customers
+        CustomerType::VIP:
+            DiscountPct := 0.15;    // 15% discount for VIP customers
+    end;
+
+    exit(Amount * DiscountPct);     // Calculate final discount amount
+end;
+```
+
+### Section Headers with Consistent Spacing
+```al
+codeunit 50101 "Customer Management"
+{
+    // ============================================================================
+    // Validation Functions
+    // ============================================================================
+
+    procedure ValidateCustomerData(var Customer: Record Customer): Boolean
+    begin
+        // Implementation here
+    end;
+
+    procedure ValidateAddressInfo(var Customer: Record Customer): Boolean
+    begin
+        // Implementation here
+    end;
+
+    // ============================================================================
+    // Processing Functions
+    // ============================================================================
+
+    procedure CreateCustomer(Name: Text[100]): Code[20]
+    begin
+        // Implementation here
+    end;
+
+    procedure UpdateCustomer(var Customer: Record Customer)
+    begin
+        // Implementation here
+    end;
+}
+```
+
+## Bad Examples
+
+### Inconsistent Comment Spacing
+```al
+procedure BadSpacing(CustomerNo: Code[20])
+var
+    Customer: Record Customer;
+begin
+    //No space after comment marker
+    if not Customer.Get(CustomerNo) then
+        Error('Customer not found');
+
+    //    Too many spaces after marker
+    Customer.CalcFields("Balance (LCY)");
+
+    // Good spacing
+    if Customer.Blocked then
+        Error('Customer is blocked');
+
+    //Another comment without space
+    Customer.Modify();
+end;
+```
+
+### Poor Multi-Line Comment Formatting
+```al
+/*
+Poorly formatted multi-line comment
+without consistent indentation
+    or proper spacing
+        making it hard to read
+*/
+procedure PoorCommentFormatting()
+begin
+    /*This comment is not properly
+    formatted and lacks
+        consistent spacing*/
+    Message('Hello');
+end;
+```
+
+### Cramped Inline Comments
+```al
+procedure CrampedComments(Amount: Decimal): Decimal
+var
+    Tax: Decimal;
+begin
+    Tax := Amount * 0.08;//No space before comment
+    Amount := Amount + Tax;//Another cramped comment
+    exit(Amount);//Final cramped comment
+end;
+```
+
+### Missing Comment Spacing in Complex Code
+```al
+procedure NoCommentSpacing()
+var
+    i: Integer;
+    Total: Decimal;
+begin
+    for i := 1 to 10 do begin//Loop comment crammed
+        if i mod 2 = 0 then//Even number check crammed
+            Total += i * 2;//Double even numbers crammed
+    end;//End loop comment crammed
+end;
+```
+
+### Inconsistent Section Spacing
+```al
+codeunit 50102 "Poor Comment Organization"
+{
+    //=== Validation Functions ===
+    procedure ValidateData(): Boolean
+    begin
+        // Implementation
+    end;
+
+    // Processing Functions (inconsistent header style)
+    procedure ProcessData()
+    begin
+        // Implementation
+    end;
+
+    //===Utility Functions===(no spaces around text)
+    procedure UtilityFunction()
+    begin
+        // Implementation
+    end;
+}
+```
+
+## Best Practices
+
+1. **Always use single space** after // for single-line comments
+2. **Consistent indentation** for multi-line comments with /* */
+3. **Appropriate spacing** before inline comments (at least 4 spaces)
+4. **Uniform section headers** with consistent formatting style
+5. **Group related comments** with consistent spacing patterns

package/embedded-knowledge/domains/roger-reviewer/samples/al-keyword-indentation-rules.md

@@ -0,0 +1,218 @@
+# AL Keyword Indentation Rules - Code Examples
+
+## Good Examples
+
+### Proper Trigger Indentation
+```al
+table 50100 "Customer Extension"
+{
+    fields
+    {
+        field(1; "No."; Code[20])
+        {
+            Caption = 'No.';
+        }
+        field(2; Name; Text[100])
+        {
+            Caption = 'Name';
+        }
+    }
+
+    trigger OnInsert()
+    begin
+        if "No." = '' then
+            "No." := NoSeriesMgt.GetNextNo(Setup."Customer Nos.", 0D, true);
+    end;
+
+    trigger OnModify()
+    begin
+        "Last Modified Date" := Today;
+        "Last Modified Time" := Time;
+    end;
+}
+```
+
+### Procedure and Function Indentation
+```al
+codeunit 50100 "Customer Management"
+{
+    procedure CreateCustomer(Name: Text[100]; Email: Text[80]): Code[20]
+    var
+        Customer: Record Customer;
+        CustomerNo: Code[20];
+    begin
+        // Validate input parameters
+        if Name = '' then
+            Error('Customer name cannot be empty');
+
+        // Create customer record
+        Customer.Init();
+        CustomerNo := NoSeriesMgt.GetNextNo(SalesSetup."Customer Nos.", 0D, true);
+        Customer."No." := CustomerNo;
+        Customer.Name := Name;
+        Customer."E-Mail" := Email;
+        Customer.Insert(true);
+
+        exit(CustomerNo);
+    end;
+
+    local procedure ValidateCustomerData(var Customer: Record Customer)
+    begin
+        if Customer.Name = '' then
+            Error('Customer name is required');
+
+        if Customer."E-Mail" = '' then
+            Error('Customer email is required');
+    end;
+}
+```
+
+### Control Structure Indentation
+```al
+procedure ProcessOrderLines(OrderNo: Code[20])
+var
+    SalesLine: Record "Sales Line";
+    Item: Record Item;
+begin
+    SalesLine.SetRange("Document Type", SalesLine."Document Type"::Order);
+    SalesLine.SetRange("Document No.", OrderNo);
+
+    if SalesLine.FindSet() then
+        repeat
+            if SalesLine.Type = SalesLine.Type::Item then begin
+                if Item.Get(SalesLine."No.") then begin
+                    if Item.Inventory < SalesLine.Quantity then begin
+                        Error('Insufficient inventory for item %1', SalesLine."No.");
+                    end else begin
+                        Item.Inventory -= SalesLine.Quantity;
+                        Item.Modify();
+                    end;
+                end;
+            end;
+        until SalesLine.Next() = 0;
+end;
+```
+
+### Case Statement Indentation
+```al
+procedure HandleDocumentStatus(Status: Option Open,Released,Pending,Cancelled)
+begin
+    case Status of
+        Status::Open:
+            begin
+                EnableEditingActions();
+                ShowStatusMessage('Document is open for editing');
+            end;
+        Status::Released:
+            begin
+                DisableEditingActions();
+                ShowStatusMessage('Document has been released');
+            end;
+        Status::Pending:
+            begin
+                DisableEditingActions();
+                ShowStatusMessage('Document is pending approval');
+                RequestApproval();
+            end;
+        Status::Cancelled:
+            begin
+                DisableAllActions();
+                ShowStatusMessage('Document has been cancelled');
+            end;
+    end;
+end;
+```
+
+## Bad Examples
+
+### Inconsistent Trigger Indentation
+```al
+table 50101 "Bad Indentation Table"
+{
+    fields
+    {
+        field(1; "No."; Code[20]) { }
+    }
+
+trigger OnInsert()  // Wrong: should be indented
+begin
+if "No." = '' then  // Wrong: should be indented further
+"No." := NoSeriesMgt.GetNextNo(Setup."Customer Nos.", 0D, true);  // Wrong: should be indented
+end;
+
+    trigger OnModify()  // Wrong: over-indented
+        begin  // Wrong: over-indented
+            "Last Modified Date" := Today;  // Inconsistent with other triggers
+        end;
+}
+```
+
+### Poor Procedure Indentation
+```al
+codeunit 50101 "Bad Indentation Codeunit"
+{
+procedure CreateCustomer(Name: Text[100]): Code[20]  // Wrong: not indented
+var
+Customer: Record Customer;  // Wrong: not indented
+begin
+Customer.Init();  // Wrong: not indented
+    Customer.Name := Name;  // Inconsistent indentation
+        Customer.Insert(true);  // Wrong: over-indented
+exit(Customer."No.");  // Wrong: not indented
+end;
+
+    local procedure ValidateData()  // Wrong: over-indented
+    begin
+    // Implementation with poor indentation
+    end;
+}
+```
+
+### Inconsistent Control Structure Indentation
+```al
+procedure BadControlStructures(OrderNo: Code[20])
+var
+    SalesLine: Record "Sales Line";
+begin
+SalesLine.SetRange("Document No.", OrderNo);  // Wrong: not indented
+
+if SalesLine.FindSet() then  // Wrong: not indented
+repeat  // Wrong: not indented
+if SalesLine.Type = SalesLine.Type::Item then  // Wrong: not indented
+begin  // Wrong: not indented
+        ProcessItem(SalesLine."No.");  // Wrong: over-indented
+    end  // Wrong: inconsistent with begin
+        else  // Wrong: poor else positioning
+    begin  // Wrong: inconsistent indentation
+        ProcessNonItem(SalesLine);
+    end;
+    until SalesLine.Next() = 0;  // Wrong: inconsistent with repeat
+end;
+```
+
+### Poor Case Statement Indentation
+```al
+procedure BadCaseIndentation(Status: Option Open,Released,Pending)
+begin
+case Status of  // Wrong: not indented
+Status::Open:  // Wrong: not indented further
+begin  // Wrong: not indented to match case branch
+Message('Open');  // Wrong: not indented properly in begin block
+end;
+    Status::Released:  // Wrong: inconsistent with other case labels
+        begin  // Wrong: over-indented
+            Message('Released');
+        end;
+Status::Pending:  // Wrong: back to no indentation
+Message('Pending');  // Wrong: single statement not aligned
+end;
+end;
+```
+
+## Best Practices
+
+1. **Consistent base indentation** for all keywords within their scope
+2. **Progressive indentation** for nested structures (4 spaces per level)
+3. **Align related keywords** (begin/end, if/then/else, case/of/end)
+4. **Maintain indentation hierarchy** throughout complex structures
+5. **Use consistent spacing** for all control flow keywords

package/embedded-knowledge/domains/roger-reviewer/samples/al-line-start-keyword-positioning.md

@@ -0,0 +1,218 @@
+# AL Line Start Keyword Positioning - Code Examples
+
+## Good Examples
+
+### Proper Keyword Line Positioning
+```al
+procedure ProcessCustomerOrder(CustomerNo: Code[20])
+var
+    Customer: Record Customer;
+    SalesHeader: Record "Sales Header";
+    OrderCreated: Boolean;
+begin
+    // Each keyword starts at appropriate line position
+    if Customer.Get(CustomerNo) then
+    begin
+        if not Customer.Blocked then
+        begin
+            SalesHeader.Init();
+            SalesHeader."Sell-to Customer No." := CustomerNo;
+
+            if SalesHeader.Insert(true) then
+            begin
+                OrderCreated := true;
+                Message('Order created successfully');
+            end
+            else
+            begin
+                OrderCreated := false;
+                Error('Failed to create order');
+            end;
+        end
+        else
+        begin
+            Error('Customer %1 is blocked', CustomerNo);
+        end;
+    end
+    else
+    begin
+        Error('Customer %1 does not exist', CustomerNo);
+    end;
+end;
+```
+
+### Control Flow Keyword Positioning
+```al
+procedure ValidateOrderData(var SalesHeader: Record "Sales Header"): Boolean
+var
+    Customer: Record Customer;
+    ValidationPassed: Boolean;
+begin
+    ValidationPassed := true;
+
+    // Proper if-then-else positioning
+    if SalesHeader."Sell-to Customer No." = '' then
+    begin
+        ValidationPassed := false;
+        Error('Customer number is required');
+    end;
+
+    // Proper case statement positioning
+    case SalesHeader."Document Type" of
+        SalesHeader."Document Type"::Quote:
+        begin
+            if SalesHeader."Quote Valid Until Date" = 0D then
+            begin
+                ValidationPassed := false;
+                Error('Quote validity date is required');
+            end;
+        end;
+        SalesHeader."Document Type"::Order:
+        begin
+            if SalesHeader."Requested Delivery Date" = 0D then
+            begin
+                ValidationPassed := false;
+                Error('Delivery date is required');
+            end;
+        end;
+    end;
+
+    // Proper while loop positioning
+    while Customer.Next() <> 0 do
+    begin
+        if Customer.Blocked then
+        begin
+            Customer.Blocked := false;
+            Customer.Modify();
+        end;
+    end;
+
+    exit(ValidationPassed);
+end;
+```
+
+### Function Declaration Positioning
+```al
+codeunit 50100 "Order Management"
+{
+    procedure CreateOrder(CustomerNo: Code[20]): Code[20]
+    var
+        SalesHeader: Record "Sales Header";
+    begin
+        // Implementation
+        exit(SalesHeader."No.");
+    end;
+
+    procedure UpdateOrder(OrderNo: Code[20]; NewDate: Date)
+    var
+        SalesHeader: Record "Sales Header";
+    begin
+        // Implementation
+    end;
+
+    local procedure ValidateOrder(var SalesHeader: Record "Sales Header"): Boolean
+    var
+        ValidationResult: Boolean;
+    begin
+        // Implementation
+        exit(ValidationResult);
+    end;
+
+    trigger OnRun()
+    begin
+        // Implementation
+    end;
+}
+```
+
+## Bad Examples
+
+### Poor Keyword Line Positioning
+```al
+procedure BadKeywordPositioning(CustomerNo: Code[20])
+var Customer: Record Customer; SalesHeader: Record "Sales Header";  // Wrong: multiple declarations on one line
+begin if Customer.Get(CustomerNo) then begin  // Wrong: multiple keywords on one line
+        if not Customer.Blocked then begin SalesHeader.Init(); SalesHeader."Sell-to Customer No." := CustomerNo;  // Wrong: cramped formatting
+            if SalesHeader.Insert(true) then begin Message('Success'); end else begin Error('Failed'); end;  // Wrong: entire conditional on one line
+        end else begin Error('Customer blocked'); end;  // Wrong: else statement positioning
+    end else begin Error('Customer not found'); end;  // Wrong: else statement positioning
+end;
+```
+
+### Inconsistent Indentation and Positioning
+```al
+procedure InconsistentPositioning(OrderNo: Code[20])
+var
+    SalesLine: Record "Sales Line";
+    Item: Record Item;
+begin
+SalesLine.SetRange("Document No.", OrderNo);  // Wrong: not indented
+
+    if SalesLine.FindSet() then  // Wrong: over-indented
+repeat  // Wrong: should be on new line with proper indentation
+        if SalesLine.Type = SalesLine.Type::Item then  // Wrong: inconsistent indentation
+begin  // Wrong: should align with if
+    Item.Get(SalesLine."No.");  // Wrong: poor indentation
+        Item.Inventory -= SalesLine.Quantity;  // Wrong: inconsistent with previous line
+end  // Wrong: missing semicolon and poor positioning
+    else begin  // Wrong: else positioning and indentation
+SalesLine."Unit Price" := 0;  // Wrong: inconsistent indentation
+        end;  // Wrong: inconsistent with begin
+until SalesLine.Next() = 0;  // Wrong: poor positioning
+end;
+```
+
+### Cramped Control Structures
+```al
+procedure CrampedStructures(Status: Option Open,Released,Pending)
+begin
+    case Status of Status::Open: begin Message('Open'); EnableEditing(); end; Status::Released: begin Message('Released'); DisableEditing(); end; Status::Pending: begin Message('Pending'); RequestApproval(); end; end;  // Wrong: entire case statement on one line
+
+    if Status = Status::Open then begin EnableEditing(); SetStatusColor('Green'); end else if Status = Status::Released then begin DisableEditing(); SetStatusColor('Blue'); end else begin DisableEditing(); SetStatusColor('Red'); end;  // Wrong: complex conditional on one line
+end;
+```
+
+### Poor Function Declaration Formatting
+```al
+codeunit 50101 "Bad Formatting"
+{
+    procedure CreateCustomer(Name: Text[100]; Email: Text[80]; Phone: Text[30]): Code[20] var Customer: Record Customer; CustomerNo: Code[20]; begin Customer.Init(); CustomerNo := NoSeriesMgt.GetNextNo(Setup."Customer Nos.", 0D, true); Customer."No." := CustomerNo; Customer.Name := Name; exit(CustomerNo); end;  // Wrong: entire procedure on few lines
+
+    local procedure ValidateData(Name: Text[100]): Boolean begin if Name = '' then exit(false); exit(true); end;  // Wrong: procedure body on declaration line
+
+trigger OnRun() begin Message('Running'); end;  // Wrong: trigger not properly positioned
+}
+```
+
+### Mixed Line Positioning Styles
+```al
+procedure MixedStyles(OrderNo: Code[20])
+var
+    SalesHeader: Record "Sales Header";
+    ProcessingResult: Boolean;
+begin
+    if SalesHeader.Get(SalesHeader."Document Type"::Order, OrderNo) then begin  // Style 1: keywords on same line
+        ProcessingResult := true;
+        Message('Order found');
+    end
+    else  // Style 2: else on separate line
+    begin
+        ProcessingResult := false;
+        Error('Order not found');
+    end;
+
+    case SalesHeader.Status of  // Style 3: case body on same line
+        SalesHeader.Status::Open: ProcessingResult := true;
+        SalesHeader.Status::Released:  // Style 4: case action on new line
+            ProcessingResult := false;
+    end;
+end;
+```
+
+## Best Practices
+
+1. **Start each major keyword** (if, case, while, for) on its own line
+2. **Consistent indentation** for all keywords at the same logical level
+3. **Align related keywords** (begin/end pairs, if/then/else structures)
+4. **Separate complex logic** across multiple lines for readability
+5. **Maintain consistent style** throughout the entire codeunit