add rockspec, rename script for install, add version

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Joe Rogers
+Copyright (c) 2020 - 2021 Joe Rogers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,12 +2,22 @@
 
 Utility to take code from multiple files and combine them into a paste-able Lua configuration for easy import into Dual Universe.
 
+## Installing
+
+If you'd rather install the latest release instead of cloning the repository this module can be installed through luarocks by simply running:
+
+```sh
+luarocks install du-bundler
+```
+
+This will put the bundle script on your path under the name `du-bundler`. All the following instructions apply, except that the script can be called without specifying the path to it and without the .lua extension.
+
 ## Usage
 
 To run this bundler, simply call the file directly, passing in the template file and (optionally) output file. If no output file is specified the filled in template will be printed to stdout, which may then be piped to `xclip -selection c` on linux or `clip.exe` on windows. For a concrete example, this is how the example template can be run:
 
 ```sh
-./bundleTemplate.lua example/template.json
+./du-bundler.lua example/template.json
 ```
 
 ## Template Format
@@ -18,7 +28,7 @@ The template is basically the json representation of a controller that can be ex
 
 Tags are delimited by `${}` and are formatted as `tagName [: arguments]`, where the tag name is case insensitive and tags that don't have arguments won't have the colon separator or anything listed after the tag name. For example, `${ARGS} : channel *` would resolve as an `ARGS` tag with arguments `channel` and `*`, as might be used to define an event handler in a receiver element.
 
-Example tag usage may be found in the examples directory, or in `TestBundleTemplate.lua`, primarily in the "testTag<tag name>" and "testGetTagReplacement<tag name>" methods.
+Example tag usage may be found in the examples directory, or in `TestBundleTemplate.lua`, primarily in the `testTag<tag name>` and `testGetTagReplacement<tag name>` methods.
 
 #### FILE
 

du-bundler-1.0-0.rockspec

@@ -0,0 +1,25 @@
+package = "du-bundler"
+version = "1.0-0"
+source = {
+   url = "git://github.com/1337joe/du-bundler",
+   tag = "v1.0.0",
+}
+description = {
+   summary = "Utility to combine multiple files into a paste-able Lua configuration for easy import into Dual Universe.",
+   detailed = "Utility to combine multiple files into a paste-able Lua configuration for easy import into Dual Universe.",
+   homepage = "https://github.com/1337joe/du-mocks",
+   license = "MIT",
+}
+dependencies = {
+   "lua >= 5.1",
+}
+build = {
+   type = "builtin",
+   modules = {},
+   copy_directories = {},
+   install = {
+      bin = {
+         ["du-bundler"] = "du-bundler.lua",
+      }
+   },
+}

du-bundler-scm-0.rockspec

@@ -0,0 +1,25 @@
+package = "du-bundler"
+version = "scm-0"
+source = {
+   url = "git://github.com/1337joe/du-bundler",
+   branch = "main",
+}
+description = {
+   summary = "Utility to combine multiple files into a paste-able Lua configuration for easy import into Dual Universe.",
+   detailed = "Utility to combine multiple files into a paste-able Lua configuration for easy import into Dual Universe.",
+   homepage = "https://github.com/1337joe/du-mocks",
+   license = "MIT",
+}
+dependencies = {
+   "lua >= 5.1",
+}
+build = {
+   type = "builtin",
+   modules = {},
+   copy_directories = {},
+   install = {
+      bin = {
+         ["du-bundler"] = "du-bundler.lua",
+      }
+   },
+}

bundleTemplate.lua → du-bundler.lua

@@ -7,6 +7,8 @@
 local BundleTemplate = {}
 _G.BundleTemplate = BundleTemplate
 
+local VERSION = "1.0.0"
+
 local TAG_KEY = "key"
 local TAG_SLOT_KEY = "slotkey"
 local TAG_SLOT_NAME = "slotname"
@@ -294,6 +296,9 @@ if not arg[1] or arg[1] == "--help" or arg[1] == "-h" then
     print("If outputFile is not provided will stream results to stdout.")
     -- TODO better help display, more detailed argument handling
     return
+elseif arg[1] == "--version" then
+    print(VERSION)
+    return;
 end
 
 local inputFile = arg[1]

tests/TestBundleTemplate.lua

@@ -7,7 +7,7 @@ local lu = require("luaunit")
 -- NOTE: This expects the tests/results directory to exist before being called.
 local originalArguments = _G.arg
 _G.arg = {"example/template.json", "tests/results/output.json"}
-dofile("bundleTemplate.lua")
+dofile("du-bundler.lua")
 _G.arg = originalArguments
 
 _G.TestBundleTemplate = {}