tl: add build options

.travis.yml

@@ -17,6 +17,7 @@ install:
   - luarocks install busted
   - luarocks install compat53
   - luarocks install argparse
+  - luarocks install luafilesystem
 
 script:
   - luarocks lint tl-dev*rockspec

docs/compiler_options.md

@@ -9,7 +9,7 @@ When running `tl`, the compiler will try to read the compilation options from a
 Here is an example of a `tlconfig.lua` file:
 ```lua
 return {
-    include = {
+    include_dir = {
         "folder1/",
         "folder2/"
     },
@@ -21,8 +21,87 @@ return {
 
 ## List of compiler options
 
-| Command line option | Config key | Type | Description |
-| --- | --- | --- | --- |
-| `-l --preload` | `preload_modules` | `{string}` | Execute the equivalent of `require('modulename')` before executing the tl script(s). |
-| `-I --include` | `include` | `{string}` | Prepend this directory to the module search path.
-| `--skip-compat53` | | | Skip compat53 insertions.
+| Command line option | Config key | Type | Relevant Commands | Description |
+| --- | --- | --- | --- | --- |
+| `-l --preload`  | `preload_modules` | `{string}` | `build` `check` `gen` `run` | Execute the equivalent of `require('modulename')` before executing the tl script(s). |
+| `-I --include-dir` |  `include_dir` | `{string}` | `build` `check` `gen` `run` | Prepend this directory to the module search path.
+| `--skip-compat53` | `skip_compat53` | `boolean` | `build` `gen` | Skip compat53 insertions.
+|| `include` | `{string}` | `build` | The set of files to compile/check. See below for details on patterns.
+|| `exclude` | `{string}` | `build` | The set of files to exclude. See below for details on patterns.
+| `-s --source-dir` | `source_dir` | `string` | `build` | Set the directory to be searched for files. `gen` will compile every .tl file in every subdirectory by default.
+| `-b --build-dir` | `build_dir` | `string` | `build` | Set the directory for generated files, mimicking the file structure of the source files.
+|| `files` | `{string}` | `build` | The names of files to be compiled. Does not accept patterns like `include`.
+| `-p --pretend --dry-run` ||| `build` `gen`  | Don't compile/write to any files, but type check and log what files would be written to.
+
+### Include/Exclude patterns
+
+The `include` and `exclude` fields can have glob-like patterns in them:
+- `*`: Matches any number of characters (excluding directory separators)
+- `**/`: Matches any number subdirectories
+
+In addition
+- setting the `source_dir` has the effect of prepending `source_dir` to all patterns.
+- currently, `include` will only include `.tl` files even if the extension isn't specified
+
+For example:
+If our project was laid out as such:
+```
+tlconfig.lua
+src/
+| foo/
+| | bar.tl
+| | baz.tl
+| bar/
+| | a/
+| | | foo.tl
+| | b/
+| | | foo.tl
+```
+
+and our tlconfig.lua contained the following:
+```lua
+return {
+   source_dir = "src",
+   build_dir = "build",
+   include = {
+      "foo/*.tl",
+      "bar/**/*.tl"
+   },
+   exclude = {
+      "foo/bar.tl"
+   }
+}
+```
+
+Running `tl build -p` will type check the `include`d files and show what would be written to.
+Running `tl build` will produce the following files.
+```
+tlconfig.lua
+src/
+| foo/
+| | bar.tl
+| | baz.tl
+| bar/
+| | a/
+| | | foo.tl
+| | b/
+| | | foo.tl
+build/
+| foo/
+| | baz.lua
+| bar/
+| | a/
+| | | foo.lua
+| | b/
+| | | foo.lua
+```
+
+Additionally, complex patterns can be used for whatever convoluted file structure we need.
+```lua
+return {
+   include = {
+      "foo/**/bar/**/baz/**/*.tl"
+   }
+}
+```
+This will compile any `.tl` file with a sequential `foo`, `bar`, and `baz` directory in its path.

spec/cli/build_dir_spec.lua

@@ -0,0 +1,73 @@
+local util = require("spec.util")
+
+describe("-b --build-dir argument", function()
+   it("generates files in the given directory", function()
+      util.run_mock_project(finally, {
+         dir_name = "build_dir_test",
+         dir_structure = {
+            ["tlconfig.lua"] = [[return {
+               build_dir = "build",
+               include = {
+                  "foo.tl", "bar.tl"
+               },
+            }]],
+            ["foo.tl"] = [[print "foo"]],
+            ["bar.tl"] = [[print "bar"]],
+         },
+         cmd = "build",
+         generated_files = {
+            ["build"] = {
+               "foo.lua",
+               "bar.lua",
+            }
+         },
+      })
+   end)
+   it("replicates the directory structure of the source", function()
+      util.run_mock_project(finally, {
+         dir_name = "build_dir_nested_test",
+         dir_structure = {
+            ["tlconfig.lua"] = [[return {
+               build_dir = "build",
+               include = {"**/*.tl"}
+            }]],
+            ["foo.tl"] = [[print "foo"]],
+            ["bar.tl"] = [[print "bar"]],
+            ["baz"] = {
+               ["foo.tl"] = [[print "foo"]],
+               ["bar"] = {
+                  ["foo.tl"] = [[print "foo"]],
+               }
+            }
+         },
+         cmd = "build",
+         generated_files = {
+            ["build"] = {
+               "foo.lua",
+               "bar.lua",
+               ["baz"] = {
+                  "foo.lua",
+                  ["bar"] = {
+                     "foo.lua",
+                  }
+               }
+            }
+         },
+      })
+   end)
+   it("dies when no config is found", function()
+      util.run_mock_project(finally, {
+         dir_name = "build_dir_die_test",
+         dir_structure = {},
+         cmd = "build",
+         generated_files = {},
+         popen = {
+            status = nil,
+            exit = "exit",
+            code = 1,
+         },
+         cmd_output = "Build error: tlconfig.lua not found\n"
+      })
+   end)
+
+end)

spec/cli/gen_spec.lua

@@ -1,3 +1,4 @@
+local lfs = require("lfs")
 local util = require("spec.util")
 
 local input_file = [[
@@ -66,10 +67,17 @@ end
 local c = 100
 ]]
 
+local function tl_to_lua(name)
+   return (name:gsub("%.tl$", ".lua"))
+end
+
 describe("tl gen", function()
+   setup(util.chdir_setup)
+   teardown(util.chdir_teardown)
    describe("on .tl files", function()
       it("reports 0 errors and code 0 on success", function()
-         local name = util.write_tmp_file(finally, "add.tl", [[
+         local name = "add.tl"
+         util.write_tmp_file(finally, name, [[
             local function add(a: number, b: number): number
                return a + b
             end
@@ -79,7 +87,7 @@ describe("tl gen", function()
          local pd = io.popen("./tl gen " .. name, "r")
          local output = pd:read("*a")
          util.assert_popen_close(true, "exit", 0, pd:close())
-         local lua_name = name:gsub("%.tl$", ".lua")
+         local lua_name = tl_to_lua(name)
          assert.match("Wrote: " .. lua_name, output, 1, true)
          util.assert_line_by_line([[
             local function add(a, b)
@@ -91,7 +99,8 @@ describe("tl gen", function()
       end)
 
       it("ignores type errors", function()
-         local name = util.write_tmp_file(finally, "add.tl", [[
+         local name = "add.tl"
+         util.write_tmp_file(finally, name, [[
             local function add(a: number, b: number): number
                return a + b
             end
@@ -103,7 +112,7 @@ describe("tl gen", function()
          local output = pd:read("*a")
          util.assert_popen_close(true, "exit", 0, pd:close())
          assert.same("", output)
-         local lua_name = name:gsub("%.tl$", ".lua")
+         local lua_name = tl_to_lua(name)
          util.assert_line_by_line([[
             local function add(a, b)
                return a + b
@@ -115,7 +124,8 @@ describe("tl gen", function()
       end)
 
       it("reports number of errors in stderr and code 1 on syntax errors", function()
-         local name = util.write_tmp_file(finally, "add.tl", [[
+         local name = "add.tl"
+         util.write_tmp_file(finally, name, [[
             print(add("string", 20))))))
          ]])
          local pd = io.popen("./tl gen " .. name .. " 2>&1 1>/dev/null", "r")
@@ -125,7 +135,8 @@ describe("tl gen", function()
       end)
 
       it("ignores unknowns code 0 if no errors", function()
-         local name = util.write_tmp_file(finally, "add.tl", [[
+         local name = "add.tl"
+         util.write_tmp_file(finally, name, [[
             local function unk(x, y): number, number
                return a + b
             end
@@ -134,7 +145,7 @@ describe("tl gen", function()
          local output = pd:read("*a")
          util.assert_popen_close(true, "exit", 0, pd:close())
          assert.same("", output)
-         local lua_name = name:gsub("%.tl$", ".lua")
+         local lua_name = tl_to_lua(name)
          util.assert_line_by_line([[
             local function unk(x, y)
                return a + b
@@ -143,26 +154,28 @@ describe("tl gen", function()
       end)
 
       it("does not mess up the indentation (#109)", function()
-         local name = util.write_tmp_file(finally, "add.tl", input_file)
+         local name = "add.tl"
+         util.write_tmp_file(finally, name, input_file)
          local pd = io.popen("./tl gen " .. name, "r")
          local output = pd:read("*a")
          util.assert_popen_close(true, "exit", 0, pd:close())
-         local lua_name = name:gsub("%.tl$", ".lua")
+         local lua_name = tl_to_lua(name)
          assert.match("Wrote: " .. lua_name, output, 1, true)
          assert.equal(output_file, util.read_file(lua_name))
       end)
    end)
 
    describe("with --skip-compat53", function()
       it("does not add compat53 insertions", function()
-         local name = util.write_tmp_file(finally, "test.tl", [[
+         local name = "test.tl"
+         util.write_tmp_file(finally, name, [[
             local t = {1, 2, 3, 4}
             print(table.unpack(t))
          ]])
          local pd = io.popen("./tl --skip-compat53 gen " .. name, "r")
          local output = pd:read("*a")
          util.assert_popen_close(true, "exit", 0, pd:close())
-         local lua_name = name:gsub("%.tl$", ".lua")
+         local lua_name = tl_to_lua(name)
          assert.match("Wrote: " .. lua_name, output, 1, true)
          util.assert_line_by_line([[
             local t = { 1, 2, 3, 4 }
@@ -173,14 +186,15 @@ describe("tl gen", function()
 
    describe("without --skip-compat53", function()
       it("adds compat53 insertions by default", function()
-         local name = util.write_tmp_file(finally, "test.tl", [[
+         local name = "test.tl"
+         util.write_tmp_file(finally, name, [[
             local t = {1, 2, 3, 4}
             print(table.unpack(t))
          ]])
          local pd = io.popen("./tl gen " .. name, "r")
          local output = pd:read("*a")
          util.assert_popen_close(true, "exit", 0, pd:close())
-         local lua_name = name:gsub("%.tl$", ".lua")
+         local lua_name = tl_to_lua(name)
          assert.match("Wrote: " .. lua_name, output, 1, true)
          util.assert_line_by_line([[
             local _tl_compat53 = ((tonumber((_VERSION or ''):match('[%d.]*$')) or 0) < 5.3) and require('compat53.module'); local table = _tl_compat53 and _tl_compat53.table or table; local _tl_table_unpack = unpack or table.unpack; local t = { 1, 2, 3, 4 }

spec/cli/include_spec.lua → spec/cli/include_dir_spec.lua

@@ -1,6 +1,6 @@
 local util = require("spec.util")
 
-describe("-I --include argument", function()
+describe("-I --include-dir argument", function()
    it("adds a directory to package.path", function()
       local name = util.write_tmp_file(finally, "foo.tl", [[
          require("add")