update readme, add changelogs.

3 files changed, 465 insertions, 340 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..5ec9a47
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,427 @@
+# Changelog
+
+The implementation for original Moonscript language 0.5.0 can be found in the `0.5.0` branch of MoonPlus. The Moonscript with fixes and new features is in the master branch of MoonPlus. Here are the changelogs for each MoonPlus version.
+
+
+
+## v0.3.7
+
+### Fixed Issues
+
+* Fix macro type mismatch issue.
+* Fix line break issue in macro, disable macro declaration outside the root scope.
+* Fix existential operator issue when used in operator-value list.
+
+
+
+### Added Features
+
+* Add support for macro system expanding to Lua codes directly.
+* Add goto statement support.
+* `moonp` now supports recursively traversing any directory and compiling any moon file in the path.
+* `moonp` now supports REPL functions for Moonscript.
+
+
+
+### Changed Hehaviors
+
+* Remove else clause support from if-else line decorator syntax which makes users confused.
+
+
+
+## v0.3.0
+
+### Added Features
+
+* Add macro functions.
+```Moonscript
+-- file 'macro.moon'
+export macro block config = (debugging = true)->
+  global debugMode = debugging == "true"
+  ""
+
+export macro block asserts = (cond)->
+  debugMode and "assert #{cond}" or ""
+
+export macro expr assert = (cond)->
+  debugMode and "assert #{cond}" or "#{cond}"
+
+$config!
+
+-- file 'main.moon'
+import 'macro' as {:$config, :$assert, :$asserts}
+
+macro expr and = (...)-> "#{ table.concat {...}, ' and ' }"
+
+$asserts item ~= nil
+$config false
+value = $assert item
+
+if $and f1!, f2!, f3!
+  print "OK"
+```
+ Compiles to:
+```Lua
+-- file 'macro.moon'
+local _module_0 = { }
+return _module_0
+
+-- file 'main.moon'
+assert(item ~= nil)
+local value = item
+if (f1() and f2() and f3()) then
+  print("OK")
+end
+```
+
+
+
+## v0.2.0
+
+### Fixed Issues
+
+* Fix some cases when using backcall with assignment.
+* Fix a case that complier crashes with empty code body.
+* Force forward declaration of variable for assigning local function.
+
+From original Moonscript compiler:
+
+* [#390](https://github.com/leafo/moonscript/issues/390) Many lists are not allowed to be multiline
+
+  
+
+### Added Features
+
+* Allow value lists in for and local statement to be multiline.
+* `moonp` now compiles source files in multiple threads to speed up compilation.
+* Add placeholder support for backcall operator.
+* Add placeholder support for backcall statement.
+* Add fat arrow support for backcall statement.
+* Add option to compile MoonPlus as a Lua C lib. Got MoonPlus released to `Luarocks`.
+* Move old `export` statement functions to `global` statement to match the `local` statement.
+* Change `export` statement behavier to support module management.  Moon codes with `export` statement can not explicit return values in root scope. And codes with `export default` can export only one value as the module content. Use cases:
+```Moonscript
+-- file 'Config.moon'
+export default {flag:1, value:"x"}
+
+-- file 'Utils.moon'
+export map = (items, func)-> [func item for item in *items]
+export filter = (items, func)-> [item for item in *items when func item]
+
+-- file 'main.moon'
+import 'Config' as {:flag, :value}
+import 'Utils' as {:map, :filter}
+```
+Compiles to:
+```Lua
+-- file 'Config.moon'
+local _module_0 = nil
+_module_0 = {
+  flag = 1,
+  value = "x"
+}
+return _module_0
+
+-- file 'Utils.moon'
+local _module_0 = { }
+local map
+map = function(items, func)
+  local _accum_0 = { }
+  local _len_0 = 1
+  for _index_0 = 1, #items do
+    local item = items[_index_0]
+    _accum_0[_len_0] = func(item)
+    _len_0 = _len_0 + 1
+  end
+  return _accum_0
+end
+_module_0["map"] = map
+local filter
+filter = function(items, func)
+  local _accum_0 = { }
+  local _len_0 = 1
+  for _index_0 = 1, #items do
+    local item = items[_index_0]
+    if func(item) then
+      _accum_0[_len_0] = item
+      _len_0 = _len_0 + 1
+    end
+  end
+  return _accum_0
+end
+_module_0["filter"] = filter
+return _module_0
+
+-- file 'main.moon'
+local flag, value
+do
+  local _obj_0 = require('Config')
+  flag, value = _obj_0.flag, _obj_0.value
+end
+local map, filter
+do
+  local _obj_0 = require('Utils')
+  map, filter = _obj_0.map, _obj_0.filter
+end
+```
+
+
+
+## v0.1.0
+
+### Fixed Issues
+
+Fix issues in original Moonscript compiler:
+* [#122](https://github.com/leafo/moonscript/issues/122) use of ? symbol
+* [#155](https://github.com/leafo/moonscript/issues/151) wish moon could support: function?()
+* [#156](https://github.com/leafo/moonscript/issues/156) About the 'import' statement
+* [#375](https://github.com/leafo/moonscript/issues/375) assignment in line decorators
+* [#384](https://github.com/leafo/moonscript/issues/384) The @ and @@ accessors do not escape Lua keywords
+
+
+
+### Added Features
+
+* Multi-line comment support.
+
+* Usage for symbol `\` to escape new line. Will compile codes:
+```Moonscript
+str = --[[
+   This is a multi line comment.
+   It's OK.
+]] strA \ -- comment 1
+   .. strB \ -- comment 2
+   .. strC
+
+func --[[ip]] "192.168.126.110", --[[port]] 3000
+```
+  to:
+```Lua
+local str = strA .. strB .. strC
+func("192.168.126.110", 3000)
+```
+
+* Back call features with new operator and syntax. For example:
+```Moonscript
+{1,2,3} \
+  |> map((x)-> x * 2) \
+  |> filter((x)-> x > 4) \
+  |> reduce(0, (a,b)-> a + b) \
+  |> print
+
+do
+  (data) <- http.get "ajaxtest"
+  body[".result"]\html data
+  (processed) <- http.post "ajaxprocess", data
+  body[".result"]\append processed
+  print "done"
+```
+&emsp;&emsp;will be compiled to:
+```Lua
+print(reduce(filter(map({
+  1,
+  2,
+  3
+}, function(x)
+  return x * 2
+end), function(x)
+  return x > 4
+end), 0, function(a, b)
+  return a + b
+end))
+do
+  http.get("ajaxtest", function(data)
+    body[".result"]:html(data)
+    return http.post("ajaxprocess", data, function(processed)
+      body[".result"]:append(processed)
+      return print("done")
+    end)
+  end)
+end
+```
+
+* Existential operator support. Generate codes from:
+```Moonscript
+func?!
+
+x = tab?.value
+
+print abc?["hello world"]?.xyz
+
+if print and x?
+  print x
+```
+&emsp;&emsp;to:
+```Lua
+if func ~= nil then
+  func()
+end
+local x
+if tab ~= nil then
+  x = tab.value
+end
+print((function()
+  if abc ~= nil then
+    local _obj_0 = abc["hello world"]
+    if _obj_0 ~= nil then
+      return _obj_0.xyz
+    end
+    return nil
+  end
+  return nil
+end)())
+if print and (x ~= nil) then
+  print(x)
+end
+```
+
+* More usages for `import` keyword. Will compile codes from:
+```Moonscript
+import 'module'
+import "module.part"
+import "d-a-s-h-e-s"
+import "player" as Player
+import "lpeg" as {:C, :Ct, :Cmt}
+```
+&emsp;&emsp;to:
+```Lua
+local module = require('module')
+local part = require("module.part")
+local d_a_s_h_e_s = require("d-a-s-h-e-s")
+local Player = require("player")
+local C, Ct, Cmt
+do
+  local _obj_0 = require("lpeg")
+  C, Ct, Cmt = _obj_0.C, _obj_0.Ct, _obj_0.Cmt
+end
+```
+
+* Can do slash call with Lua keywords. Generate codes from:
+```Moonscript
+c.repeat.if\then("xyz")\else res
+```
+&emsp;&emsp;to:
+```Lua
+local _call_3 = c["repeat"]["if"]
+local _call_4 = _call_3["then"](_call_3, "xyz")
+_call_4["else"](_call_4, res)
+```
+
+
+
+### Changed Hehaviors
+
+* Left part of update statement will now accept only one assignable expression.
+* Expression list appears in the middle of code block is not allowed. For codes like:
+
+```Moonscript
+-- Moonscript 0.5.0
+f = (x)->
+  "abc",123 -- valid meaningless codes
+  x + 1
+```
+
+in original Moonscript compiles to:
+
+```Lua
+local f
+f = function(x)
+ local _ = "abc", 123 -- report error in MoonPlus
+ return x + 1
+end
+```
+
+This feature may lead to some silenced errors. For example:
+
+```Moonscript
+-- expected codes
+tree\addChild with Node!
+  \addChild subNode
+  
+-- in original Moonscript, codes will still run
+-- after adding a break by mistake
+tree\addChild
+with Node!
+   \addChild subNode
+```
+
+the original Moonscript will compile these codes to:
+
+```Lua
+-- expected codes
+tree:addChild((function()
+  do
+    local _with_0 = Node()
+    _with_0:addChild(subNode)
+    return _with_0
+  end
+end)())
+
+-- codes added with a break will still run
+local _ -- report error in MoonPlus instead of creating
+do      -- an anonymous function to bind the object method
+  local _base_0 = tree
+  local _fn_0 = _base_0.addChild
+  _ = function(...)
+    return _fn_0(_base_0, ...)
+  end
+end
+do
+  local _with_0 = Node()
+  _with_0:addChild(subNode)
+end
+```
+
+* Reusing variables which helps generate reduced Lua codes. 
+
+  For example, MoonPlus will generate codes from:
+
+```Moonscript
+with leaf
+  .world 1,2,3
+
+with leaf
+  g = .what.is.this
+  print g
+
+for x in *something
+  print x
+```
+
+&emsp;&emsp;to:
+
+```Lua
+leaf.world(1, 2, 3)
+do
+  local g = leaf.what.is.this
+  print(g)
+end
+for _index_0 = 1, #something do
+  local x = something[_index_0]
+  print(x)
+end
+```
+
+&emsp;&emsp;instead of:
+
+```lua
+do
+  local _with_0 = leaf
+  _with_0.world(1, 2, 3)
+end
+do
+  local _with_0 = leaf
+  local g = _with_0.what.is.this
+end
+local _list_0 = something
+for _index_0 = 1, #_list_0 do
+  local x = _list_0[_index_0]
+  print(x)
+end
+```
+
+
+
+## v0.0.1
+
+Implemented full features from Moonscript 0.5.0.
diff --git a/README.md b/README.md
index c8159c4..14a3718 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
 # MoonPlus
 
 ![CI](https://github.com/pigpigyyy/MoonPlus/workflows/build-test/badge.svg)  
-MoonPlus is a compiler with features from [Moonscript language](https://github.com/leafo/moonscript) 0.5.0 and implementing new features to make Moonscript more up to date. 
+MoonPlus is a compiler with features from [Moonscript language](https://github.com/leafo/moonscript) 0.5.0 and adopting new features to make Moonscript more up to date. 
+
+Since original Moonscript has been used to write web framework [lapis](https://github.com/leafo/lapis) and run a few business web sites like [itch.io](https://itch.io) and [streak.club](https://streak.club) with some large code bases. The original language is getting too hard to adopt new features for those may break the stablility for existing applications.
+
+So MoonPlus is a new code base for pushing the language to go forward and being a playground to try introducing new language syntax or programing paradigms to make Moonscript language more expressive and productive.
 
-Since original Moonscript has been used to write web framework [lapis](https://github.com/leafo/lapis) and run a few business web sites like [itch.io](https://itch.io) and [streak.club](https://streak.club) with some large code bases. The original language is getting too hard to adopt new language features for those may break the stablility for existing applications.
 
-So MoonPlus is a new code base for pushing the language to go forward and may be a playground to try introducing new language syntax or programing paradigms to make Moonscript language more expressive and productive.
 
 ## Features
 
@@ -13,374 +15,70 @@ So MoonPlus is a new code base for pushing the language to go forward and may be
 * Written in C++17.
 * Support full Moonscript language features, generate the same Lua codes with original compiler.
 * Reserve line numbers from Moonscript sources in compiled Lua codes to help with debugging.
+* See other details in the [changelog](./CHANGELOG.md).
+
+
 
-## Installation
+## Installation & Usage
+
+* **Lua Module**
+
+  Install [luarocks](https://luarocks.org), a package manager for Lua modules. Then install it as a Lua module.
 
-Install [luarocks](https://luarocks.org), a package manager for Lua modules. Then install Lua module with
 ```sh
 > luarocks install moonplus
 ```
 
-## Usage
+&emsp;&emsp;Require the module in Lua:
 
 ```Lua
 require("moonp")("main") -- require `main.moon`
 
 local moonp = require("moonp")
-print(moonp.to_lua[[
+local codes, err, globals = moonp.to_lua([[
 f = ->
   print "hello world"
 f!
 ]],{
   implicit_return_root = true,
-  reserve_line_number = false,
-  lint_global = false
+  reserve_line_number = true,
+  lint_global = true
 })
 ```
 
-## Changes
-
-The original Moonscript language 0.5.0 support can be found in the `0.5.0` branch. Moonscript with new features is in the master branch. Here are the new features introduced in MoonPlus.
-
-* Add goto statement support.
-
-* Add macro functions.
-```Moonscript
--- file 'macro.moon'
-export macro block config = (debugging = true)->
-  global debugMode = debugging == "true"
-  ""
-
-export macro block asserts = (cond)->
-  debugMode and "assert #{cond}" or ""
-
-export macro expr assert = (cond)->
-  debugMode and "assert #{cond}" or "#{cond}"
-
-$config!
-
--- file 'main.moon'
-import 'macro' as {:$config, :$assert, :$asserts}
-
-macro expr and = (...)-> "#{ table.concat {...}, ' and ' }"
-
-$asserts item ~= nil
-$config false
-value = $assert item
-
-if $and f1!, f2!, f3!
-  print "OK"
-```
- Compiles to:
-```Lua
--- file 'macro.moon'
-local _module_0 = { }
-return _module_0
-
--- file 'main.moon'
-assert(item ~= nil)
-local value = item
-if (f1() and f2() and f3()) then
-  print("OK")
-end
-```
-
-* Move old `export` statement functions to `global` statement to match the `local` statement.
-
-* Change `export` statement behavier to support module management.  Moon codes with `export` statement can not explicit return values in root scope. And codes with `export default` can export only one value as the module content. Use cases:
-```Moonscript
--- file 'Config.moon'
-export default {flag:1, value:"x"}
-
--- file 'Utils.moon'
-export map = (items, func)-> [func item for item in *items]
-export filter = (items, func)-> [item for item in *items when func item]
-
--- file 'main.moon'
-import 'Config' as {:flag, :value}
-import 'Utils' as {:map, :filter}
-```
-Compiles to:
-```Lua
--- file 'Config.moon'
-local _module_0 = nil
-_module_0 = {
-  flag = 1,
-  value = "x"
-}
-return _module_0
-
--- file 'Utils.moon'
-local _module_0 = { }
-local map
-map = function(items, func)
-  local _accum_0 = { }
-  local _len_0 = 1
-  for _index_0 = 1, #items do
-    local item = items[_index_0]
-    _accum_0[_len_0] = func(item)
-    _len_0 = _len_0 + 1
-  end
-  return _accum_0
-end
-_module_0["map"] = map
-local filter
-filter = function(items, func)
-  local _accum_0 = { }
-  local _len_0 = 1
-  for _index_0 = 1, #items do
-    local item = items[_index_0]
-    if func(item) then
-      _accum_0[_len_0] = item
-      _len_0 = _len_0 + 1
-    end
-  end
-  return _accum_0
-end
-_module_0["filter"] = filter
-return _module_0
-
--- file 'main.moon'
-local flag, value
-do
-  local _obj_0 = require('Config')
-  flag, value = _obj_0.flag, _obj_0.value
-end
-local map, filter
-do
-  local _obj_0 = require('Utils')
-  map, filter = _obj_0.map, _obj_0.filter
-end
-```
-
-* Add multi-line comment support.
-
-* Usage for symbol `\` to escape new line. Will compile codes:
-```Moonscript
-str = --[[
-   This is a multi line comment.
-   It's OK.
-]] strA \ -- comment 1
-   .. strB \ -- comment 2
-   .. strC
-
-func --[[ip]] "192.168.126.110", --[[port]] 3000
-```
-&emsp;&emsp;to:
-```Lua
-local str = strA .. strB .. strC
-func("192.168.126.110", 3000)
-```
-
-* Back call features with new operator and syntax. For example:
-```Moonscript
-{1,2,3} \
-  |> map((x)-> x * 2) \
-  |> filter((x)-> x > 4) \
-  |> reduce(0, (a,b)-> a + b) \
-  |> print
-
-do
-  (data) <- http.get "ajaxtest"
-  body[".result"]\html data
-  (processed) <- http.post "ajaxprocess", data
-  body[".result"]\append processed
-  print "done"
-```
-&emsp;&emsp;will be compiled to:
-```Lua
-print(reduce(filter(map({
-  1,
-  2,
-  3
-}, function(x)
-  return x * 2
-end), function(x)
-  return x > 4
-end), 0, function(a, b)
-  return a + b
-end))
-do
-  http.get("ajaxtest", function(data)
-    body[".result"]:html(data)
-    return http.post("ajaxprocess", data, function(processed)
-      body[".result"]:append(processed)
-      return print("done")
-    end)
-  end)
-end
-```
-
-* Existential operator support. Generate codes from:
-```Moonscript
-func?!
 
-x = tab?.value
 
-print abc?["hello world"]?.xyz
 
-if print and x?
-  print x
-```
-&emsp;&emsp;to:
-```Lua
-if func ~= nil then
-  func()
-end
-local x
-if tab ~= nil then
-  x = tab.value
-end
-print((function()
-  if abc ~= nil then
-    local _obj_0 = abc["hello world"]
-    if _obj_0 ~= nil then
-      return _obj_0.xyz
-    end
-    return nil
-  end
-  return nil
-end)())
-if print and (x ~= nil) then
-  print(x)
-end
-```
+* **Binary Tool**
 
-* More usages for `import` keyword. Will compile codes from:
-```Moonscript
-import 'module'
-import "module.part"
-import "d-a-s-h-e-s"
-import "player" as Player
-import "lpeg" as {:C, :Ct, :Cmt}
-```
-&emsp;&emsp;to:
-```Lua
-local module = require('module')
-local part = require("module.part")
-local d_a_s_h_e_s = require("d-a-s-h-e-s")
-local Player = require("player")
-local C, Ct, Cmt
-do
-  local _obj_0 = require("lpeg")
-  C, Ct, Cmt = _obj_0.C, _obj_0.Ct, _obj_0.Cmt
-end
-```
+  Clone this repo, then build and install executable with:
 
-* Can do slash call with Lua keywords. Generate codes from:
-```Moonscript
-c.repeat.if\then("xyz")\else res
-```
-&emsp;&emsp;to:
-```Lua
-local _call_3 = c["repeat"]["if"]
-local _call_4 = _call_3["then"](_call_3, "xyz")
-_call_4["else"](_call_4, res)
+```sh
+> make install
 ```
 
-* Feature of `Reusing variable` which helps generate reduced Lua codes. For example, MoonPlus will generate codes from:
-```Moonscript
-with leaf
-  .world 1,2,3
-
-with leaf
-  g = .what.is.this
-  print g
-
-for x in *something
-  print x
-```
-&emsp;&emsp;to:
-```Lua
-leaf.world(1, 2, 3)
-do
-  local g = leaf.what.is.this
-  print(g)
-end
-for _index_0 = 1, #something do
-  local x = something[_index_0]
-  print(x)
-end
-```
-&emsp;&emsp;instead of:
-```lua
-do
-  local _with_0 = leaf
-  _with_0.world(1, 2, 3)
-end
-do
-  local _with_0 = leaf
-  local g = _with_0.what.is.this
-end
-local _list_0 = something
-for _index_0 = 1, #_list_0 do
-  local x = _list_0[_index_0]
-  print(x)
-end
-```
+&emsp;&emsp;Use MoonPlus tool with:
 
-* Expression list appears at the middle of code block is not allowed. For codes like:
-```Moonscript
--- Moonscript 0.5.0
-f = (x)->
-  "abc",123 -- valid meaningless codes
-  x + 1
-```
-in original Moonscript compiles to:
-```Lua
-local f
-f = function(x)
- local _ = "abc", 123 -- report error in MoonPlus
- return x + 1
-end
-```
+```sh
+> moonp -h
+Usage: moonp [options|files|directories] ...
 
-This feature may lead to some silenced errors. For example:
-```Moonscript
--- expected codes
-tree\addChild with Node!
-  \addChild subNode
-  
--- in original Moonscript, codes will still run after adding a break
-tree\addChild
-with Node!
-   \addChild subNode
-```
-the original Moonscript will compile these codes to:
-```Lua
--- expected codes
-tree:addChild((function()
-  do
-    local _with_0 = Node()
-    _with_0:addChild(subNode)
-    return _with_0
-  end
-end)())
+   -h       Print this message
+   -e str   Execute a file or raw codes
+   -t path  Specify where to place compiled files
+   -o file  Write output to file
+   -p       Write output to standard out
+   -b       Dump compile time (doesn't write output)
+   -l       Write line numbers from source codes
+   -v       Print version
+   --       Read from standard in, print to standard out
+            (Must be first and only argument)
 
--- codes added with a break will still run
-local _ -- report error in MoonPlus instead of creating
-do      -- an anonymous function to bind the object method
-  local _base_0 = tree
-  local _fn_0 = _base_0.addChild
-  _ = function(...)
-    return _fn_0(_base_0, ...)
-  end
-end
-do
-  local _with_0 = Node()
-  _with_0:addChild(subNode)
-end
+   Execute without options to enter REPL, type symbol '$'
+   in a single line to start/stop multi-line mode
 ```
 
-## Standalone Compiler Usage
 
-Test compiler with `make test`.
-Run `moonp` complier in project folder with:
-
-```shell
-make
-./moonp -h
-```
 
 ## License
 MIT
diff --git a/makefile b/makefile
index 41eb380..b8484a7 100644
--- a/makefile
+++ b/makefile
@@ -188,7 +188,7 @@ dirs:
 
 # Installs to the set path
 .PHONY: install
-install:
+install: release
         @echo "Installing to $(DESTDIR)$(INSTALL_PREFIX)/bin"
         @$(INSTALL_PROGRAM) $(BIN_PATH)/$(BIN_NAME) $(DESTDIR)$(INSTALL_PREFIX)/bin