sys.apis.minify.README.md

See: https://github.com/stravant/LuaMinify

Lua Parsing and Refactorization tools
=========

A collection of tools for working with Lua source code. Primarily a Lua source code minifier, but also includes some static analysis tools and a general Lua lexer and parser.

Currently the minifier performs:

- Stripping of all comments and whitespace
- True semantic renaming of all local variables to a reduced form
- Reduces the source to the minimal spacing, spaces are only inserted where actually needed.


LuaMinify Command Line Utility Usage
------------------------------------

The `LuaMinify` shell and batch files are given as shortcuts to running a command line instance of the minifier with the following usage:

    LuaMinify sourcefile [destfile]

Which will minify to a given destination file, or to a copy of the source file with _min appended to the filename if no output file is given.


LuaMinify Roblox Plugin Usage
-----------------------------

First, download the source code, which you can do by hitting this button:

![Click That](http://github.com/stravant/LuaMinify/raw/master/RobloxPluginInstructions.png)

Then copy the `RobloxPlugin` folder from the source into your Roblox Plugins directory, which can be found by hitting `Tools->Open Plugins Folder` in Roblox Studio.

Features/Todo
-------------
Features:

    - Lua scanner/parser, which generates a full AST
    - Lua reconstructor
        - minimal
        - full reconstruction (TODO: options, comments)
        - TODO: exact reconstructor
    - support for embedded long strings/comments e.g. [[abc [[ def ]] ghi]]

Todo:
    - use table.concat instead of appends in the reconstructors

The MIT License (MIT)

Copyright (c) 2012-2013

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.