this repo has no description
Some documentation
+47
-2
+10
README.md
+10
README.md
···
1
1
# merlin-js
2
2
3
3
Try-it: [https://voodoos.github.io/merlin-js](https://voodoos.github.io/merlin-js)
4
+
5
+
To run locally, run 'make' then launch an http server from the 'examples' directory. For example:
6
+
7
+
```sh
8
+
make
9
+
cd examples
10
+
python3 -m http.server
11
+
```
12
+
13
+
+15
example/dynamic.html
+15
example/dynamic.html
···
15
15
font-family: 'Fira Code', monospace
16
16
}
17
17
18
+
p {
19
+
width: 50%;
20
+
margin: auto;
21
+
margin-top: 2rem;
22
+
color: white;
23
+
}
24
+
25
+
a {
26
+
color: lightskyblue
27
+
}
28
+
18
29
#editor {
19
30
min-width: 30rem;
20
31
width: 50%;
···
68
79
69
80
<body>
70
81
<noscript>Sorry, you need to enable JavaScript to see this page.</noscript>
82
+
<p>This example demonstrates merlin with dynamic loading of cmis. Load the
83
+
'Network' tab of the developer tools to see the requests and responses.
84
+
See also the <a href="index.html">static example</a>.
85
+
</p>
71
86
<div id="editor"></div>
72
87
</body>
73
88
+13
example/index.html
+13
example/index.html
···
14
14
background-color: #4c4956;
15
15
font-family: 'Fira Code', monospace
16
16
}
17
+
18
+
p {
19
+
width: 50%;
20
+
margin: auto;
21
+
margin-top: 2rem;
22
+
color: white;
23
+
}
17
24
25
+
a {
26
+
color: lightskyblue
27
+
}
28
+
18
29
#editor {
19
30
min-width: 30rem;
20
31
width: 50%;
···
68
79
69
80
<body>
70
81
<noscript>Sorry, you need to enable JavaScript to see this page.</noscript>
82
+
<p>This example demonstrates merlin with all cmis embedded. See <a href="dynamic.html">dynamic.html</a>
83
+
for an example of dynamically loaded cmis.</p>
71
84
<div id="editor"></div>
72
85
</body>
73
86
+6
src/extension/merlin_codemirror.mli
+6
src/extension/merlin_codemirror.mli
···
8
8
9
9
module type Config = sig
10
10
val worker_url : string
11
+
(** The url of the worker javascript file *)
12
+
11
13
val cmis : Protocol.cmis
14
+
(** CMIs are required for merlin to work correctly. These can either be
15
+
provided statically or provided as a list of URLs from which the
16
+
CMIs can be downloaded. If using URLs, these will only be
17
+
downloaded on demand. *)
12
18
end
13
19
14
20
module Make : functor (Config : Config) -> sig
+3
-2
src/protocol/protocol.ml
+3
-2
src/protocol/protocol.ml
···
3
3
4
4
type source = string
5
5
6
+
(** CMIs are provided either statically or as URLs to be downloaded on demand *)
6
7
type cmis = {
7
-
static_cmis : (string * string) list;
8
-
cmi_urls : string list
8
+
static_cmis : (string * string) list; (** name, content pairs *)
9
+
cmi_urls : string list (** One URL per cmi, e.g. "/static/stdlib/stdlib__List.cmi" *)
9
10
}
10
11
11
12
type action =