Merge pull request #37 from ocsigen/follow-relative-references

Follow relative references

Author: cannorin

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Add an option `--merge` to merge the input definition files to one binding.
+  - This is a breaking change; previously `--merge` was the default behavior.
+- Add an option `--follow-relative-references` to generate bindings for relevant files at once.
 
 ## [1.1.0] - 2021-11-24
 - Upgrade and fixed TypeScript version to >= 4.5.2 < 4.6.0.

build.fsx

@@ -123,22 +123,25 @@ module Test =
 
       let packages = [
          // "full" package involving a lot of inheritance
-         "full", !! "node_modules/typescript/lib/typescript.d.ts";
+         "full", !! "node_modules/typescript/lib/typescript.d.ts", [];
 
          // "full" packages involving a lot of dependencies (which includes some "safe" packages)
-         "safe", !! "node_modules/@types/scheduler/tracing.d.ts";
-         "full", !! "node_modules/csstype/index.d.ts";
-         "safe", !! "node_modules/@types/prop-types/index.d.ts";
-         "full", !! "node_modules/@types/react/index.d.ts" ++ "node_modules/@types/react/global.d.ts";
-         "full", !! "node_modules/@types/react-modal/index.d.ts";
+         "safe", !! "node_modules/@types/scheduler/tracing.d.ts", [];
+         "full", !! "node_modules/csstype/index.d.ts", [];
+         "safe", !! "node_modules/@types/prop-types/index.d.ts", [];
+         "full", !! "node_modules/@types/react/index.d.ts" ++ "node_modules/@types/react/global.d.ts", [];
+         "full", !! "node_modules/@types/react-modal/index.d.ts", [];
 
          // "safe" package which depends on another "safe" package
-         "safe", !! "node_modules/@types/yargs-parser/index.d.ts";
-         "safe", !! "node_modules/@types/yargs/index.d.ts";
+         "safe", !! "node_modules/@types/yargs-parser/index.d.ts", [];
+         "safe", !! "node_modules/@types/yargs/index.d.ts", [];
       ]
 
-      for preset, package in packages do
-        ts2ocaml ["jsoo"; "--verbose"; "--nowarn"; $"--preset {preset}"; $"-o {outputDir}"] package
+      for preset, package, additionalOptions in packages do
+        ts2ocaml
+          (["jsoo"; "--verbose"; "--nowarn"; "--follow-relative-references";
+            $"--preset {preset}"; $"-o {outputDir}"] @ additionalOptions)
+          package
 
     let build () =
       for file in outputDir |> Shell.copyRecursiveTo true srcDir do

docs/common_options.md

@@ -15,6 +15,28 @@ You should use `camelCase` key names. For example, if you want to set `--output-
 }
 ```
 
+## Parser Options
+
+### `--follow-relative-references`
+
+Follow and parse relative imports and file references.
+
+If this option is enabled, ts2ocaml tries to find relative `import` statements or `/// <referench path="...">` directives, and add the referenced files to the input files. ts2ocaml repeats this until no new file is added.
+
+> ts2ocaml will not follow package `import` statements and `/// <reference types="...">` directives.
+
+## Output Options
+
+### `--merge`
+
+Merge multiple input definition files to one binding.
+
+By default, ts2ocaml generates multiple bindings if multiple inputs are given.
+
+If this option is enabled, ts2ocaml bundles all the input files and generates one single binding.
+
+> This option may break relative imports. Use it with care.
+
 ## Logging Options
 
 ### `--verbose`

package.json

@@ -36,6 +36,7 @@
     "@types/semver": "^7.3.6",
     "@types/yargs": "^17.0.0",
     "monaco-editor": "^0.24.0",
+    "react-player": "^2.9.0",
     "webpack": "^5.53.0",
     "webpack-cli": "^4.8.0",
     "webpack-dev-server": "^4.2.1"

src/Common.fs

@@ -4,22 +4,24 @@ module Common
 type GlobalOptions =
   abstract verbose: bool with get
   abstract nowarn: bool with get
+  abstract merge: bool with get, set
+  abstract followRelativeReferences: bool with get, set
 
 module GlobalOptions =
   open Fable.Core.JsInterop
 
   let register (yargs: Yargs.Argv<_>) =
     yargs
+      .group(!^ResizeArray["config"], "General Options:")
+      .describe(!^"config", "Specify the path to a ts2ocaml configuration JSON file.")
+      .group(!^ResizeArray["follow-relative-references"], "Parser Options:")
+      .addFlag("follow-relative-references", (fun (o: GlobalOptions) -> o.followRelativeReferences), descr="Follow and parse relative imports and file references.")
+      .group(!^ResizeArray["merge"], "Output Options:")
+      .addFlag("merge", (fun (o: GlobalOptions) -> o.merge), descr="Merge multiple input definition files to one binding", defaultValue=false)
       .group(!^ResizeArray["verbose"; "nowarn"], "Logging Options:")
       .addFlag("verbose", (fun (o: GlobalOptions) -> o.verbose), descr="Show verbose log")
       .addFlag("nowarn", (fun (o: GlobalOptions) -> o.nowarn), descr="Do not show warnings")
-      .group(
-        !^ResizeArray[
-          "config"
-        ],
-        "General Options:"
-      )
-      .describe(!^"config", "Specify the path to a ts2ocaml configuration JSON file.")
+
 
 module Log =
   let tracef (opt: 'Options) fmt : _ when 'Options :> GlobalOptions =

src/Extensions.fs

@@ -141,6 +141,15 @@ module Path =
       else Node.path.dirname(fromPath)
     Node.path.relative(fromPath, toPath)
 
+  let dirname (path: string) : string =
+    Node.path.dirname(path)
+
+  let join (paths: string list) : string =
+    Node.path.join(Array.ofList paths)
+
+  let separator =
+    Node.path.sep
+
 open Yargs
 
 type Argv<'T> with

src/JsHelper.fs

@@ -7,7 +7,7 @@ module Node = Node.Api
 let getPackageJsonPath (exampleFilePath: string) =
   let parts =
     exampleFilePath
-    |> String.split Node.path.sep
+    |> String.split Path.separator
     |> List.ofArray
   match parts |> List.tryFindIndexBack ((=) "node_modules") with
   | None -> None
@@ -21,11 +21,10 @@ let getPackageJsonPath (exampleFilePath: string) =
         | packageName :: _ -> [packageName]
         | _ -> failwith "impossible_getPackageJsonPath_root"
       let path =
-        prefix @ packageName @ ["package.json"] |> String.concat Node.path.sep
+        prefix @ packageName @ ["package.json"] |> String.concat Path.separator
 
       if not <| Node.fs.existsSync(!^path) then None
-      else if Node.path.isAbsolute(path) then Some path
-      else Some (Node.path.resolve(path))
+      else Some (Path.absolute path)
 
 type IPackageExportItem =
   [<EmitIndexer>]
@@ -48,7 +47,7 @@ let getPackageInfo (exampleFilePath: string) : Syntax.PackageInfo option =
   | Some path ->
     let p = getPackageJson path
 
-    let rootPath = Node.path.dirname(path)
+    let rootPath = Path.dirname path
 
     let name =
       if p.name.StartsWith("@types/") then
@@ -73,20 +72,20 @@ let getPackageInfo (exampleFilePath: string) : Syntax.PackageInfo option =
     let indexFile =
       match Option.orElse p.types p.typings, exports |> List.tryFind (fst >> (=) ".") with
       | None, None ->
-        let index = Node.path.join(rootPath, "index.d.ts")
+        let index = Path.join [rootPath; "index.d.ts"]
         if not <| Node.fs.existsSync(!^index) then None
         else
-          Node.path.relative(Node.``process``.cwd(), index) |> Node.path.normalize |> Some
+          Path.relative index |> Node.path.normalize |> Some
       | Some typings, _
       | None, Some (_, typings) ->
-        Node.path.relative(Node.``process``.cwd(), Node.path.join(rootPath, typings)) |> Node.path.normalize |> Some
+        Path.join [rootPath; typings] |> Path.relative |> Node.path.normalize |> Some
 
     let exports =
       exports
       |> List.filter (fst >> (<>) ".")
       |> List.map (fun (k, v) ->
         {| submodule = k;
-           file = Node.path.relative(Node.``process``.cwd(), Node.path.join(rootPath, v)) |> Node.path.normalize |})
+           file = Path.join [rootPath; v] |> Path.relative |> Node.path.normalize |})
 
     Some {
       name = name
@@ -106,6 +105,9 @@ module InferenceResult =
   let unwrap defaultValue = function
     | Valid s | Heuristic s -> s
     | Unknown -> defaultValue
+  let tryUnwrap = function
+    | Valid s | Heuristic s -> Some s
+    | Unknown -> None
 
 let inferPackageInfoFromFileName (sourceFile: Path.Relative) : {| name: string; isDefinitelyTyped: bool; rest: string list |} option =
   let parts =
@@ -143,17 +145,17 @@ let getJsModuleName (info: Syntax.PackageInfo option) (sourceFile: Path.Relative
       // make it relative to the package root directory
       let relativePath = Path.diff info.rootPath (Path.absolute sourceFile)
       if info.isDefinitelyTyped then
-        Node.path.join(info.name, stripExtension relativePath) |> Valid
+        Path.join [info.name; stripExtension relativePath] |> Valid
       else
         match info.exports |> List.tryFind (fun x -> x.file = sourceFile) with
-        | Some export -> Node.path.join(info.name, export.submodule) |> Valid
+        | Some export -> Path.join [info.name; export.submodule] |> Valid
         | None -> // heuristic
           let submodule =
             relativePath
             |> String.splitThenRemoveEmptyEntries "/"
             |> List.ofArray
             |> getSubmodule
-          Node.path.join(info.name, submodule) |> Heuristic
+          Path.join [info.name; submodule] |> Heuristic
   | None ->
     match inferPackageInfoFromFileName sourceFile with
     | None -> Unknown
@@ -178,13 +180,21 @@ let deriveModuleName (info: Syntax.PackageInfo option) (srcs: Path.Relative list
   | [] -> failwith "impossible_deriveModuleName"
   | [src] -> getJsModuleName info src
   | srcs ->
-    let names =
-      srcs
-      |> List.choose inferPackageInfoFromFileName
-      |> List.map (fun info -> info.name)
-      |> List.groupBy id
-      |> List.map (fun (name, xs) -> name, List.length xs)
-    names |> List.maxBy (fun (_, count) -> count) |> fst |> Heuristic
+    let fallback () =
+      let names =
+        srcs
+        |> List.choose inferPackageInfoFromFileName
+        |> List.map (fun info -> info.name)
+        |> List.groupBy id
+        |> List.map (fun (name, xs) -> name, List.length xs)
+      names |> List.maxBy (fun (_, count) -> count) |> fst |> Heuristic
+    match info with
+    | None -> fallback ()
+    | Some info ->
+      if info.indexFile |> Option.exists (fun index -> srcs |> List.exists ((=) index)) then
+        Valid info.name
+      else
+        fallback ()
 
 let deriveOutputFileName
   (opts: #GlobalOptions) (info: Syntax.PackageInfo option) (srcs: Path.Relative list)
@@ -202,8 +212,8 @@ let deriveOutputFileName
 let resolveRelativeImportPath (info: Syntax.PackageInfo option) (currentFile: Path.Relative) (path: string) =
   if path.StartsWith(".") then
     let targetPath =
-      let path = Node.path.join(Node.path.dirname(currentFile), path)
-      if not <| path.EndsWith(".ts") then Node.path.join(path, "index.d.ts")
+      let path = Path.join [Path.dirname currentFile; path]
+      if not <| path.EndsWith(".ts") then Path.join [path; "index.d.ts"]
       else path
     getJsModuleName info targetPath
   else