rolldown_error 1.2.0

use arcstr::ArcStr;
use oxc::span::Span;

use super::BuildEvent;
use crate::{
  build_diagnostic::diagnostic::Diagnostic, types::diagnostic_options::DiagnosticOptions,
  types::event_kind::EventKind,
};

#[derive(Debug)]
pub struct InvalidAnnotation {
  pub module_id: String,
  /// Verbatim comment text, e.g. `/* #__PURE__ */` or `/* @__PURE__ */`.
  pub annotation: String,
  pub source: ArcStr,
  /// Span of the comment within the module source.
  pub span: Span,
  /// Whether the annotation appears immediately before a function declaration.
  /// When true, an additional hint suggests using `@__NO_SIDE_EFFECTS__`.
  pub is_before_function_declaration: bool,
}

impl BuildEvent for InvalidAnnotation {
  fn kind(&self) -> EventKind {
    EventKind::InvalidAnnotation
  }

  fn id(&self) -> Option<String> {
    Some(self.module_id.clone())
  }

  fn message(&self, opts: &DiagnosticOptions) -> String {
    format!(
      "A comment \"{}\" in \"{}\" contains an annotation that Rolldown cannot interpret due to the position of the comment.",
      self.annotation,
      opts.stabilize_path(&self.module_id),
    )
  }

  fn on_diagnostic(&self, diagnostic: &mut Diagnostic, opts: &DiagnosticOptions) {
    let filename = opts.stabilize_path(&self.module_id);
    let file_id = diagnostic.add_file(filename, self.source.clone());

    diagnostic.add_label(
      &file_id,
      self.span.start..self.span.end,
      String::from("comment ignored due to position"),
    );

    if self.is_before_function_declaration {
      diagnostic.add_help(String::from(
        "If you intended to mark all calls of this function as side-effect-free, use `/* @__NO_SIDE_EFFECTS__ */` before the function declaration.",
      ));
    }

    diagnostic.add_help(String::from(
      "Correct annotation placement: https://rolldown.rs/in-depth/dead-code-elimination#pure",
    ));
    diagnostic.add_help(String::from("Disable with `checks.invalidAnnotation: false`."));
  }
}

#[cfg(test)]
mod tests {
  use arcstr::ArcStr;
  use oxc::span::Span;

  use crate::BuildDiagnostic;

  #[test]
  fn renders_concise_guide_and_disable_help() {
    let rendered = BuildDiagnostic::invalid_annotation(
      "main.js".to_string(),
      "/* #__PURE__ */".to_string(),
      ArcStr::from("/* #__PURE__ */ foo;"),
      Span::new(0, 15),
      false,
    )
    .with_severity_warning()
    .to_diagnostic()
    .convert_to_string(false);

    assert!(rendered.contains(
      "Help 1: Correct annotation placement: https://rolldown.rs/in-depth/dead-code-elimination#pure"
    ));
    assert!(rendered.contains("Help 2: Disable with `checks.invalidAnnotation: false`."));
    assert_eq!(rendered.matches("Help ").count(), 2);
  }
}