Skip to content

Commit

Permalink
0.11.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mpeterv committed Jul 18, 2015
1 parent 6c1a296 commit aee4f45
Show file tree
Hide file tree
Showing 20 changed files with 93 additions and 39 deletions.
16 changes: 9 additions & 7 deletions README.md
Expand Up @@ -35,7 +35,7 @@ If it is not possible to install [LuaFileSystem](http://keplerproject.github.io/

For manual installation, only a Lua interpreter binary is required.

1. Download and unpack latest Luacheck release ([.zip](https://github.com/mpeterv/luacheck/archive/0.10.0.zip) [.tar.gz](https://github.com/mpeterv/luacheck/archive/0.10.0.tar.gz)).
1. Download and unpack latest Luacheck release ([.zip](https://github.com/mpeterv/luacheck/archive/0.11.0.zip) [.tar.gz](https://github.com/mpeterv/luacheck/archive/0.11.0.tar.gz)).
2. Run `install.lua <path>` script using the Lua interpreter. If Lua interpreter is not in `PATH`, invoke it using absolute path.
3. Add `<path>/bin` to PATH or run Luacheck as `<path>/bin/luacheck`.

Expand All @@ -46,25 +46,25 @@ After Luacheck is installed, run `luacheck` program from the command line. Pass
```
$ luacheck src extra_file.lua another_file.lua
Checking src/good_code.lua OK
Checking src/bad_code.lua Failure
Checking src/bad_code.lua 3 warnings
src/bad_code.lua:3:23: unused variable length argument
src/bad_code.lua:7:10: setting non-standard global variable embrace
src/bad_code.lua:8:10: variable opt was previously defined as an argument on line 7
Checking src/python_code.lua Syntax error
Checking src/python_code.lua 1 error
src/python_code.lua:1:6: expected '=' near '__future__'
Checking extra_file.lua Failure
Checking extra_file.lua 5 warnings
extra_file.lua:3:18: unused argument baz
extra_file.lua:4:8: unused loop variable i
extra_file.lua:13:7: accessing uninitialized variable a
extra_file.lua:14:1: value assigned to variable x is unused
extra_file.lua:21:7: variable z is never accessed
Checking another_file.lua Failure
Checking another_file.lua 2 warnings
another_file.lua:2:7: unused variable height
another_file.lua:3:7: accessing undefined variable heigth
Expand All @@ -86,6 +86,8 @@ There are a few plugins which allow using Luacheck directly inside an editor, sh
* For Emacs, [Flycheck](http://www.flycheck.org/) contains [luacheck checker](http://www.flycheck.org/manual/latest/Supported-languages.html#Lua);
* For Brackets, there is [linter.luacheck](https://github.com/Malcolm3141/brackets-luacheck) extension.

If you are a plugin developer, see [recommended way of using Luacheck in a plugin](http://luacheck.readthedocs.org/en/0.11.0/cli.html#stable-interface-for-editor-plugins-and-tools).

### Other projects

* [Luacheck bindings for Node.js](https://www.npmjs.com/package/luacheck);
Expand All @@ -97,13 +99,13 @@ Documentation is available [online](http://luacheck.readthedocs.org). If Luachec

## Development

Luacheck is currently in development. The latest released version is 0.10.0. The interface of the `luacheck` module may change between minor releases. The command line interface is fairly stable.
Luacheck is currently in development. The latest released version is 0.11.0. The interface of the `luacheck` module may change between minor releases. The command line interface is fairly stable.

Use the Luacheck issue tracker on GitHub to submit bugs, suggestions and questions. Any pull requests are welcome, too.

## Building and testing

After the Luacheck repo is cloned and changes are made, run `luarocks make` (optionally prepended with `sudo`) from its root directory to install dev version of Luacheck. To test Luacheck, ensure that you have [busted](http://olivinelabs.com/busted) installed and run `busted spec`.
After the Luacheck repo is cloned and changes are made, run `luarocks make` (optionally prepended with `sudo`) from its root directory to install dev version of Luacheck. To test Luacheck, ensure that you have [busted](http://olivinelabs.com/busted) installed and run `busted`.

## License

Expand Down
2 changes: 1 addition & 1 deletion doc/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d43b93e13331a625eafd96b5503e6e76
config: 0970191b41e0852f9f37190748e7c7c4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified doc/.doctrees/environment.pickle
Binary file not shown.
Binary file modified doc/.doctrees/index.doctree
Binary file not shown.
Binary file modified doc/.doctrees/module.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/_sources/index.txt
Expand Up @@ -11,4 +11,4 @@ Contents:
inline
module

This is documentation for master branch version of `Luacheck <https://github.com/mpeterv/luacheck/>`_, a linter for `Lua <http://www.lua.org/>`_.
This is documentation for 0.11.0 version of `Luacheck <https://github.com/mpeterv/luacheck/>`_, a linter for `Lua <http://www.lua.org/>`_.
6 changes: 3 additions & 3 deletions doc/cli.html
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Command line interface &mdash; luacheck latest documentation</title>
<title>Command line interface &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck latest documentation" href="index.html"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="index.html"/>
<link rel="next" title="Configuration file" href="config.html"/>
<link rel="prev" title="List of warnings" href="warnings.html"/>

Expand Down Expand Up @@ -408,7 +408,7 @@ <h2>Stable interface for editor plugins and tools<a class="headerlink" href="#st
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/config.html
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Configuration file &mdash; luacheck latest documentation</title>
<title>Configuration file &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck latest documentation" href="index.html"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="index.html"/>
<link rel="next" title="Inline options" href="inline.html"/>
<link rel="prev" title="Command line interface" href="cli.html"/>

Expand Down Expand Up @@ -360,7 +360,7 @@ <h2>Per-file and per-path overrides<a class="headerlink" href="#per-file-and-per
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/genindex.html
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Index &mdash; luacheck latest documentation</title>
<title>Index &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -29,7 +29,7 @@



<link rel="top" title="luacheck latest documentation" href="index.html"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="index.html"/>


<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
Expand Down Expand Up @@ -152,7 +152,7 @@ <h1 id="index">Index</h1>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
8 changes: 4 additions & 4 deletions doc/index.html
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Luacheck documentation &mdash; luacheck latest documentation</title>
<title>Luacheck documentation &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck latest documentation" href="#"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="#"/>
<link rel="next" title="List of warnings" href="warnings.html"/>


Expand Down Expand Up @@ -161,7 +161,7 @@ <h1>Luacheck documentation<a class="headerlink" href="#luacheck-documentation" t
</li>
</ul>
</div>
<p>This is documentation for master branch version of <a class="reference external" href="https://github.com/mpeterv/luacheck/">Luacheck</a>, a linter for <a class="reference external" href="http://www.lua.org/">Lua</a>.</p>
<p>This is documentation for 0.11.0 version of <a class="reference external" href="https://github.com/mpeterv/luacheck/">Luacheck</a>, a linter for <a class="reference external" href="http://www.lua.org/">Lua</a>.</p>
</div>


Expand Down Expand Up @@ -200,7 +200,7 @@ <h1>Luacheck documentation<a class="headerlink" href="#luacheck-documentation" t
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/inline.html
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Inline options &mdash; luacheck latest documentation</title>
<title>Inline options &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck latest documentation" href="index.html"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="index.html"/>
<link rel="next" title="Luacheck module" href="module.html"/>
<link rel="prev" title="Configuration file" href="config.html"/>

Expand Down Expand Up @@ -265,7 +265,7 @@ <h1>Inline options<a class="headerlink" href="#inline-options" title="Permalink
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/module.html
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Luacheck module &mdash; luacheck latest documentation</title>
<title>Luacheck module &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck latest documentation" href="index.html"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="index.html"/>
<link rel="prev" title="Inline options" href="inline.html"/>


Expand Down Expand Up @@ -200,7 +200,7 @@ <h1>Luacheck module<a class="headerlink" href="#luacheck-module" title="Permalin
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
Binary file modified doc/objects.inv
Binary file not shown.
6 changes: 3 additions & 3 deletions doc/search.html
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Search &mdash; luacheck latest documentation</title>
<title>Search &mdash; luacheck 0.11.0 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck latest documentation" href="index.html"/>
<link rel="top" title="luacheck 0.11.0 documentation" href="index.html"/>


<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
Expand Down Expand Up @@ -157,7 +157,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
VERSION:'0.11.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down

0 comments on commit aee4f45

Please sign in to comment.