whitaker-installer

Crates.iowhitaker-installer
lib.rswhitaker-installer
version0.1.0
created_at2026-01-11 18:49:46.614417+00
updated_at2026-01-11 18:49:46.614417+00
descriptionInstaller CLI for Whitaker Dylint lint libraries
homepagehttps://df12.studio/docs.html
repositoryhttps://github.com/leynos/whitaker
max_upload_size
id2036214
size274,607
Leynos (leynos)

documentation

https://github.com/leynos/whitaker/tree/main/docs/users-guide.md

README

whitaker-installer

Installer CLI for Whitaker Dylint lint libraries.

Whitaker is a collection of opinionated Dylint lints for Rust. This installer builds, links, and stages the lint libraries for local use, avoiding the need to rebuild from source on each cargo dylint invocation.

Installation

cargo install whitaker-installer

Usage

Install the default lint suite

whitaker-installer

This builds and stages the aggregated suite containing all standard lints.

Install with experimental lints

whitaker-installer --experimental

Install specific lints

whitaker-installer -l module_max_lines -l no_expect_outside_tests

Install all individual lint crates

whitaker-installer --individual-lints

List installed lints

whitaker-installer list

Output as JSON for scripting:

whitaker-installer list --json

Preview without building

whitaker-installer --dry-run

Available Lints

Whitaker lints are divided into two categories:

  • Standard lints are stable, well-tested, and included in the default suite. They are recommended for general use.
  • Experimental lints are newer or more aggressive checks that may produce false positives or undergo breaking changes. They require the --experimental flag to install.

Standard Lints

These lints are included when running whitaker-installer without flags:

Lint Description
conditional_max_n_branches Limit boolean branches in conditionals
function_attrs_follow_docs Doc comments must precede other attributes
module_max_lines Warn when modules exceed line threshold
module_must_have_inner_docs Require inner doc comments on modules
no_expect_outside_tests Forbid .expect() outside test contexts
no_std_fs_operations Enforce capability-based filesystem access
no_unwrap_or_else_panic Deny panicking unwrap_or_else fallbacks

Experimental Lints

These lints require whitaker-installer --experimental to install:

Lint Description
bumpy_road_function Detect high nesting depth in functions

Experimental lints may be promoted to standard in future releases once they have been sufficiently tested in real-world codebases.

Using the Installed Lints

After installation, set DYLINT_LIBRARY_PATH to the staged directory and run cargo dylint:

cargo dylint --all

The installer generates wrapper scripts and provides shell configuration snippets to simplify this setup.

The wrappers are:

  • whitaker — runs cargo dylint with the staged library path.
  • whitaker-ls — lists installed Whitaker suite libraries for the staged path.

Licence

ISC

Commit count: 74

cargo fmt