Skip to main content

Module check

Module check 

Source
Expand description

cargo kick check — lint an existing kick-rs project for common misconfigurations the compiler doesn’t catch.

Pure-text scanners, no syn round-trip. The patterns we recognize are the same shapes the scaffold + cargo kick g produce:

  • pub mod X; in src/modules/mod.rs
  • .module(modules::X::define()) in src/main.rs
  • pub mod Y; in src/modules/<X>/mod.rs
  • .service::<Pascal>() / .contribute(Pascal) in src/modules/<X>/mod.rs
  • #[service] / #[contributor] annotations in the corresponding src/modules/<X>/<Y>.rs

Findings are reported with the file path + a one-line hint. The CLI exits non-zero when any finding is non-empty; that makes cargo kick check a useful CI gate after generators have run.

Structs§

CheckArgs
Decoded form of the check subcommand.
CheckReport
Per-run summary returned by run.
Finding
One lint finding. The code is a stable identifier — adopters can pin a CI check against a specific lint.

Enums§

CheckError

Functions§

render
Render the report for the CLI.
run
Walk the project and produce a CheckReport.