Merge pull request #1263 from Julow/merge-sherlodoc

Merge Sherlodoc

.github/workflows/build.yml

@@ -28,6 +28,7 @@ jobs:
             send-coverage: true
             # Mdx tests Mdx tests
             run-mdx: true
+            test-sherlodoc: true
           - os: macos-latest
             ocaml-compiler: "5.2"
           # - os: windows-latest
@@ -53,11 +54,20 @@ jobs:
           opam-pin: ${{ matrix.run-mdx != true }}
 
       - name: Install dependencies
-        run: opam install --deps-only --with-test ./odoc.opam ./odoc-parser.opam
+        run: |
+          opam install --deps-only --with-test ./odoc.opam ./odoc-parser.opam \
+            ${{ matrix.test-sherlodoc && './sherlodoc.opam' }}
 
       - name: dune runtest
+        if: matrix.test-sherlodoc == true
+        # Run all tests
         run: opam exec -- dune runtest
 
+      - name: dune runtest
+        if: matrix.test-sherlodoc != true
+        # Run the tests for odoc and odoc-parser only
+        run: opam exec -- dune runtest -p odoc,odoc-parser
+
       - name: Mdx tests
         if: matrix.run-mdx == true
         run: |

dune-project

@@ -18,7 +18,9 @@
  "Leo White <[email protected]>"
  "Lubega Simon <[email protected]>"
  "Paul-Elliot Angl\195\168s d'Auriac <[email protected]>"
- "Thomas Refis <[email protected]>")
+ "Thomas Refis <[email protected]>"
+ "Arthur Wendling <[email protected]>"
+ "Emile Trotignon <[email protected]>")
 
 (maintainers
  "Daniel B\195\188nzli <[email protected]>"
@@ -29,3 +31,7 @@
 (cram enable)
 
 (using mdx 0.3)
+
+; Sherlodoc
+(using menhir 2.1)
+(using directory-targets 0.1)

odoc-driver.opam

@@ -46,6 +46,7 @@ depends: [
   "cmdliner"
   "sexplib"
   "ppx_sexp_conv"
+  "sherlodoc"
 ]
 
 build: [

sherlodoc.opam

@@ -0,0 +1,47 @@
+opam-version: "2.0"
+version: "dev"
+synopsis: "Search engine for OCaml documentation"
+maintainer: ["[email protected]"]
+authors: ["Arthur Wendling" "Emile Trotignon"]
+license: "MIT"
+homepage: "https://github.com/ocaml/odoc"
+doc: "https://ocaml.github.io/odoc/"
+bug-reports: "https://github.com/ocaml/odoc/issues"
+depends: [
+  "dune" {>= "3.5"}
+  "ocaml" {>= "4.0.8"}
+  "odoc" {>= "3.0.0"}
+  "base64" {>= "3.5.1"}
+  "bigstringaf" {>= "0.9.1"}
+  "js_of_ocaml" {>= "5.6.0"}
+  "brr" {>= "0.0.6"}
+  "cmdliner" {>= "1.2.0"}
+  "decompress" {>= "1.5.3"}
+  "fpath" {>= "0.7.3"}
+  "lwt" {>= "5.7.0"}
+  "menhir" {>= "20230608"}
+  "ppx_blob" {>= "0.7.2"}
+  "tyxml" {>= "4.6.0"}
+  "result" {>= "1.5"}
+  "odig" {with-test}
+  "base" {with-test & = "v0.16.3"}
+  "alcotest" {with-test}
+]
+depopts: [
+  "ancient" {>= "0.9.1"}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+dev-repo: "git+https://github.com/ocaml/odoc.git"

sherlodoc/.ocamlformat

@@ -0,0 +1,9 @@
+version = 0.26.1
+profile = janestreet
+let-binding-spacing = compact
+sequence-style = separator
+doc-comments = after-when-possible
+exp-grouping = preserve
+break-cases = toplevel
+cases-exp-indent = 4
+cases-matching-exp-indent = normal

sherlodoc/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Arthur Wendling, Tarides
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sherlodoc/README.md

@@ -0,0 +1,91 @@
+**Try it online at [doc.sherlocode.com](https://doc.sherlocode.com) !**
+
+Sherlodoc is a search engine for OCaml documentation (inspired by [Hoogle](https://hoogle.haskell.org/)), which allows you to search through OCaml libraries by names and approximate type signatures:
+
+- Search by name: [`list map`](https://doc.sherlocode.com/?q=list%20map)
+- Search inside documentation comments: [`raise Not_found`](https://doc.sherlocode.com/?q=raise%20Not_found)
+- Fuzzy type search is introduced with a colon, e.g. [`: map -> list`](https://doc.sherlocode.com/?q=%3A%20map%20-%3E%20list)
+- Search by name and type with a colon separator [`Bogue : Button.t`](https://doc.sherlocode.com/?q=Bogue%20%3A%20Button.t)
+- An underscore `_` can be used as a wildcard in type queries: [`(int -> _) -> list -> _`](https://doc.sherlocode.com/?q=(int%20-%3E%20_)%20-%3E%20list%20-%3E%20_)
+- Type search supports products and reordering of function arguments: [`array -> ('a * int -> bool) -> array`](https://doc.sherlocode.com/?q=%3A%20array%20-%3E%20(%27a%20*%20int%20-%3E%20bool)%20-%3E%20array)
+
+## Local usage
+
+First, install sherlodoc and odig:
+
+```bash
+$ opam pin add 'https://github.com/art-w/sherlodoc.git'  # optional
+
+$ opam install sherlodoc odig
+```
+
+[Odig](https://erratique.ch/software/odig) can generate the odoc documentation of your current switch with:
+
+```bash
+$ odig odoc   # followed by `odig doc` to browse your switch documentation
+```
+
+Which sherlodoc can then index to create a search database:
+
+```bash
+# name your sherlodoc database
+$ export SHERLODOC_DB=/tmp/sherlodoc.marshal
+
+# if you are using OCaml 4, we recommend the `ancient` database format:
+$ opam install ancient
+$ export SHERLODOC_DB=/tmp/sherlodoc.ancient
+
+# index all odoc files generated by odig for your current switch:
+$ sherlodoc index $(find $OPAM_SWITCH_PREFIX/var/cache/odig/odoc -name '*.odocl' | grep -v __)
+```
+
+Enjoy searching from the command-line or run the webserver:
+
+```bash
+$ sherlodoc search "map : list"
+$ sherlodoc search # interactice cli
+
+$ opam install dream
+$ sherlodoc serve  # webserver at http://localhost:1234
+```
+
+The different commands support a `--help` argument for more details/options.
+
+In particular, sherlodoc supports three different file formats for its database, which can be specified either in the filename extension or through the `--db-format=` flag:
+- `ancient` for fast database loading using mmap, but is only compatible with OCaml 4.
+- `marshal` for when ancient is unavailable, with slower database opening.
+- `js` for integration with odoc static html documentation for client-side search without a server.
+
+## Integration with Odoc
+
+Odoc 2.4.0 adds a search bar inside the statically generated html documentation. [Integration with dune is in progress](https://github.com/ocaml/dune/pull/9772), you can try it inside a fresh opam switch with: (warning! this will recompile any installed package that depends on dune!)
+
+```bash
+$ opam pin https://github.com/emileTrotignon/dune.git#search-odoc-new
+
+$ dune build @doc # in your favorite project
+```
+
+Otherwise, manual integration with odoc requires to add to every call of `odoc html-generate` the flags `--search-uri sherlodoc.js --search-uri db.js` to activate the search bar. You'll also need to generate a search database `db.js` and provide the `sherlodoc.js` dependency (a version of the sherlodoc search engine with odoc support, compiled to javascript):
+
+```bash
+$ sherlodoc index --db=_build/default/_doc/_html/YOUR_LIB/db.js \
+    $(find _build/default/_doc/_odocls/YOUR_LIB -name '*.odocl' | grep -v __)
+
+$ sherlodoc js > _build/default/_doc/_html/sherlodoc.js
+```
+
+## How it works
+
+The sherlodoc database uses [Suffix Trees](https://en.wikipedia.org/wiki/Suffix_tree) to search for substrings in value names, documentation and types. During indexation, the suffix trees are compressed to state machine automatas. The children of every node are also sorted, such that a sub-tree can be used as a priority queue during search enumeration.
+
+To rank the search results, sherlodoc computes a static evaluation of each candidate during indexation. This static scoring biases the search to favor short names, short types, the presence of documentation, etc. When searching, a dynamic evaluation dependent on the user query is used to adjust the static ordering of the results:
+
+- How similar is the result name to the search query? (to e.g. prefer results which respect the case: [`map`](https://doc.sherlocode.com/?q=map) vs [`Map`](https://doc.sherlocode.com/?q=Map))
+- How similar are the types? (using a tree diff algorithm, as for example [`('a -> 'b -> 'a) -> 'a -> 'b list -> 'a`](https://doc.sherlocode.com/?q=(%27a%20-%3E%20%27b%20-%3E%20%27a)%20-%3E%20%27a%20-%3E%20%27b%20list%20-%3E%20%27a) and [`('a -> 'b -> 'b) -> 'a list -> 'b -> 'b`](https://doc.sherlocode.com/?q=(%27a%20-%3E%20%27b%20-%3E%20%27b)%20-%3E%20%27a%20list%20-%3E%20%27b%20-%3E%20%27b) are isomorphic yet point to `fold_left` and `fold_right` respectively)
+
+For fuzzy type search, sherlodoc aims to provide good results without requiring a precise search query, on the basis that the user doesn't know the exact type of the things they are looking for (e.g. [`string -> file_descr`](https://doc.sherlocode.com/?q=string%20-%3E%20file_descr) is incomplete but should still point in the right direction). In particular when exploring a package documentation, the common question "how do I produce a value of type `foo`" can be answered with the query `: foo` (and "which functions consume a value of type `bar`" with `: bar -> _`). This should also work when the type can only be produced indirectly through a callback (for example [`: Eio.Switch.t`](https://doc.sherlocode.com/?q=%3A%20Eio.Switch.t) has no direct constructor). To achieve this, sherlodoc performs a type decomposition based on the polarity of each term: A value produced by a function is said to be positive, while an argument consumed by a function is negative. This simplifies away the tree shape of types, allowing their indexation in the suffix trees. The cardinality of each value type is also indexed, to e.g. differentiate between [`list -> list`](https://doc.sherlocode.com/?q=list%20-%3E%20list) and [`list -> list -> list`](https://doc.sherlocode.com/?q=list%20-%3E%20list%20-%3E%20list).
+
+While the polarity search results are satisfying, sherlodoc offers very limited support for polymorphic variables, type aliases and true type isomorphisms. You should check out the extraordinary [Dowsing](https://github.com/Drup/dowsing) project for this!
+
+And if you speak French, a more detailed [presentation of Sherlodoc](https://www.irill.org/videos/OUPS/2023-03/wendling.html) (and [Sherlocode](https://sherlocode.com)) was given at the [OCaml Users in PariS (OUPS)](https://oups.frama.io/) in March 2023.

sherlodoc/cli/dune

@@ -0,0 +1,20 @@
+(ocamllex unescape)
+
+(executable
+ (name main)
+ (public_name sherlodoc)
+ (package sherlodoc)
+ (libraries
+  cmdliner
+  index
+  query
+  db_store
+  unix
+  (select
+   serve.ml
+   from
+   (www -> serve.available.ml)
+   (!www -> serve.unavailable.ml)))
+ (preprocess
+  (pps ppx_blob))
+ (preprocessor_deps ../jsoo/sherlodoc.js))

sherlodoc/cli/main.ml

@@ -0,0 +1,83 @@
+let guess_db_format db_format db_filename =
+  match db_format with
+  | Some db_format -> db_format
+  | None -> begin
+    let ext = Filename.extension db_filename in
+    let ext_len = String.length ext in
+    let ext = if ext_len = 0 then ext else String.sub ext 1 (ext_len - 1) in
+    try List.assoc ext Db_store.available_backends with
+    | Not_found ->
+      Format.fprintf
+        Format.err_formatter
+        "Unknown db format extension %S (expected: %s)@."
+        ext
+        (String.concat ", " @@ List.map fst Db_store.available_backends) ;
+      exit 1
+  end
+
+open Cmdliner
+
+let db_format =
+  let env =
+    let doc = "Database format" in
+    Cmd.Env.info "SHERLODOC_FORMAT" ~doc
+  in
+  let kind = Arg.enum Db_store.available_backends in
+  Arg.(value & opt (some kind) None & info [ "format" ] ~docv:"DB_FORMAT" ~env)
+
+let db_filename =
+  let env =
+    let doc = "The database to query" in
+    Cmd.Env.info "SHERLODOC_DB" ~doc
+  in
+  Arg.(required & opt (some string) None & info [ "db"; "o" ] ~docv:"DB" ~env)
+
+let db_path =
+  let env =
+    let doc = "The database to query" in
+    Cmd.Env.info "SHERLODOC_DB" ~doc
+  in
+  Arg.(required & opt (some file) None & info [ "db" ] ~docv:"DB" ~env)
+
+let with_db fn db_path =
+  let apply fn db_format db_filename =
+    let db_format = guess_db_format db_format db_filename in
+    fn db_format db_filename
+  in
+  Term.(const apply $ fn $ db_format $ db_path)
+
+let cmd_search =
+  let info = Cmd.info "search" ~doc:"Command-line search" in
+  Cmd.v info (with_db Search.term db_path)
+
+let cmd_index =
+  let doc = "Index odocl files to create a Sherlodoc database" in
+  let info = Cmd.info "index" ~doc in
+  Cmd.v info (with_db Index.term db_filename)
+
+let cmd_serve =
+  let doc = "Webserver interface" in
+  let info = Cmd.info "serve" ~doc in
+  Cmd.v info (with_db Serve.term db_path)
+
+let cmd_jsoo =
+  let doc = "For dune/odoc integration, sherlodoc compiled as javascript" in
+  let info = Cmd.info "js" ~doc in
+  let target =
+    let doc = "Name of the file to create" in
+    Arg.(value & pos 0 string "" & info [] ~docv:"QUERY" ~doc)
+  in
+  let emit_js_dep filename =
+    let close, h = if filename = "" then false, stdout else true, open_out filename in
+    output_string h [%blob "../jsoo/sherlodoc.js"] ;
+    if close then close_out h
+  in
+  Cmd.v info Term.(const emit_js_dep $ target)
+
+let cmd =
+  let doc = "Sherlodoc" in
+  let version = "0.2" in
+  let info = Cmd.info "sherlodoc" ~version ~doc in
+  Cmd.group info [ cmd_search; cmd_index; cmd_serve; cmd_jsoo ]
+
+let () = exit (Cmd.eval cmd)