From 0d5960ee9390dfb87c14118d155161ac0f78b942 Mon Sep 17 00:00:00 2001 From: Kakadu Date: Thu, 25 Jul 2024 12:57:18 +0000 Subject: [PATCH] deploy: de9e040e86d2c68686d3ecca4e75e981517625ee --- api/zanuda/Zanuda_core/CollectedDecls/index.html | 2 ++ api/zanuda/Zanuda_core/Config/index.html | 2 +- api/zanuda/Zanuda_core/Dune_project/index.html | 2 +- api/zanuda/Zanuda_core/LINT/index.html | 2 +- .../Zanuda_core/LINT/module-type-UNUSED_DECLS/index.html | 2 ++ api/zanuda/Zanuda_core/LoadDune/index.html | 6 +++--- api/zanuda/Zanuda_core/index.html | 2 +- 7 files changed, 11 insertions(+), 7 deletions(-) create mode 100644 api/zanuda/Zanuda_core/CollectedDecls/index.html create mode 100644 api/zanuda/Zanuda_core/LINT/module-type-UNUSED_DECLS/index.html diff --git a/api/zanuda/Zanuda_core/CollectedDecls/index.html b/api/zanuda/Zanuda_core/CollectedDecls/index.html new file mode 100644 index 0000000..61ebd86 --- /dev/null +++ b/api/zanuda/Zanuda_core/CollectedDecls/index.html @@ -0,0 +1,2 @@ + +CollectedDecls (zanuda.Zanuda_core.CollectedDecls)

Module Zanuda_core.CollectedDecls

val add_just_decl : string -> unit
val add_used_decl : string -> unit
val print_all_decls : unit -> unit
val print_used_decls : unit -> unit
val collect_unused : unit -> unit
val collect_from_mli_tree : LoadDune.w -> string -> Typedtree.signature -> unit
diff --git a/api/zanuda/Zanuda_core/Config/index.html b/api/zanuda/Zanuda_core/Config/index.html index e9f52fe..d475555 100644 --- a/api/zanuda/Zanuda_core/Config/index.html +++ b/api/zanuda/Zanuda_core/Config/index.html @@ -1,2 +1,2 @@ -Config (zanuda.Zanuda_core.Config)

Module Zanuda_core.Config

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type mode =
  1. | Unspecified
  2. | Dump_json of Base.string
  3. | Dump_text
  4. | File of Base.string
  5. | Dir of Base.string
  6. | Fix of Base.string
type t = {
  1. mutable outfile : Base.string Base.option;
  2. mutable outgolint : Base.string Base.option;
  3. mutable out_rdjsonl : Base.string Base.option;
  4. mutable mode : mode;
  5. mutable workspace : Base.string Base.option;
  6. mutable prefix_to_cut : Base.string Base.option;
  7. mutable prefix_to_add : Base.string Base.option;
  8. mutable extra_includes : Base.string Base.list;
  9. mutable verbose : Base.bool;
  10. mutable gen_replacements : Base.bool;
  11. enabled_lints : Base.string Base.Hash_set.t;
  12. all_lints : Base.string Base.Hash_set.t;
  13. mutable skip_level_allow : Base.bool;
  14. mutable check_filesystem : Base.bool;
}
val opts : t

Modes

val mode : unit -> mode
val set_mode : mode -> unit
val set_dump_file : Base.string -> unit
val set_dump_text : unit -> unit
val set_in_file : Base.string -> unit
val set_in_dir : Base.string -> unit
val set_fix : Base.string -> unit

Other switches

val add_include : Base.string -> unit
val set_out_file : Base.string -> unit
val set_out_golint : Base.string -> unit
val set_out_rdjsonl : Base.string -> unit
val set_workspace : Base.string -> unit
val set_prefix_to_cut : Base.string -> unit
val set_prefix_to_add : Base.string -> unit
val includes : unit -> Base.string Base.list
val prefix_to_cut : unit -> Base.string Base.option
val prefix_to_add : unit -> Base.string Base.option
val is_check_filesystem : unit -> Base.bool
val enabled_lints : unit -> Base.string Base.Hash_set.t
val all_lints : unit -> Base.string Base.Hash_set.t
val outfile : unit -> Base.string Base.option
val out_golint : unit -> Base.string Base.option
val out_rdjsonl : unit -> Base.string Base.option
val unset_check_filesystem : unit -> unit
val verbose : unit -> Base.bool
val gen_replacements : unit -> Base.bool
val set_verbose : unit -> unit
val set_skip_level_allow : Base.bool -> unit
val recover_filepath : Base.String.t -> Base.String.t
val is_enabled : unit -> (module LINT.GENERAL) -> bool
val parse_args : unit -> unit
+Config (zanuda.Zanuda_core.Config)

Module Zanuda_core.Config

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type mode =
  1. | Unspecified
  2. | Dump_json of Base.string
  3. | Dump_text
  4. | File of Base.string
  5. | Dir of Base.string
  6. | Fix of Base.string
  7. | UnusedDecls of Base.string
type t = {
  1. mutable outfile : Base.string Base.option;
  2. mutable outgolint : Base.string Base.option;
  3. mutable out_rdjsonl : Base.string Base.option;
  4. mutable mode : mode;
  5. mutable workspace : Base.string Base.option;
  6. mutable prefix_to_cut : Base.string Base.option;
  7. mutable prefix_to_add : Base.string Base.option;
  8. mutable extra_includes : Base.string Base.list;
  9. mutable verbose : Base.bool;
  10. mutable gen_replacements : Base.bool;
  11. enabled_lints : Base.string Base.Hash_set.t;
  12. all_lints : Base.string Base.Hash_set.t;
  13. mutable skip_level_allow : Base.bool;
  14. mutable check_filesystem : Base.bool;
}
val opts : t

Modes

val mode : unit -> mode
val set_mode : mode -> unit
val set_dump_file : Base.string -> unit
val set_dump_text : unit -> unit
val set_in_file : Base.string -> unit
val set_in_dir : Base.string -> unit
val set_in_unused_decls : Base.string -> unit
val set_fix : Base.string -> unit

Other switches

val add_include : Base.string -> unit
val set_out_file : Base.string -> unit
val set_out_golint : Base.string -> unit
val set_out_rdjsonl : Base.string -> unit
val set_workspace : Base.string -> unit
val set_prefix_to_cut : Base.string -> unit
val set_prefix_to_add : Base.string -> unit
val includes : unit -> Base.string Base.list
val prefix_to_cut : unit -> Base.string Base.option
val prefix_to_add : unit -> Base.string Base.option
val is_check_filesystem : unit -> Base.bool
val enabled_lints : unit -> Base.string Base.Hash_set.t
val all_lints : unit -> Base.string Base.Hash_set.t
val outfile : unit -> Base.string Base.option
val out_golint : unit -> Base.string Base.option
val out_rdjsonl : unit -> Base.string Base.option
val unset_check_filesystem : unit -> unit
val verbose : unit -> Base.bool
val gen_replacements : unit -> Base.bool
val set_verbose : unit -> unit
val set_skip_level_allow : Base.bool -> unit
val recover_filepath : Base.String.t -> Base.String.t
val is_enabled : unit -> (module LINT.GENERAL) -> bool
val parse_args : unit -> unit
diff --git a/api/zanuda/Zanuda_core/Dune_project/index.html b/api/zanuda/Zanuda_core/Dune_project/index.html index c82f593..165134a 100644 --- a/api/zanuda/Zanuda_core/Dune_project/index.html +++ b/api/zanuda/Zanuda_core/Dune_project/index.html @@ -1,2 +1,2 @@ -Dune_project (zanuda.Zanuda_core.Dune_project)

Module Zanuda_core.Dune_project

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type module_ = {
  1. name : Base.string;
  2. impl : Base.string Base.option;
  3. intf : Base.string Base.option;
  4. cmt : Base.string Base.option;
  5. cmti : Base.string Base.option;
}
val module__of_sexp : Sexplib0.Sexp.t -> module_
type executables = {
  1. names : Base.string Base.list;
  2. modules : module_ Base.list;
  3. requires : Base.string Base.list;
  4. include_dirs : Base.string Base.list;
}
val executables_of_sexp : Sexplib0.Sexp.t -> executables
module Library : sig ... end
type t =
  1. | Executables of executables
  2. | Library of Library.t
  3. | Root of Base.string
  4. | Build_context of Base.string
val t_of_sexp : Sexplib0.Sexp.t -> t
+Dune_project (zanuda.Zanuda_core.Dune_project)

Module Zanuda_core.Dune_project

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type module_ = {
  1. name : Base.string;
  2. impl : Base.string Base.option;
  3. intf : Base.string Base.option;
  4. cmt : Base.string Base.option;
  5. cmti : Base.string Base.option;
}
val module__of_sexp : Sexplib0.Sexp.t -> module_
val sexp_of_module_ : module_ -> Sexplib0.Sexp.t
val module_ : ?cmt:Base.string -> ?cmti:Base.string -> Base.string -> module_
type executables = {
  1. names : Base.string Base.list;
  2. modules : module_ Base.list;
  3. requires : Base.string Base.list;
  4. include_dirs : Base.string Base.list;
}
val executables_of_sexp : Sexplib0.Sexp.t -> executables
module Library : sig ... end
type t =
  1. | Executables of executables
  2. | Library of Library.t
  3. | Root of Base.string
  4. | Build_context of Base.string
val t_of_sexp : Sexplib0.Sexp.t -> t
diff --git a/api/zanuda/Zanuda_core/LINT/index.html b/api/zanuda/Zanuda_core/LINT/index.html index 518eca4..c61c611 100644 --- a/api/zanuda/Zanuda_core/LINT/index.html +++ b/api/zanuda/Zanuda_core/LINT/index.html @@ -1,2 +1,2 @@ -LINT (zanuda.Zanuda_core.LINT)

Module Zanuda_core.LINT

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type impl =
  1. | Untyped
  2. | Typed

A type of lint's impelementation. Typed and untyped lints inspect OCaml's Parsetree/Typedtree respectively. In Clippy it corresponds to early and late lint passes.

type group =
  1. | Style
    (*

    Code that should be written in a more idiomatic way

    *)
  2. | Correctness
    (*

    Code that is outright wrong or useless

    *)
  3. | Perf
    (*

    Code that can be written to run faster

    *)
  4. | Restriction
  5. | Deprecated
  6. | Pedantic
    (*

    Lints which are rather strict or might have false positives

    *)
  7. | Complexity
  8. | Suspicious
  9. | Nursery
    (*

    New lints that are still under development

    *)

Group of lints. The same as Rust's Clippy

type level =
  1. | Allow
  2. | Warn
  3. | Deny
  4. | Deprecated

Level of lints. The same as Rust's Clippy

type lint_source =
  1. | Camelot
    (*

    Adopted from Camelot linter

    *)
  2. | Clippy
    (*

    Adopted from Rust's Clippy

    *)
  3. | FPCourse
    (*

    Invented after reviewing Kakadu's student's OCaml homeworks

    *)
  4. | Other
    (*

    The source is not specified

    *)

How various lints were invented

module type GENERAL = sig ... end
module type UNTYPED = sig ... end
module type TYPED = sig ... end
module type REPORTER = sig ... end
+LINT (zanuda.Zanuda_core.LINT)

Module Zanuda_core.LINT

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type impl =
  1. | Untyped
  2. | Typed

A type of lint's impelementation. Typed and untyped lints inspect OCaml's Parsetree/Typedtree respectively. In Clippy it corresponds to early and late lint passes.

type group =
  1. | Style
    (*

    Code that should be written in a more idiomatic way

    *)
  2. | Correctness
    (*

    Code that is outright wrong or useless

    *)
  3. | Perf
    (*

    Code that can be written to run faster

    *)
  4. | Restriction
  5. | Deprecated
  6. | Pedantic
    (*

    Lints which are rather strict or might have false positives

    *)
  7. | Complexity
  8. | Suspicious
  9. | Nursery
    (*

    New lints that are still under development

    *)

Group of lints. The same as Rust's Clippy

type level =
  1. | Allow
  2. | Warn
  3. | Deny
  4. | Deprecated

Level of lints. The same as Rust's Clippy

type lint_source =
  1. | Camelot
    (*

    Adopted from Camelot linter

    *)
  2. | Clippy
    (*

    Adopted from Rust's Clippy

    *)
  3. | FPCourse
    (*

    Invented after reviewing Kakadu's student's OCaml homeworks

    *)
  4. | Other
    (*

    The source is not specified

    *)

How various lints were invented

module type GENERAL = sig ... end
module type UNTYPED = sig ... end
module type TYPED = sig ... end
module type UNUSED_DECLS = sig ... end
module type REPORTER = sig ... end
diff --git a/api/zanuda/Zanuda_core/LINT/module-type-UNUSED_DECLS/index.html b/api/zanuda/Zanuda_core/LINT/module-type-UNUSED_DECLS/index.html new file mode 100644 index 0000000..6005f62 --- /dev/null +++ b/api/zanuda/Zanuda_core/LINT/module-type-UNUSED_DECLS/index.html @@ -0,0 +1,2 @@ + +UNUSED_DECLS (zanuda.Zanuda_core.LINT.UNUSED_DECLS)

Module type LINT.UNUSED_DECLS

type input = Tast_iterator.iterator
include GENERAL with type input := input
val lint_id : string

Linter id. Should be unique

val lint_source : lint_source

How this lint appeared.

val level : level
val run : Compile_common.info -> input -> input

Run this lint and save result in global store CollectedLints.

val documentation : string

Lint's documentation in Markdown.

Dump lint's documentation as Markdown.

val describe_as_json : unit -> Yojson.Safe.t

Dump lint's documentation to as JSON object to use in web-based interfaces.

diff --git a/api/zanuda/Zanuda_core/LoadDune/index.html b/api/zanuda/Zanuda_core/LoadDune/index.html index d6e558e..ae37ada 100644 --- a/api/zanuda/Zanuda_core/LoadDune/index.html +++ b/api/zanuda/Zanuda_core/LoadDune/index.html @@ -1,7 +1,7 @@ -LoadDune (zanuda.Zanuda_core.LoadDune)

Module Zanuda_core.LoadDune

Copyright 2021-2023, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

val analyze_dir : +LoadDune (zanuda.Zanuda_core.LoadDune)

Module Zanuda_core.LoadDune

Copyright 2021-2024, Kakadu.

SPDX-License-Identifier: LGPL-3.0-or-later

type w =
  1. | Wrapped of string
  2. | Non_wrapped
val pp_w : Stdlib.Format.formatter -> w -> unit
val analyze_dir : untyped:(string -> unit) -> - cmt:(string -> Typedtree.structure -> unit) -> - cmti:(string -> Typedtree.signature -> unit) -> + cmt:(w -> string -> Typedtree.structure -> unit) -> + cmti:(w -> string -> Typedtree.signature -> unit) -> string -> unit
diff --git a/api/zanuda/Zanuda_core/index.html b/api/zanuda/Zanuda_core/index.html index 6797bed..e5b369b 100644 --- a/api/zanuda/Zanuda_core/index.html +++ b/api/zanuda/Zanuda_core/index.html @@ -1,2 +1,2 @@ -Zanuda_core (zanuda.Zanuda_core)

Module Zanuda_core

module CollectedLints : sig ... end

Copyright 2021-2023, Kakadu.

module Config : sig ... end

Copyright 2021-2023, Kakadu.

module Dune_project : sig ... end

Copyright 2021-2023, Kakadu.

module LINT : sig ... end

Copyright 2021-2023, Kakadu.

module Lint_filesystem : sig ... end

Copyright 2021-2023, Kakadu.

module LoadDune : sig ... end

Copyright 2021-2023, Kakadu.

module Utils : sig ... end

Copyright 2021-2023, Kakadu.

+Zanuda_core (zanuda.Zanuda_core)

Module Zanuda_core

module CollectedDecls : sig ... end
module CollectedLints : sig ... end

Copyright 2021-2023, Kakadu.

module Config : sig ... end

Copyright 2021-2023, Kakadu.

module Dune_project : sig ... end

Copyright 2021-2023, Kakadu.

module LINT : sig ... end

Copyright 2021-2023, Kakadu.

module Lint_filesystem : sig ... end

Copyright 2021-2023, Kakadu.

module LoadDune : sig ... end

Copyright 2021-2024, Kakadu.

module Utils : sig ... end

Copyright 2021-2023, Kakadu.