package dunolint

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Utils

package dunolint

dunolint
- CHANGES
- README
- Library dunolint.dune_linter
  - Dune_linter
    
    Executable
    
    Name
    
    Public_name
    
    Linter
    
    Private
    
    Flags
    
    Instrumentation
    
    Library
    
    Name
    
    Public_name
    
    Linter
    
    Private
    
    Libraries
    
    Entry
    
    Lint
    
    Pps
    
    Arg
    
    Preprocess
    
    Stanza
- Library dunolint.dune_project_linter
  - Dune_project_linter
    
    Generate_opam_files
    
    Linter
    
    Implicit_transitive_deps
    
    Linter
    
    Name
    
    Linter
    
    Stanza
- Library dunolint.dunolint_cli
  - Dunolint_cli
- Library dunolint.dunolint_engine
  - Dunolint_engine
    
    Config
    
    Running_mode
    
    Visitor_decision
- Library dunolint.dunolinter
  - Dunolinter
    
    Handler
    
    Predicate
    
    Linter
    
    S
    
    Linters
    
    Sexp_handler
    
    S
    
    Make_atom
    
    Make_sexps
    
    Make_sexpable
    
    Stanza_linter
    
    S
    
    Stanza
    
    S
    
    Stanza
    
    Private
    
    Stanza
    
    For_create
- Library dunolint.vendor_git_pager
  - Dunolint_vendor_git_pager
    
    Git_pager
- Library dunolint.vendor_prompt
  - Dunolint_vendor_prompt
    
    Prompt
    
    Choice
    
    Arg
- Sources
  - dunolint.dune_linter
    
    dune_linter.ml
    
    dune_linter__.ml
    
    executable.ml
    
    executable__name.ml
    
    executable__public_name.ml
    
    flags.ml
    
    include_subdirs.ml
    
    instrumentation.ml
    
    libraries.ml
    
    library.ml
    
    library__name.ml
    
    library__public_name.ml
    
    lint.ml
    
    pps.ml
    
    preprocess.ml
  - dunolint.dune_project_linter
    
    dune_project_linter.ml
    
    dune_project_linter__.ml
    
    generate_opam_files.ml
    
    implicit_transitive_deps.ml
    
    name.ml
  - dunolint.dunolint_cli
    
    cmd__lint.ml
    
    common.ml
    
    dunolint_cli.ml
    
    dunolint_cli__.ml
  - dunolint.dunolint_engine
    
    config.ml
    
    dunolint_engine.ml
    
    dunolint_engine__.ml
  - dunolint.dunolinter
    
    dunolinter.ml
    
    dunolinter__.ml
    
    handler.ml
    
    linter.ml
    
    linters.ml
    
    sexp_handler.ml
    
    stanza_linter.ml
  - dunolint.vendor_git_pager
    
    dunolint_vendor_git_pager.ml
    
    git_pager.ml
  - dunolint.vendor_prompt
    
    dunolint_vendor_prompt.ml
    
    prompt.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Dunolinter.Sexp_handler`Source

A handler for fields found in a dune stanza (in files "dune", "dune-project", etc.)

Such field is typically identified by its name, and then it is immediately followed by a variable number of arguments.

For example:

(name dunolint)

(libraries base sexps-rewriter)

A field starts with an atom (the field name), and the arguments are in a list of sexps.

By that definition, a stanza is a field itself, and its subfields just as well.

Sourcemodule type S = sig ... end

Sourcemodule Make_atom (_ : sig ... end) : S with type t = Base.string

A util to create a handler for an atom field, that is one that expects exactly one required argument that is an Sexp.Atom.

Sourcemodule Make_sexps (_ : sig ... end) : S with type t = Base.Sexp.t Base.list

A util to create a generic field handler that doesn't try to parse its arguments.

Source

module Make_sexpable
  (_ : sig ... end)
  (M : Base.Sexpable.S) : 
  S with type t = M.t

A util to create a handler from a sexpable type. The handler will expect exactly one value, which will be parsed and written (or replaced) according to the sexp serializer provided.

Utils

Source

val find : 
  (module S with type t = 'a) ->
  sexps_rewriter:Sexps_rewriter.t ->
  fields:Base.Sexp.t Base.list ->
  'a Base.option

A convenient wrapper for read that finds the field to read from a list of fields embedded within a containing list of fields. The first field with the expected name is chosen and then we call read on it.

Source

val get_args : 
  field_name:Base.string ->
  sexps_rewriter:Sexps_rewriter.t ->
  field:Base.Sexp.t ->
  Base.Sexp.t Base.list

Destruct the given field and verify it has the correct field name. Return the args then. If the field doesn't have the right shape, and error is raised, using a location found via sexps_rewriter.

Source

val insert_new_fields : 
  sexps_rewriter:Sexps_rewriter.t ->
  indicative_field_ordering:Base.string Base.list ->
  fields:Base.Sexp.t Base.list ->
  new_fields:Base.Sexp.t Base.list ->
  Base.unit

During a dunolint lint, insert all fields found in new_fields that are not present in the existing fields. For those that are already present, it will be necessary to merge them with the expected value, see the rewrite functions of the module that corresponds to that particular field. For example: Dune_linter.Library.rewrite.

package dunolint

Module Dunolinter.Sexp_handlerSource

Utils

Module `Dunolinter.Sexp_handler`Source