Skip to content

Commit ce1ea1b

Browse files
author
EternalSun
committed
init lua-ctags
0 parents  commit ce1ea1b

27 files changed

+4085
-0
lines changed

‎.gitignore

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.luacheckcache
2+
luacov.stats.out
3+
luacov.report.out
4+
doc
5+
*.rock
6+
!build/
7+
build/*
8+
!build/Makefile
9+
!build/bin
10+
build/bin/*
11+
!build/bin/lua-ctags.lua
12+
package
13+
scripts/UnicodeData-*
14+
docsrc/.doctrees

‎.luactags

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
-- { function_name = args_index }
2+
module_define = {
3+
moduleDef = 1,
4+
moduleStartDef = 2,
5+
}
6+
7+
class_define = {
8+
9+
}

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014 - 2018 Peter Melnichenko
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+211
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
# Luacheck
2+
3+
[![Join the chat at https://gitter.im/lua-ctags/Lobby](https://badges.gitter.im/lua-ctags/Lobby.svg)](https://gitter.im/lua-ctags/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
5+
[![Luacheck](https://img.shields.io/github/actions/workflow/status/lunarmodules/lua-ctags/lua-ctags.yml?branch=master&label=Luacheck&logo=Lua)](https://github.com/lunarmodules/lua-ctags/actions?workflow=Luacheck)
6+
[![Busted](https://img.shields.io/github/actions/workflow/status/lunarmodules/lua-ctags/busted.yml?branch=master&label=Busted&logo=Lua)](https://github.com/lunarmodules/lua-ctags/actions?workflow=Busted)
7+
[![Coverage Status](https://img.shields.io/coveralls/github/lunarmodules/lua-ctags?label=Coveralls&logo=Coveralls)](https://coveralls.io/github/lunarmodules/lua-ctags?branch=master)
8+
[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/lunarmodules/lua-ctags?label=Tag&logo=GitHub)](https://github.com/lunarmodules/lua-ctags/releases)
9+
[![Luarocks](https://img.shields.io/luarocks/v/lunarmodules/lua-ctags?label=Luarocks&logo=Lua)](https://luarocks.org/modules/lunarmodules/lua-ctags)
10+
11+
## Contents
12+
13+
* [Overview](#overview)
14+
* [Installation](#installation)
15+
* [Basic usage](#basic-usage)
16+
* [Related projects](#related-projects)
17+
* [Documentation](#documentation)
18+
* [Development](#development)
19+
* [Building and testing](#building-and-testing)
20+
* [License](#license)
21+
22+
## Overview
23+
24+
Luacheck is a static analyzer and a linter for [Lua](http://www.lua.org). Luacheck detects various issues such as usage of undefined global variables, unused variables and values, accessing uninitialized variables, unreachable code and more. Most aspects of checking are configurable: there are options for defining custom project-related globals, for selecting set of standard globals (version of Lua standard library), for filtering warnings by type and name of related variable, etc. The options can be used on the command line, put into a config or directly into checked files as Lua comments.
25+
26+
Luacheck supports checking Lua files using syntax of Lua 5.1 - 5.4, and LuaJIT. Luacheck itself is written in Lua and runs on all of mentioned Lua versions.
27+
28+
## Installation
29+
30+
### Using LuaRocks
31+
32+
From your command line run the following command (using `sudo` if necessary):
33+
34+
```
35+
luarocks install lua-ctags
36+
```
37+
38+
For parallel checking Luacheck additionally requires [LuaLanes](https://github.com/LuaLanes/lanes), which can be installed using LuaRocks as well (`luarocks install lanes`).
39+
40+
### Windows binary download
41+
42+
For Windows there is single-file 64-bit binary distribution, bundling Lua 5.4.4, Luacheck, LuaFileSystem, and LuaLanes using [LuaStatic](https://github.com/ers35/luastatic):
43+
[download](https://github.com/lunarmodules/lua-ctags/releases/download/v1.2.0/lua-ctags.exe).
44+
45+
## Basic usage
46+
47+
After Luacheck is installed, run `lua-ctags` program from the command line. Pass a list of files, [rockspecs](https://github.com/luarocks/luarocks/wiki/Rockspec-format) or directories (requires LuaFileSystem) to be checked:
48+
49+
```
50+
lua-ctags src extra_file.lua another_file.lua
51+
```
52+
53+
```
54+
Checking src/good_code.lua OK
55+
Checking src/bad_code.lua 3 warnings
56+
57+
src/bad_code.lua:3:23: unused variable length argument
58+
src/bad_code.lua:7:10: setting non-standard global variable embrace
59+
src/bad_code.lua:8:10: variable opt was previously defined as an argument on line 7
60+
61+
Checking src/python_code.lua 1 error
62+
63+
src/python_code.lua:1:6: expected '=' near '__future__'
64+
65+
Checking extra_file.lua 5 warnings
66+
67+
extra_file.lua:3:18: unused argument baz
68+
extra_file.lua:4:8: unused loop variable i
69+
extra_file.lua:13:7: accessing uninitialized variable a
70+
extra_file.lua:14:1: value assigned to variable x is unused
71+
extra_file.lua:21:7: variable z is never accessed
72+
73+
Checking another_file.lua 2 warnings
74+
75+
another_file.lua:2:7: unused variable height
76+
another_file.lua:3:7: accessing undefined variable heigth
77+
78+
Total: 10 warnings / 1 error in 5 files
79+
```
80+
81+
For more info, see [documentation](https://lua-ctags.readthedocs.io/en/stable/).
82+
83+
## Related projects
84+
85+
### Editor support
86+
87+
There are a few plugins which allow using Luacheck directly inside an editor, showing warnings inline:
88+
89+
* For Vim, [Syntastic](https://github.com/vim-syntastic/syntastic) contains [lua-ctags checker](https://github.com/vim-syntastic/syntastic/wiki/Lua%3A---lua-ctags);
90+
* For Sublime Text 3 there is [SublimeLinter-lua-ctags](https://packagecontrol.io/packages/SublimeLinter-lua-ctags) which requires [SublimeLinter](https://sublimelinter.readthedocs.io/en/latest/);
91+
* For Atom there is [linter-lua-ctags](https://atom.io/packages/linter-lua-ctags) which requires [AtomLinter](https://github.com/steelbrain/linter);
92+
* For Emacs, [Flycheck](http://www.flycheck.org/en/latest/) contains [lua-ctags checker](http://www.flycheck.org/en/latest/languages.html#lua);
93+
* For Brackets, there is [linter.lua-ctags](https://github.com/Malcolm3141/brackets-lua-ctags) extension;
94+
* For Visual Studio code there is [vscode-lua-ctags](https://marketplace.visualstudio.com/items?itemName=dwenegar.vscode-lua-ctags) extension. [vscode-lua](https://marketplace.visualstudio.com/items?itemName=trixnz.vscode-lua) extension also includes Luacheck support;
95+
* For Nova, search the Extension Library for the [Luacheck](https://github.com/GarrettAlbright/Luacheck.novaextension) extension.
96+
97+
If you are a plugin developer, see [recommended way of using Luacheck in a plugin](http://lua-ctags.readthedocs.org/en/stable/cli.html#stable-interface-for-editor-plugins-and-tools).
98+
99+
### Other projects
100+
101+
* [Luacheck bindings for Node.js](https://www.npmjs.com/package/lua-ctags);
102+
* [Luacheck plugin for Gulp](https://www.npmjs.com/package/gulp-lua-ctags).
103+
104+
## Documentation
105+
106+
Documentation is available [online](https://lua-ctags.readthedocs.io/en/stable/). If Luacheck has been installed using LuaRocks, it can be browsed offline using `luarocks doc lua-ctags` command.
107+
108+
Documentation can be built using [Sphinx](http://sphinx-doc.org/): `sphinx-build docsrc doc`, the files will be found inside `doc/`.
109+
110+
## Development
111+
112+
Luacheck is currently in development. The latest released version is v1.2.0. The interface of the `lua-ctags` module may change between minor releases. The command line interface is fairly stable.
113+
114+
Use the Luacheck issue tracker on GitHub to submit bugs, suggestions and questions. Any pull requests are welcome, too.
115+
116+
## Building and testing
117+
118+
After the Luacheck repo is cloned and changes are made, run `luarocks make` (using `sudo` if necessary) from its root directory to install dev version of Luacheck. To run Luacheck using sources in current directory without installing it, run `lua -e 'package.path="./src/?.lua;./src/?/init.lua;"..package.path' bin/lua-ctags.lua ...`. To test Luacheck, ensure that you have [busted](http://olivinelabs.com/busted/), [luautf8](https://github.com/starwing/luautf8), and [luasocket](https://github.com/lunarmodules/luasocket) installed and run `busted`.
119+
120+
## Docker
121+
122+
Alternatively Luacheck can be run as a standalone docker container.
123+
The usage of docker is fairly simple.
124+
You can either build your own or download a prebuilt version.
125+
To build your own, execute the following command from the source directory of this project:
126+
127+
```console
128+
$ docker build -t ghcr.io/lunarmodules/lua-ctags:HEAD .
129+
```
130+
131+
To use a prebuilt one, download it from the GitHub Container Registry.
132+
Here we use the one tagged *latest*, but you can substitute *latest* for any tagged release.
133+
134+
```console
135+
$ docker pull ghcr.io/lunarmodules/lua-ctags:latest
136+
```
137+
138+
Once you have a container you can run it on one file or a source tree (substitute *latest* with *HEAD* if you built your own or with the tagged version you want if applicable):
139+
140+
```console
141+
# Run on an entire directory
142+
$ docker run -v "$(pwd):/data" ghcr.io/lunarmodules/lua-ctags:latest .
143+
144+
# Run on one file:
145+
$ docker run -v "$(pwd):/data" ghcr.io/lunarmodules/lua-ctags:latest bin/lua-ctags.lua
146+
```
147+
148+
A less verbose way to run it in most shells is with at alias:
149+
150+
```console
151+
# In a shell or in your shell's RC file:
152+
$ alias lua-ctags='docker run -v "$(pwd):/data" ghcr.io/lunarmodules/lua-ctags:latest'
153+
154+
# Thereafter just run:
155+
$ lua-ctags .
156+
```
157+
### Use as a CI job
158+
159+
There are actually many ways to run Luacheck remotely as part of a CI work flow.
160+
Because packages are available for many platforms, one way would be to just use your platforms native package installation system to pull them into whatever CI runner environment you already use.
161+
Another way is to pull in the prebuilt Docker container and run that.
162+
163+
As a case study, here is how a workflow could be setup in GitHub Actions:
164+
165+
```yaml
166+
name: Luacheck
167+
on: [push, pull_request]
168+
jobs:
169+
lua-ctags:
170+
runs-on: ubuntu-latest
171+
steps:
172+
- name: Checkout
173+
uses: actions/checkout@v4
174+
- name: Luacheck linter
175+
uses: lunarmodules/lua-ctags@v1
176+
```
177+
178+
By default the GH Action is configured to run `lua-ctags .`, but you can also pass it your own `args` to replace the default input of `.`.
179+
180+
```yaml
181+
- name: Luacheck linter
182+
uses: lunarmodules/lua-ctags@v1
183+
with:
184+
args: myfile.lua
185+
```
186+
187+
## License
188+
189+
```
190+
The MIT License (MIT)
191+
192+
Copyright (c) 2014 - 2018 Peter Melnichenko
193+
194+
Permission is hereby granted, free of charge, to any person obtaining a copy
195+
of this software and associated documentation files (the "Software"), to deal
196+
in the Software without restriction, including without limitation the rights
197+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
198+
copies of the Software, and to permit persons to whom the Software is
199+
furnished to do so, subject to the following conditions:
200+
201+
The above copyright notice and this permission notice shall be included in all
202+
copies or substantial portions of the Software.
203+
204+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
205+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
206+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
207+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
208+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
209+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
210+
SOFTWARE.
211+
```

‎bin/lua-ctags.bat

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
@echo off
2+
lua.exe "%~dp0\lua-ctags.lua" %*

‎bin/lua-ctags.lua

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env lua
2+
require "lua-ctags.main"

‎build/Makefile

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Makefile for (cross)compiling lua-ctags binaries.
2+
# Do not use directly, run scripts/build-binaries.sh instead.
3+
4+
LUA_VERSION= 5.4.4
5+
LFS_VERSION= 1.8.0-1
6+
ARGPARSE_VERSION= 0.7.1-1
7+
8+
LUA_DIR= lua-$(LUA_VERSION)
9+
LFS_DIR= luafilesystem-$(LFS_VERSION)/luafilesystem
10+
ARGPARSE_DIR= argparse-$(ARGPARSE_VERSION)/argparse-$(ARGPARSE_VERSION:-1=)
11+
12+
BASE_CC= gcc
13+
BASE_AR= ar rc
14+
BASE_RANLIB= ranlib
15+
BASE_STRIP= strip
16+
BASE_NM= nm
17+
18+
CROSS=
19+
CC= $(CROSS)$(BASE_CC)
20+
CFLAGS= -O2 -Wall -Wextra
21+
AR= $(CROSS)$(BASE_AR)
22+
NM= $(CROSS)$(BASE_NM)
23+
RANLIB= $(CROSS)$(BASE_RANLIB)
24+
STRIP= $(CROSS)$(BASE_STRIP)
25+
26+
SUFFIX=
27+
TARGET= bin/lua-ctags$(SUFFIX)
28+
29+
LUA_O= $(patsubst %.c,%.o,$(filter-out $(addprefix $(LUA_DIR)/src/,lua.c luac.c print.c),$(wildcard $(LUA_DIR)/src/*.c)))
30+
LUA_A= $(LUA_DIR)/src/liblua.a
31+
LFS_O= $(patsubst %.c,%.o,$(wildcard $(LFS_DIR)/src/*.c))
32+
LFS_A= $(LFS_DIR)/src/lfs.a
33+
34+
default: $(TARGET)
35+
36+
$(LUA_DIR):
37+
@echo
38+
@echo "=== Downloading Lua $(LUA_VERSION) ==="
39+
@echo
40+
curl "https://www.lua.org/ftp/$(LUA_DIR).tar.gz" | tar xz
41+
42+
$(LFS_DIR):
43+
@echo
44+
@echo "=== Downloading LuaFileSystem $(LFS_VERSION) ==="
45+
@echo
46+
luarocks unpack luafilesystem $(LFS_VERSION)
47+
48+
$(ARGPARSE_DIR):
49+
@echo
50+
@echo "=== Downloading argparse $(ARGPARSE_VERSION) ==="
51+
@echo
52+
luarocks unpack argparse $(ARGPARSE_VERSION)
53+
54+
fetch: $(LUA_DIR) $(LFS_DIR) $(ARGPARSE_DIR)
55+
56+
$(LUA_O): CFLAGS+= $(if $(LINUX),-DLUA_USE_POSIX)
57+
$(LUA_A): $(LUA_O)
58+
$(LFS_O): CFLAGS+= -I$(LUA_DIR)/src
59+
$(LFS_A): $(LFS_O)
60+
61+
%.a:
62+
$(AR) $@ $^
63+
$(RANLIB) $@
64+
65+
$(TARGET): $(LUA_A) $(LFS_A)
66+
cp $(LUA_A) .
67+
cp $(LFS_A) .
68+
cp $(ARGPARSE_DIR)/src/argparse.lua .
69+
cp -r ../src/lua-ctags .
70+
cp -f bin/lua-ctags.lua bin/lua-ctags_bin.lua
71+
CC=$(CC) NM=$(NM) RANLIB=$(RANLIB) luastatic bin/lua-ctags_bin.lua lua-ctags/*.lua lua-ctags/*/*.lua lua-ctags/*/*/*.lua argparse.lua $(LUA_A) $(LFS_A) -lm $(if $(LINUX),-lpthread) -I$(LUA_DIR)/src
72+
rm lua-ctags_bin.luastatic.c
73+
$(STRIP) lua-ctags_bin*
74+
mv lua-ctags_bin* $(TARGET)
75+
76+
clean:
77+
rm -f $(TARGET) lua-ctags.luastatic.c
78+
rm -f $(LUA_O) $(LUA_A) $(LFS_O) $(LFS_A)
79+
rm -f argparse.lua lfs.a liblua.a
80+
rm -rf lua-ctags
81+
rm -f lua-ctags_bin*
82+
83+
.PHONY: default fetch clean

‎build/bin/lua-ctags.lua

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
-- Version of bin/lua-ctags.lua for use in lua-ctags binaries.
2+
3+
-- Do not load modules from filesystem in case a bundled module is broken.
4+
package.path = ""
5+
package.cpath = ""
6+
7+
require "lua-ctags.main"

0 commit comments

Comments
 (0)