harn-lint 0.8.78

//! `prefer-optional-shorthand` rule: type expressions of the form
//! `T | nil` (or `nil | T`) should be written as the postfix sugar
//! `T?`. The formatter rewrites this automatically; the lint rule
//! flags it independently so callers see the diagnostic without
//! running `harn fmt --fix` first.

use std::collections::HashSet;

use harn_lexer::{FixEdit, Span, TokenKind};
use harn_parser::{
    format_type, DiagnosticCode as Code, EnumVariant, InterfaceMethod, MatchArm, Node, SNode,
    ShapeField, StructField, TypeExpr, TypedParam,
};

use crate::diagnostic::{LintDiagnostic, LintSeverity};

pub(crate) fn check_prefer_optional_shorthand(
    source: &str,
    program: &[SNode],
    diagnostics: &mut Vec<LintDiagnostic>,
) {
    let mut state = State {
        source,
        diagnostics,
        emitted: HashSet::new(),
        redacted: collect_redacted_ranges(source),
    };
    for node in program {
        state.visit_node(node);
    }
}

struct State<'a, 'd> {
    source: &'a str,
    diagnostics: &'d mut Vec<LintDiagnostic>,
    emitted: HashSet<usize>,
    /// Half-open `[start, end)` byte ranges covering comments, string
    /// literals, raw strings, and interpolated strings — substrings
    /// inside these are not real `T | nil` annotations and must be
    /// skipped to avoid false-positives like a comment that mentions
    /// the legacy syntax.
    redacted: Vec<(usize, usize)>,
}

impl<'a, 'd> State<'a, 'd> {
    fn visit_node(&mut self, node: &SNode) {
        let span = node.span;
        match &node.node {
            Node::AttributedDecl { inner, .. } => self.visit_node(inner),
            Node::Pipeline {
                return_type, body, ..
            } => {
                if let Some(ty) = return_type {
                    self.visit_type(ty, span);
                }
                self.visit_block(body);
            }
            Node::LetBinding {
                type_ann, value, ..
            }
            | Node::VarBinding {
                type_ann, value, ..
            } => {
                if let Some(ty) = type_ann {
                    self.visit_type(ty, span);
                }
                self.visit_node(value);
            }
            Node::ConstBinding {
                type_ann, value, ..
            } => {
                if let Some(ty) = type_ann {
                    self.visit_type(ty, span);
                }
                self.visit_node(value);
            }
            Node::FnDecl {
                params,
                return_type,
                body,
                ..
            }
            | Node::ToolDecl {
                params,
                return_type,
                body,
                ..
            } => {
                self.visit_typed_params(params, span);
                if let Some(ty) = return_type {
                    self.visit_type(ty, span);
                }
                self.visit_block(body);
            }
            Node::Closure { params, body, .. } => {
                self.visit_typed_params(params, span);
                self.visit_block(body);
            }
            Node::TypeDecl { type_expr, .. } => {
                self.visit_type(type_expr, span);
            }
            Node::StructDecl { fields, .. } => {
                for field in fields {
                    self.visit_struct_field(field, span);
                }
            }
            Node::EnumDecl { variants, .. } => {
                for variant in variants {
                    self.visit_enum_variant(variant, span);
                }
            }
            Node::InterfaceDecl {
                associated_types,
                methods,
                ..
            } => {
                for (_, ty) in associated_types {
                    if let Some(ty) = ty {
                        self.visit_type(ty, span);
                    }
                }
                for method in methods {
                    self.visit_interface_method(method, span);
                }
            }
            Node::ImplBlock { methods, .. } => {
                for m in methods {
                    self.visit_node(m);
                }
            }
            Node::IfElse {
                condition,
                then_body,
                else_body,
            } => {
                self.visit_node(condition);
                self.visit_block(then_body);
                if let Some(body) = else_body {
                    self.visit_block(body);
                }
            }
            Node::ForIn { iterable, body, .. }
            | Node::WhileLoop {
                condition: iterable,
                body,
            }
            | Node::Retry {
                count: iterable,
                body,
            } => {
                self.visit_node(iterable);
                self.visit_block(body);
            }
            Node::CostRoute { options, body } => {
                for (_, expr) in options {
                    self.visit_node(expr);
                }
                self.visit_block(body);
            }
            Node::TryCatch {
                has_catch: _,
                body,
                error_type,
                catch_body,
                finally_body,
                ..
            } => {
                self.visit_block(body);
                if let Some(ty) = error_type {
                    self.visit_type(ty, span);
                }
                self.visit_block(catch_body);
                if let Some(body) = finally_body {
                    self.visit_block(body);
                }
            }
            Node::TryExpr { body }
            | Node::SpawnExpr { body }
            | Node::ScopeBlock { body }
            | Node::Block(body)
            | Node::DeferStmt { body }
            | Node::MutexBlock { body, .. } => self.visit_block(body),
            Node::DeadlineBlock { duration, body } => {
                self.visit_node(duration);
                self.visit_block(body);
            }
            Node::Parallel {
                expr,
                body,
                options,
                ..
            } => {
                self.visit_node(expr);
                for (_, value) in options {
                    self.visit_node(value);
                }
                self.visit_block(body);
            }
            Node::SelectExpr {
                cases,
                timeout,
                default_body,
            } => {
                for case in cases {
                    self.visit_node(&case.channel);
                    self.visit_block(&case.body);
                }
                if let Some((to_expr, body)) = timeout {
                    self.visit_node(to_expr);
                    self.visit_block(body);
                }
                if let Some(body) = default_body {
                    self.visit_block(body);
                }
            }
            Node::ReturnStmt { value } => {
                if let Some(v) = value {
                    self.visit_node(v);
                }
            }
            Node::ThrowStmt { value } | Node::EmitExpr { value } => self.visit_node(value),
            Node::YieldExpr { value } => {
                if let Some(v) = value {
                    self.visit_node(v);
                }
            }
            Node::FunctionCall {
                type_args, args, ..
            } => {
                for ty in type_args {
                    self.visit_type(ty, span);
                }
                for arg in args {
                    self.visit_node(arg);
                }
            }
            Node::MethodCall { object, args, .. }
            | Node::OptionalMethodCall { object, args, .. } => {
                self.visit_node(object);
                for arg in args {
                    self.visit_node(arg);
                }
            }
            Node::PropertyAccess { object, .. }
            | Node::OptionalPropertyAccess { object, .. }
            | Node::Spread(object)
            | Node::TryOperator { operand: object }
            | Node::TryStar { operand: object }
            | Node::UnaryOp {
                operand: object, ..
            } => self.visit_node(object),
            Node::SubscriptAccess { object, index }
            | Node::OptionalSubscriptAccess { object, index } => {
                self.visit_node(object);
                self.visit_node(index);
            }
            Node::SliceAccess { object, start, end } => {
                self.visit_node(object);
                if let Some(s) = start {
                    self.visit_node(s);
                }
                if let Some(e) = end {
                    self.visit_node(e);
                }
            }
            Node::BinaryOp { left, right, .. } => {
                self.visit_node(left);
                self.visit_node(right);
            }
            Node::Ternary {
                condition,
                true_expr,
                false_expr,
            } => {
                self.visit_node(condition);
                self.visit_node(true_expr);
                self.visit_node(false_expr);
            }
            Node::Assignment { target, value, .. } => {
                self.visit_node(target);
                self.visit_node(value);
            }
            Node::EnumConstruct { args, .. } => {
                for a in args {
                    self.visit_node(a);
                }
            }
            Node::StructConstruct { fields, .. } | Node::DictLiteral(fields) => {
                for entry in fields {
                    self.visit_node(&entry.key);
                    self.visit_node(&entry.value);
                }
            }
            Node::ListLiteral(items) | Node::OrPattern(items) => {
                for item in items {
                    self.visit_node(item);
                }
            }
            Node::MatchExpr { value, arms } => {
                self.visit_node(value);
                for arm in arms {
                    self.visit_match_arm(arm);
                }
            }
            Node::HitlExpr { args, .. } => {
                for arg in args {
                    self.visit_node(&arg.value);
                }
            }
            Node::GuardStmt {
                condition,
                else_body,
            } => {
                self.visit_node(condition);
                self.visit_block(else_body);
            }
            Node::RequireStmt { condition, message } => {
                self.visit_node(condition);
                if let Some(m) = message {
                    self.visit_node(m);
                }
            }
            Node::RangeExpr { start, end, .. } => {
                self.visit_node(start);
                self.visit_node(end);
            }
            // Pattern expressions and pure literals carry no types.
            Node::OverrideDecl { body, .. } => self.visit_block(body),
            Node::SkillDecl { fields, .. } => {
                for (_, value) in fields {
                    self.visit_node(value);
                }
            }
            Node::EvalPackDecl {
                fields,
                body,
                summarize,
                ..
            } => {
                for (_, value) in fields {
                    self.visit_node(value);
                }
                self.visit_block(body);
                if let Some(s) = summarize {
                    self.visit_block(s);
                }
            }
            // Leaf / no-type nodes — nothing to walk.
            Node::ImportDecl { .. }
            | Node::SelectiveImport { .. }
            | Node::BreakStmt
            | Node::ContinueStmt
            | Node::DurationLiteral(_)
            | Node::IntLiteral(_)
            | Node::FloatLiteral(_)
            | Node::StringLiteral(_)
            | Node::RawStringLiteral(_)
            | Node::BoolLiteral(_)
            | Node::NilLiteral
            | Node::Identifier(_)
            | Node::InterpolatedString(_) => {}
        }
    }

    fn visit_block(&mut self, body: &[SNode]) {
        for n in body {
            self.visit_node(n);
        }
    }

    fn visit_typed_params(&mut self, params: &[TypedParam], parent_span: Span) {
        for p in params {
            if let Some(ty) = &p.type_expr {
                self.visit_type(ty, parent_span);
            }
            if let Some(default) = &p.default_value {
                self.visit_node(default);
            }
        }
    }

    fn visit_struct_field(&mut self, field: &StructField, parent_span: Span) {
        if let Some(ty) = &field.type_expr {
            self.visit_type(ty, parent_span);
        }
    }

    fn visit_enum_variant(&mut self, variant: &EnumVariant, parent_span: Span) {
        for f in &variant.fields {
            if let Some(ty) = &f.type_expr {
                self.visit_type(ty, parent_span);
            }
        }
    }

    fn visit_interface_method(&mut self, method: &InterfaceMethod, parent_span: Span) {
        self.visit_typed_params(&method.params, parent_span);
        if let Some(ty) = &method.return_type {
            self.visit_type(ty, parent_span);
        }
    }

    fn visit_match_arm(&mut self, arm: &MatchArm) {
        self.visit_node(&arm.pattern);
        if let Some(g) = &arm.guard {
            self.visit_node(g);
        }
        self.visit_block(&arm.body);
    }

    /// Walk a TypeExpr tree, emitting a diagnostic for every union arm
    /// that is shorthand-eligible (`T | nil` → `T?`).
    fn visit_type(&mut self, ty: &TypeExpr, parent_span: Span) {
        match ty {
            TypeExpr::Union(members) => {
                if let Some(inner) = optional_inner(members) {
                    self.try_emit(inner, parent_span);
                }
                for m in members {
                    self.visit_type(m, parent_span);
                }
            }
            TypeExpr::Intersection(members) => {
                for m in members {
                    self.visit_type(m, parent_span);
                }
            }
            TypeExpr::List(inner)
            | TypeExpr::Iter(inner)
            | TypeExpr::Generator(inner)
            | TypeExpr::Stream(inner) => self.visit_type(inner, parent_span),
            TypeExpr::DictType(k, v) => {
                self.visit_type(k, parent_span);
                self.visit_type(v, parent_span);
            }
            TypeExpr::Applied { args, .. } => {
                for a in args {
                    self.visit_type(a, parent_span);
                }
            }
            TypeExpr::Shape(fields) => {
                for f in fields {
                    self.visit_shape_field(f, parent_span);
                }
            }
            TypeExpr::FnType {
                params,
                return_type,
            } => {
                for p in params {
                    self.visit_type(p, parent_span);
                }
                self.visit_type(return_type, parent_span);
            }
            TypeExpr::Named(_) | TypeExpr::Never | TypeExpr::LitString(_) | TypeExpr::LitInt(_) => {
            }
            TypeExpr::Owned(inner) => self.visit_type(inner, parent_span),
        }
    }

    fn visit_shape_field(&mut self, field: &ShapeField, parent_span: Span) {
        self.visit_type(&field.type_expr, parent_span);
    }

    /// Find the earliest match of either needle within `region` whose
    /// absolute start hasn't already been flagged. Returns absolute
    /// (start, end) source offsets.
    fn next_unemitted_match(
        &self,
        region: &str,
        region_offset: usize,
        needle_after: &str,
        needle_before: &str,
    ) -> Option<(usize, usize)> {
        let mut best: Option<(usize, usize)> = None;
        let mut consider = |rel_start: usize, len: usize| {
            let abs_start = region_offset + rel_start;
            if self.emitted.contains(&abs_start) {
                return;
            }
            if self.in_redacted_range(abs_start) {
                return;
            }
            if best.map(|(s, _)| abs_start < s).unwrap_or(true) {
                best = Some((abs_start, abs_start + len));
            }
        };
        let mut search_at = 0;
        while let Some(pos) = region[search_at..].find(needle_after) {
            consider(search_at + pos, needle_after.len());
            search_at += pos + 1;
        }
        let mut search_at = 0;
        while let Some(pos) = region[search_at..].find(needle_before) {
            consider(search_at + pos, needle_before.len());
            search_at += pos + 1;
        }
        best
    }

    /// Emit a `prefer-optional-shorthand` diagnostic for a single
    /// `T | nil` site if its literal source can be located within
    /// `parent_span`. Render `inner` via the canonical type formatter
    /// and look for `<inner> | nil` or `nil | <inner>` substrings.
    /// Falls back to a fix-less diagnostic when the source can't be
    /// matched (e.g., the source whitespace doesn't normalize).
    fn try_emit(&mut self, inner: &TypeExpr, parent_span: Span) {
        let inner_text = format_type(inner);
        let region = match self.source.get(parent_span.start..parent_span.end) {
            Some(r) => r,
            None => return,
        };
        // Multiple sites in the same parent (e.g. `fn f(x: T | nil) -> T | nil`)
        // share a parent span, so we must walk past already-emitted offsets to
        // find the next un-flagged occurrence rather than re-flagging the first.
        let needle_after = format!("{inner_text} | nil");
        let needle_before = format!("nil | {inner_text}");
        let Some((abs_start, abs_end)) =
            self.next_unemitted_match(region, parent_span.start, &needle_after, &needle_before)
        else {
            return;
        };
        if !self.emitted.insert(abs_start) {
            return;
        }
        let span = Span::with_offsets(
            abs_start,
            abs_end,
            line_for(self.source, abs_start),
            column_for(self.source, abs_start),
        );
        let replacement = format!("{inner_text}?");
        self.diagnostics.push(LintDiagnostic {
            code: Code::LintPreferOptionalShorthand,
            rule: "prefer-optional-shorthand".into(),
            message: format!("prefer `{inner_text}?` over `{inner_text} | nil`"),
            span,
            severity: LintSeverity::Warning,
            suggestion: Some(format!(
                "rewrite the optional type to its postfix-`?` shorthand: `{inner_text}?`"
            )),
            fix: Some(vec![FixEdit { span, replacement }]),
        });
    }
}

impl<'a, 'd> State<'a, 'd> {
    fn in_redacted_range(&self, pos: usize) -> bool {
        self.redacted
            .iter()
            .any(|&(start, end)| pos >= start && pos < end)
    }
}

/// Collect half-open byte ranges covering tokens whose contents must
/// not be searched for `T | nil` substrings — comments and string
/// forms. Returns an empty list when the source fails to lex; the lint
/// downgrades to "no diagnostics" rather than crashing on partial input.
fn collect_redacted_ranges(source: &str) -> Vec<(usize, usize)> {
    let mut lexer = harn_lexer::Lexer::new(source);
    let Ok(tokens) = lexer.tokenize_with_comments() else {
        return Vec::new();
    };
    tokens
        .into_iter()
        .filter_map(|t| match t.kind {
            TokenKind::LineComment { .. }
            | TokenKind::BlockComment { .. }
            | TokenKind::StringLiteral(_)
            | TokenKind::InterpolatedString(_)
            | TokenKind::RawStringLiteral(_) => Some((t.span.start, t.span.end)),
            _ => None,
        })
        .collect()
}

fn optional_inner(types: &[TypeExpr]) -> Option<&TypeExpr> {
    if types.len() != 2 {
        return None;
    }
    let nil_idx = types
        .iter()
        .position(|t| matches!(t, TypeExpr::Named(n) if n == "nil"))?;
    let inner = &types[1 - nil_idx];
    if matches!(
        inner,
        TypeExpr::Union(_) | TypeExpr::Intersection(_) | TypeExpr::FnType { .. }
    ) {
        return None;
    }
    if matches!(inner, TypeExpr::Named(n) if n == "nil") {
        return None;
    }
    Some(inner)
}

fn line_for(source: &str, offset: usize) -> usize {
    source[..offset.min(source.len())]
        .bytes()
        .filter(|b| *b == b'\n')
        .count()
        + 1
}

fn column_for(source: &str, offset: usize) -> usize {
    let upto = &source[..offset.min(source.len())];
    upto.rfind('\n')
        .map(|idx| offset - idx)
        .unwrap_or(offset + 1)
}