diff --git a/README.md b/README.md index d7166daf..5f337469 100644 --- a/README.md +++ b/README.md @@ -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 ` script using the Lua interpreter. If Lua interpreter is not in `PATH`, invoke it using absolute path. 3. Add `/bin` to PATH or run Luacheck as `/bin/luacheck`. @@ -46,17 +46,17 @@ 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 @@ -64,7 +64,7 @@ Checking extra_file.lua Failure 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 @@ -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); @@ -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 diff --git a/doc/.buildinfo b/doc/.buildinfo index 1a9d31ae..8e145529 100644 --- a/doc/.buildinfo +++ b/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 diff --git a/doc/.doctrees/environment.pickle b/doc/.doctrees/environment.pickle index e311277e..f09e69e5 100644 Binary files a/doc/.doctrees/environment.pickle and b/doc/.doctrees/environment.pickle differ diff --git a/doc/.doctrees/index.doctree b/doc/.doctrees/index.doctree index d7b11daa..4b38ca73 100644 Binary files a/doc/.doctrees/index.doctree and b/doc/.doctrees/index.doctree differ diff --git a/doc/.doctrees/module.doctree b/doc/.doctrees/module.doctree index f7c1b230..59ced91e 100644 Binary files a/doc/.doctrees/module.doctree and b/doc/.doctrees/module.doctree differ diff --git a/doc/_sources/index.txt b/doc/_sources/index.txt index 91d5fb64..09db81d0 100644 --- a/doc/_sources/index.txt +++ b/doc/_sources/index.txt @@ -11,4 +11,4 @@ Contents: inline module -This is documentation for master branch version of `Luacheck `_, a linter for `Lua `_. +This is documentation for 0.11.0 version of `Luacheck `_, a linter for `Lua `_. diff --git a/doc/cli.html b/doc/cli.html index ff75fce2..953a8dda 100644 --- a/doc/cli.html +++ b/doc/cli.html @@ -7,7 +7,7 @@ - Command line interface — luacheck latest documentation + Command line interface — luacheck 0.11.0 documentation @@ -28,7 +28,7 @@ - + @@ -408,7 +408,7 @@

Stable interface for editor plugins and tools var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'latest', + VERSION:'0.11.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/config.html b/doc/config.html index 21bced32..2860ff34 100644 --- a/doc/config.html +++ b/doc/config.html @@ -7,7 +7,7 @@ - Configuration file — luacheck latest documentation + Configuration file — luacheck 0.11.0 documentation @@ -28,7 +28,7 @@ - + @@ -360,7 +360,7 @@

Per-file and per-path overrides var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'latest', + VERSION:'0.11.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/genindex.html b/doc/genindex.html index 6df2fa25..762915e9 100644 --- a/doc/genindex.html +++ b/doc/genindex.html @@ -8,7 +8,7 @@ - Index — luacheck latest documentation + Index — luacheck 0.11.0 documentation @@ -29,7 +29,7 @@ - + @@ -152,7 +152,7 @@

Index

@@ -157,7 +157,7 @@