package dunolint

  1. Overview
  2. Docs
package dunolint
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Dunolinter.HandlerSource

A handler for evaluating and enforcing predicates.

Sourcetype Stdlib.Effect.t += private
  1. | Enforce_failure : {
    1. condition : 'a;
    2. sexp_of_condition : 'a -> Base.Sexp.t;
    3. loc : Loc.t;
    } -> Base.unit Stdlib.Effect.t
    (*

    A effect performed when a linter comes across a condition that is requested to be enforced, but there is no defined semantic for enforcing it automatically. Depending on the context, the course of actions to react to such case may vary. During linting, it may make sense to produce an error, and continue with the flow to check other rules and the other files. During a more focused execution, perhaps this error shall be fatal.

    *)
Sourcemodule type Predicate = sig ... end
Sourceval enforce_failure : (module Predicate with type t = 'a) -> loc:Loc.t -> condition:'a Dunolint.Std.Blang.t -> Base.unit
Sourceval emit_error_and_resume : 'a -> loc:Loc.t -> f:('a -> 'b) -> 'b

This is a special handler for the effect defined by this module, which will report the error, but continue the execution of linting and enforcing with other rules, predicates and stanzas.

Sourceval raise : f:(Base.unit -> 'a) -> 'a

This is a handler for the effect defined by this module, which will discontinue the effect with an exception. It is suitable for use in expect tests.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct