Add driver subproject

driver/js/src/main/scala/driver/Driver.scala

@@ -240,6 +240,7 @@ class Driver(options: DriverOptions) {
     }
 
     val mlsiFile = normalize(s"${file.workDir}/${file.interfaceFilename}")
+    val jsFile = s"${options.outputDir}/${file.jsFilename}"
     val mlsiWriter = JSWriter(mlsiFile)
     implicit val raise: Raise = (diag: Diagnostic) => report(diag, mlsiWriter.writeErr)
     parseAndRun(file.filename, {
@@ -279,7 +280,8 @@ class Driver(options: DriverOptions) {
           compile(newFilename, true)(newCtx, newExtrCtx, newVars, stack :+ file.filename) || r
         })
 
-        if (!dependentRecompile && !gitHelper.filter(file.filename)) return false
+        if (!dependentRecompile && !gitHelper.filter(file.filename) && JSFileSystem.exists(mlsiFile) && JSFileSystem.exists(jsFile))
+          return false
 
         System.out.println(s"compiling ${file.filename}...")
         val importedSym = (try { otherList.map(d => importModule(file.`import`(d))) }
@@ -301,7 +303,7 @@ class Driver(options: DriverOptions) {
           mlsiWriter.write(interfaces)
           mlsiWriter.close()
           if (Driver.totalErrors == 0)
-            generate(Pgrm(definitions), s"${options.outputDir}/${file.jsFilename}", file.moduleName, imports.map(
+            generate(Pgrm(definitions), jsFile, file.moduleName, imports.map(
               imp => new Import(resolveJSPath(file, imp.path)) with ModuleType {
                 val isESModule = checkESModule(path, TSPathResolver.resolve(file.filename))
               }

driver/js/src/main/scala/driver/DriverHelper.scala

@@ -23,18 +23,22 @@ object DriverHelper {
   ): Unit = {
     System.out.println(s"start watching $workDir")
     val options = DriverOptions(filename, workDir, s"${g.__dirname}/predefs/", outputDir, tsconfig, ".interfaces", commonJS, expectTypeError, false, false)
-    watcher.watch(workDir, js.Dictionary("ignoreInitial" -> true)).on("all", (event: js.Dynamic, file: js.Dynamic) => {
-      val driver = Driver(options)
-      driver.genPackageJson()
-      val res = driver.execute
+    watcher.watch(workDir,
+      js.Dictionary("ignoreInitial" -> true, "ignored" -> "(.*\\.mlsi) | (.*\\.js)")
+    ).on("all", (event: js.Dynamic, file: js.Dynamic) => {
+      if (event.toString() === "change" || event.toString() === "add") {
+        val driver = Driver(options)
+        driver.genPackageJson()
+        val res = driver.execute
 
-      import DriverResult._
-      res match {
-        case Error => System.err.println(s"Compiling error(s) found in $filename.")
-        case TypeError => System.err.println(s"Type error(s) found in $filename")
-        case ExpectError => System.err.println(s"Expect compiling error(s) in $filename")
-        case ExpectTypeError => System.err.println(s"Expect type error(s) in $filename")
-        case OK => ()
+        import DriverResult._
+        res match {
+          case Error => System.err.println(s"Compiling error(s) found in $filename.")
+          case TypeError => System.err.println(s"Type error(s) found in $filename")
+          case ExpectError => System.err.println(s"Expect compiling error(s) in $filename")
+          case ExpectTypeError => System.err.println(s"Expect type error(s) in $filename")
+          case OK => ()
+        }
       }
     })
   }

driver/npm/README.md

@@ -1 +1,43 @@
 # MLscript Driver
+
+**This is a pre-release of MLscript driver.**
+
+## Quick Start
+To install MLscript driver, you can use `npm`:
+```shell
+npm i mlscript-driver
+```
+
+The newest version is recommended: there may be lots of bugs in the previous versions.
+
+To watch the project directory, you can use TypeScript(recommended)/JavaScript:
+```ts
+import driver from "mlscript-driver"
+
+// filename: string, workDir: string, outputDir: string, tsconfig: string, commonJS: boolean, expectTypeError: boolean
+driver.watch("./mlscript/Main.mls", "./", "./js/", "./tsconfig.json", false, true)
+```
+
+The path must start with `./`, or it will be treated as `node_modules` paths.
+
+If you need to interoperate with TypeScript, you must provide the path of `tsconfig.json` file.
+Otherwise, it is optional.
+
+You can choose to use CommonJS or ES modules(recommended).
+
+Since Mlscript is still under development, type inferences are not fully supported.
+If there is a type error but it is correct, please set the `expectTypeError` flag to `true`.
+To get the type error messages, please check the corresponding `.mlsi` files in `.interfaces`.
+
+For more details, you can check the demo [here](https://github.com/NeilKleistGao/mlscript-driver-demo).
+
+## Project Structure
+The MLscript driver uses `git` to track the file changes.
+Please make sure your project locates in a git repo.
+
+Though not necessary, we still recommend you organize the project in this structure:
+- `.interfaces`: temporary interface files generated by MLscript driver.
+- `mlscript`: directory for MLscript files.
+- `node_modules`: third-party libraries in TypeScript.
+- `ts`: directory for TypeScript files.
+- configuration files: `package.json` and `tsconfig.json` should locate in the root directory.

driver/npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mlscript-driver",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "mlscript driver",
   "types": "lib/index.d.ts",
   "main": "lib/index.js",