refactor(monorepo): editor-core-types (onivim#2315)

With onivim#2312 and onivim#2313 - moving in `reason-tree-sitter` and `editor-input` - we can now move `editor-core-types` into Onivim proper. The reason behind this is to update some of the common types - like `Index.t` and `Range.t` - they are not quite setup in a way where we can fully benefit from the type-system. In particular, we don't have typing around byte position vs UTF-8 character position vs screen column - they are just all ints or `Index.t`s. We should be able to leverage the type-system for this, and have auxiliary types, like `ByteRange.t`, so that we can be explicit in our APIs to document whether a function expects a byte index, character index, etc, and have it enforced by the compiler.
ssyx02 · Aug 18, 2020 · 43b3aa3 · 43b3aa3
1 parent bb94062
commit 43b3aa3
Show file tree

Hide file tree

Showing 54 changed files with 347 additions and 122 deletions.
diff --git a/bench.esy.lock/index.json b/bench.esy.lock/index.json
diff --git a/esy.lock/index.json b/esy.lock/index.json
diff --git a/integrationtest.esy.lock/index.json b/integrationtest.esy.lock/index.json
diff --git a/package.json b/package.json
@@ -233,7 +233,6 @@
     "@opam/yojson": "1.7.0",
     "@reason-native-web/esy-openssl": "*",
     "axios": "^0.19.0",
-    "editor-core-types": "*",
     "esy-angle-prebuilt": "^1.0.0",
     "esy-macdylibbundler": "*",
     "esy-oniguruma": "onivim/esy-oniguruma#4698ce4",
@@ -253,11 +252,9 @@
   "resolutions": {
     "@opam/yojson": "onivim/yojson:yojson.opam#f480aef",
     "revery": "revery-ui/revery#e646df2",
-    "editor-core-types": "onivim/editor-core-types#6a8afaf",
     "esy-skia": "revery-ui/esy-skia#a3785f9",
     "rench": "bryphe/rench#a976fe5",
     "reasonFuzz": "CrossR/reasonFuzz#1ad6f5d",
-    "editor-input": "onivim/editor-input#c494950",
     "isolinear": "revery-ui/isolinear#8cad3b0",
     "revery-terminal": "revery-ui/revery-terminal#37e19a3",
     "@opam/fs": "bryphe/reason-native:fs.opam#fd0225c",

diff --git a/src/Components/dune b/src/Components/dune
@@ -18,6 +18,6 @@
         Oni2.feature.theme
         Rench
         Revery
-        editor-core-types
+        Oni2.editor-core-types
         isolinear
     ))
diff --git a/src/Core/Kernel/dune b/src/Core/Kernel/dune
@@ -7,6 +7,6 @@
         ppx_deriving_yojson.runtime
         Revery.zed
         threads
-        editor-core-types
+        Oni2.editor-core-types
         timber)
     (preprocess (pps lwt_ppx ppx_deriving_yojson ppx_deriving.show)))
diff --git a/src/Core/dune b/src/Core/dune
@@ -17,7 +17,7 @@
         yojson
         ppx_deriving.runtime
         ppx_deriving_yojson.runtime
-        editor-core-types
+        Oni2.editor-core-types
         timber
         ReasonFuzz
         decoders-yojson

diff --git a/src/Feature/Editor/dune b/src/Feature/Editor/dune
@@ -3,7 +3,7 @@
     (public_name Oni2.feature.editor)
     (inline_tests)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.components
       Oni2.exthost

diff --git a/src/Feature/LanguageSupport/dune b/src/Feature/LanguageSupport/dune
@@ -3,7 +3,7 @@
     (public_name Oni2.feature.language_support)
     (inline_tests)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.syntax
       Oni2.feature.commands

diff --git a/src/Feature/Menus/dune b/src/Feature/Menus/dune
@@ -2,7 +2,7 @@
     (name Feature_Menus)
     (public_name Oni2.feature.menus)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.core.whenExpr
       Oni2.feature.commands

diff --git a/src/Feature/SCM/dune b/src/Feature/SCM/dune
@@ -2,7 +2,7 @@
     (name Feature_SCM)
     (public_name Oni2.feature.scm)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.feature.inputText
       Oni2.feature.theme

diff --git a/src/Feature/Search/dune b/src/Feature/Search/dune
@@ -2,7 +2,7 @@
     (name Feature_Search)
     (public_name Oni2.feature.search)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.components
       Oni2.service.font

diff --git a/src/Feature/SignatureHelp/dune b/src/Feature/SignatureHelp/dune
@@ -2,7 +2,7 @@
     (name Feature_SignatureHelp)
     (public_name Oni2.feature.signature_help)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.syntax
       Oni2.feature.commands

diff --git a/src/Feature/Sneak/dune b/src/Feature/Sneak/dune
@@ -2,7 +2,7 @@
     (name Feature_Sneak)
     (public_name Oni2.feature.sneak)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.feature.commands
       Oni2.feature.theme

diff --git a/src/Feature/StatusBar/dune b/src/Feature/StatusBar/dune
@@ -2,7 +2,7 @@
     (name Feature_StatusBar)
     (public_name Oni2.feature.statusbar)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.feature.contextMenu
       Oni2.feature.editor

diff --git a/src/Feature/Syntax/dune b/src/Feature/Syntax/dune
@@ -2,7 +2,7 @@
     (name Feature_Syntax)
     (public_name Oni2.feature.syntax)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.components
       Oni2.syntax

diff --git a/src/Feature/Terminal/dune b/src/Feature/Terminal/dune
@@ -2,7 +2,7 @@
     (name Feature_Terminal)
     (public_name Oni2.feature.terminal)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.components
       Oni2.service.terminal

diff --git a/src/Feature/TitleBar/dune b/src/Feature/TitleBar/dune
@@ -2,7 +2,7 @@
     (name Feature_TitleBar)
     (public_name Oni2.feature.titlebar)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.feature.contextMenu
       Oni2.feature.theme

diff --git a/src/Model/dune b/src/Model/dune
@@ -49,6 +49,6 @@
         Oni2.feature.signature_help
         ReasonFuzz
         textmate
-        editor-core-types
+        Oni2.editor-core-types
     )
     (preprocess (pps lwt_ppx ppx_deriving_yojson ppx_deriving.show)))
diff --git a/src/Service/Clipboard/dune b/src/Service/Clipboard/dune
@@ -2,7 +2,7 @@
     (name Service_Clipboard)
     (public_name Oni2.service.clipboard)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Revery
       isolinear

diff --git a/src/Service/Extensions/dune b/src/Service/Extensions/dune
@@ -2,7 +2,7 @@
     (name Service_Extensions)
     (public_name Oni2.service.extensions)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.exthost
       Oni2.service.net

diff --git a/src/Service/Exthost/dune b/src/Service/Exthost/dune
@@ -2,7 +2,7 @@
     (name Service_Exthost)
     (public_name Oni2.service.exthost)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.exthost
       isolinear

diff --git a/src/Service/Font/dune b/src/Service/Font/dune
@@ -2,7 +2,7 @@
     (name Service_Font)
     (public_name Oni2.service.font)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Revery
       isolinear

diff --git a/src/Service/Net/dune b/src/Service/Net/dune
@@ -3,7 +3,7 @@
     (public_name Oni2.service.net)
     (inline_tests)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.service.os
       Revery

diff --git a/src/Service/OS/dune b/src/Service/OS/dune
@@ -2,7 +2,7 @@
     (name Service_OS)
     (public_name Oni2.service.os)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Revery
       isolinear

diff --git a/src/Service/Syntax/dune b/src/Service/Syntax/dune
@@ -2,7 +2,7 @@
     (name Service_Syntax)
     (public_name Oni2.service.syntax)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.syntax
       Oni2.syntax_client

diff --git a/src/Service/Terminal/dune b/src/Service/Terminal/dune
@@ -2,7 +2,7 @@
     (name Service_Terminal)
     (public_name Oni2.service.terminal)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       Oni2.exthost
       Revery

diff --git a/src/Service/Vim/dune b/src/Service/Vim/dune
@@ -2,7 +2,7 @@
     (name Service_Vim)
     (public_name Oni2.service.vim)
     (libraries 
-      editor-core-types
+      Oni2.editor-core-types
       Oni2.core
       isolinear
     )

diff --git a/src/UI/dune b/src/UI/dune
@@ -26,6 +26,6 @@
         Revery
         Revery.zed
         revery-terminal.lib
-        editor-core-types
+        Oni2.editor-core-types
         ppx_deriving.runtime
     ))
diff --git a/src/editor-core-types/Index.re b/src/editor-core-types/Index.re
@@ -0,0 +1,30 @@
+[@deriving show({with_path: false})]
+type t = int; // 0-based internally
+
+let zero = 0;
+
+let fromZeroBased = i => i;
+let fromOneBased = i =>
+  if (i == 0) {
+    raise(Invalid_argument("One-based index cannot be zero"));
+  } else {
+    i - 1;
+  };
+
+let toZeroBased = i => i;
+let toOneBased = i => i + 1;
+
+let equals = (==);
+
+let (==) = (==);
+let (>) = (>);
+let (>=) = (>=);
+let (<) = (<);
+let (<=) = (<=);
+
+let (+) = (+);
+let (-) = (-);
+let ( * ) = ( * );
+let (/) = (/);
+
+let toString = string_of_int;