website·Indexed 30 days ago
https://mbarbin.github.io/dunolintAPI documentation for Dunolint, featuring modules for Dune instrumentation, a unified-diff renderer based on the Myers shortest-edit-script algorithm, and a standard library including character and list utilities.
dunolint-lib library provides linting utilities. The primary entry point for using the library is the Dunolint module.dune and dune-project) in OCaml repositories managed by the Dune build system. It allows developers to check customizable invariants, enforce consistency via CI pipelines, and perform systematic changes across multiple files. Common use cases include enabling instrumentation, configuring recurring lint or preprocess flags, and alphabetically sorting libraries.dune files. In its early versions, it can enforce the sorting of dependencies, instrumentation, and the configuration of PPX and their associated flags. It is designed to be integrated into CI pipelines (e.g., GitHub Actions) to ensure project configuration standards are met.Dunolint library provides types and selectors for linting dunolint configuration files. It is organized into several specialized modules including Blang, Condition, Config, Dune, Dune_project, Dune_workspace, Dunolint0, Glob, Linted_file_kind, Path, Predicate, Rule, Trilang, Std, and Private.Myers module provides a unified-diff renderer implementation. It is built upon a vendored version of the Myers shortest-edit-script algorithm to calculate the minimal set of edits between two sequences.dune-workspace or dune-project) in the current directory and its ancestor directories. Once the root is found, Dunolint changes its working directory to that root to ensure consistent path resolution and configuration loading.Dunolint.Dune_project.Name module provides a type t (implemented as a string) for representing project names. It includes validation logic to ensure names meet specific invariants and provides utilities for comparison, hashing, and S-expression serialization.Dune_lang_version module provides tools to handle the dune_lang_version field in Dune project files. It allows for parsing existing versions, writing new version fields, and rewriting existing ones to ensure they meet specific predicates.Dunolint.Dune.Libraries.Predicate module provides a set of predicates designed to validate and check library dependencies within a Dune project configuration.Implicit_transitive_deps module provides a set of tools to handle the implicit_transitive_deps field in a Dune project configuration. It allows developers to create, read, write, and rewrite these configurations, as well as evaluate them against specific predicates for linting purposes.Dunolint.Dune.Instrumentation.Backend.Name module defines a type t (which is internally a string) used to represent names within the Dune instrumentation backend. It provides utilities for validation, conversion to/from S-expressions, and standard comparison operations.Dune_linter.Libraries module provides a type t and a set of functions to handle the (libraries ...) stanza in Dune files. It allows developers to check for library dependencies, parse existing stanzas, and generate or rewrite S-expressions for Dune configuration files.(* Example S-expression syntax for libraries *)
(libraries (mem ordering yojson))