pub(all) struct ApiItem {
  name : String
  kind : String
  file : String
  line : Int
  documented : Bool
  weak_doc : Bool
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct CiStats {
  workflow_files : Int
  has_moon_check : Bool
  has_moon_test : Bool
  has_moon_fmt : Bool
  has_moon_info : Bool
  has_moon_run : Bool
  has_script_validation : Bool
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct CoverageConfig {
  min_public_api_coverage : Int?
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct DocIssue {
  severity : Severity
  file : String
  line : Int?
  message : String
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct FileCoverage {
  file : String
  public_api_total : Int
  public_api_documented : Int
  public_api_missing_docs : Int
  documentation_coverage : Int
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct MarkdownStats {
  files : Int
  code_blocks : Int
  mbt_check_blocks : Int
  mbt_nocheck_blocks : Int
  moonbit_blocks : Int
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct MoonModStats {
  found : Bool
  legacy_json_found : Bool
  has_name : Bool
  has_version : Bool
  has_readme : Bool
  has_repository : Bool
  has_license : Bool
  has_keywords : Bool
  has_description : Bool
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ProjectReport {
  project_name : String
  project_root : String
  files_scanned : Int
  moonbit_source_files : Int
  public_api_total : Int
  public_api_documented : Int
  public_api_missing_docs : Int
  documentation_coverage : Int
  api_items : Array[ApiItem]
  file_coverage : Array[FileCoverage]
  markdown : MarkdownStats
  readme : ReadmeStats
  moon_mod : MoonModStats
  ci : CiStats
  has_generated_mbti : Bool
  issues : Array[DocIssue]
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ReadmeStats {
  found : Bool
  has_overview : Bool
  has_usage : Bool
  has_code_example : Bool
  has_development_commands : Bool
  has_license_mention : Bool
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct RuleConfig {
  check_readme : Bool
  check_moon_mod : Bool
  check_ci : Bool
  check_generated_mbti : Bool
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ScanConfig {
  exclusions : Array[String]
  rules : RuleConfig
  coverage : CoverageConfig
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ScanOptions {
  exclusions : Array[String]
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) enum Severity {
  Error
  Warning
  Suggestion
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

fn apply_scan_config(config : ScanConfig, options : ScanOptions) -> ScanOptions

fn build_file_coverage(items : Array[ApiItem]) -> Array[FileCoverage]

fn default_scan_config() -> ScanConfig

fn default_scan_options() -> ScanOptions

fn is_github_workflow_file(path : String) -> Bool

fn is_markdown_file(path : String) -> Bool

fn is_moonbit_source_file(path : String) -> Bool

fn is_readme_file(path : String) -> Bool

fn matches_exclusion(path : String, pattern : String) -> Bool

fn parse_scan_config(source : String) -> ScanConfig

fn project_name() -> String

fn project_readiness_issues(report : ProjectReport, config : ScanConfig) -> Array[DocIssue]

fn render_html(report : ProjectReport, all_issues? : Bool, lang? : String) -> String

fn render_json(report : ProjectReport, indent? : Int) -> String

fn render_markdown(report : ProjectReport, all_issues? : Bool, lang? : String) -> String

fn render_text(report : ProjectReport, all_issues? : Bool, lang? : String) -> String

fn report_from_api_items(project_name : String, items : Array[ApiItem]) -> ProjectReport

fn scan_ci_text(source : String) -> CiStats

fn scan_markdown_text(source : String) -> MarkdownStats

fn scan_moon_mod_json_text(source : String) -> MoonModStats

fn scan_moon_mod_text(source : String) -> MoonModStats

fn scan_moon_source(file : String, source : String) -> Array[ApiItem]

fn scan_project(path : String) -> ProjectReport raise

fn scan_project_with_options(path : String, options : ScanOptions) -> ProjectReport raise

fn scan_readme_text(source : String) -> ReadmeStats

fn should_ignore_path(path : String) -> Bool

fn should_ignore_path_with_exclusions(path : String, exclusions : Array[String]) -> Bool

fn version() -> String