(This was originally meant as a reply to the first comment to Krtek’s question, but I ran out of space there and to be honest it works as an answer just fine.)
Functions are essentially values, and thus a named function is actually a variable of that name. Variables, by their very definition, can change as a script is executed. Hell, someone might accidentally redefine one of those functions. Is that bad? To sum my thoughts up: depending on the script, parameters passed and/or actual implementations of those pre-defined functions you speak of (one might unset itself or others, for example), it is not possible to guarantee things work unless you are willing to narrow down some of your demands. Lua is too dynamic for what you are looking for. 
If you want a flawless test: create a dummy environment with all bells and whistles in place, and see if it crashes anywhere along the way (loading, executing, etc). This is basically a sort of unit test, and as such would be pretty heavy.
If you want a basic check to see if a script has a valid syntax: Krtek gave an answer for that already. I am quite sure (but not 100%) that the lua equivalent is to loadfile or loadstring, and the respective C equivalent is to try and lua_load() the code, each of which convert readable script to bytecode which you would already need to do before you could actually execute the code in your normal all-is-well usecase. (And if that contained function definitions, those would need to be executed later on for the code inside those to execute.)
However, these are the extent of your options with regards to pre-empting errors before they actually happen. Lua is a very dynamic language, and what is a great strength also makes for a weakness when you want to prove correctness. There are simply too many variables involved for a perfect solution.
Luacheck
Contents
- Overview
- Installation
- Basic usage
- Related projects
- Documentation
- Development
- Building and testing
- License
Overview
Luacheck is a static analyzer and a linter for Lua. 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.
Luacheck supports checking Lua files using syntax of Lua 5.1, Lua 5.2, Lua 5.3 and LuaJIT. Luacheck itself is written in Lua and runs on all of mentioned Lua versions.
Installation
Using LuaRocks
From your command line run the following command (using sudo if necessary):
luarocks install luacheck
For parallel checking Luacheck additionally requires LuaLanes, which can be installed using LuaRocks as well (luarocks install lanes).
Windows binary download
For Windows there is single-file 64-bit binary distribution, bundling Lua 5.3.4, Luacheck, LuaFileSystem, and LuaLanes using LuaStatic:
download.
Basic usage
After Luacheck is installed, run luacheck program from the command line. Pass a list of files, rockspecs or directories (requires LuaFileSystem) to be checked:
luacheck src extra_file.lua another_file.lua
Checking src/good_code.lua OK
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 1 error
src/python_code.lua:1:6: expected '=' near '__future__'
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 2 warnings
another_file.lua:2:7: unused variable height
another_file.lua:3:7: accessing undefined variable heigth
Total: 10 warnings / 1 error in 5 files
For more info, see documentation.
Related projects
Editor support
There are a few plugins which allow using Luacheck directly inside an editor, showing warnings inline:
- For Vim, Syntastic contains luacheck checker;
- For Sublime Text 3 there is SublimeLinter-luacheck which requires SublimeLinter;
- For Atom there is linter-luacheck which requires AtomLinter;
- For Emacs, Flycheck contains luacheck checker;
- For Brackets, there is linter.luacheck extension;
- For Visual Studio code there is vscode-luacheck extension. vscode-lua extension also includes Luacheck support.
If you are a plugin developer, see recommended way of using Luacheck in a plugin.
Other projects
- Luacheck bindings for Node.js;
- Luacheck plugin for Gulp.
Documentation
Documentation is available online. If Luacheck has been installed using LuaRocks, it can be browsed offline using luarocks doc luacheck command.
Documentation can be built using Sphinx: sphinx-build docsrc doc, the files will be found inside doc/.
Development
Luacheck is currently in development. The latest released version is 0.23.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 (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/luacheck.lua .... To test Luacheck, ensure that you have busted and luautf8 installed and run busted.
License
The MIT License (MIT)
Copyright (c) 2014 - 2018 Peter Melnichenko
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.
Во время скриптинга вы часто будете встречать проблемы, незаметные с первого взгляда. Эта страница покажет вам некоторые базовые стратегии локализирования ошибок.
Консоль отладки
MTA предоставляет встроенную консоль отладки, которая показывает отладочные сообщения от функций и скриптов MTA. Ее можно открыть, введя в консоли debugscript x, где x — уровень отладки:
- 1: только ошибки
- 2: ошибки и предупреждения
- 3: ошибки, предупреждения и информационные сообщения
Таким образом, при вводе debugscript 3 видны все сообщения, так что либо этот, либо уровень 2 рекомендованы в большинстве случаев. debugscript следует иметь включенным на протяжении практически всего времени, когда тестируете свои скрипты, это поможет в обнаружении опечаток и других мелких ошибок, позволяя с легкостью их поправить.
Пример
В этом отрывке две ошибки:
if (getPlayerName(player) == "Fedor")
outputChatbox("Hello Fedor")
end
Когда скрипт, в котором присутствует данный отрывок кода попробует загрузиться, debugscript выведет что-то типа этого:
- INFO: Loading script failed: C:<server path>modsdeathmatchresourcesmyResourcescript.lua:15: ‘then’ expected near ´outputChatbox’
Это значит, что скрипт не может быть обработан в силу синтаксической ошибки. Показывается путь ко скрипту, чтобы можно было также увидеть, частью какого ресурса он является (‘myResource’ в данном случае), и, конечно, имя самого скрипта. После имени файла показан номер строки и что в ней, собственно, не так. Теперь все с легкостью можно исправить, мы просто забыли оператор ‘then’:
if (getPlayerName(player) == "Fedor") then
outputChatbox("Hello Fedor")
end
Сейчас скрипт нормально загрузится и не выведет никаких ошибок, но только пока не выполнится для игрока с ником ‘Fedor’. В этом случае, debugscript выведет:
- ERROR: C:<server path>modsdeathmatchresourcesdscript.lua:15: attempt to call global ‘outputChatbox’ (a nil value)
То есть, что вызванной функции не существует, что и не удивительно, так как ее правильное название — outputChatBox (с заглавной B):
if (getPlayerName(player) == "Fedor") then
outputChatBox("Hello Fedor")
end
Это, конечно, лишь пример, есть еще море других сообщений и сценариев, но вам теперь должна быть понятна сама суть.
Ведение отладочного лога на сервере и клиенте
Сервер
Перейдите в: (корневая папка MTA)>server>mods>deathmatch
Там есть два практически одинаковых файла:
- local.conf — содержит настройки сервера, доступного по нажатию на пункт «host game» главного меню MTA. Это быстрый и простой путь ненадолго запустить сервер извнутри клиента. При выключении клиента выключится и сервер.
- mtaserver.conf — используется при выполнении запуска «MTA Server.exe» из (корневая папка MTA)>server. Это способ запустить сервер независимо от клиента на продолжительное время.
В зависимости от выбранного вами способа, вам захочется отредактировать один из этих файлов. Настройки, интересные нам:
<!-- Задает имя и путь лог-файла debugscript. Если оставить пустым, такой файл создан не будет. --> <scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile> <!-- Задает уровень лог-файла debugscript. Допустимые значения: 0, 1, 2, 3. Если не установить, по умолчанию будет 0. --> <scriptdebugloglevel>0</scriptdebugloglevel>
Убедитесь, что указали имя лога. Также укажите уровень ошибок, которые будут записываться. При указании 0 ничего не будет записываться. Другие уровни были объяснены в начале данной статьи. При смене уровня записи на 3, все ошибки серверных скриптов будут записаны в (корневая папка MTA)>server>mods>deathmatch>logs>scripts.log
Клиент
Перейдите в: (корневая папка MTA)>server>clientscript.log
В этот файл ведется запись ошибок всех клиентских скриптов. Запись включена по умолчанию, вмешательств не требуется.
Стратегии отладки
Есть несколько стратегий, помогающих в поиске ошибок, мы говорим об отличных от непосредственного просмотра кода, конечно же. Большинство из них включает в себя вывод отладочных сообщений с варьирующейся от ситуации к ситуации информацией.
Полезные функции
Для начала, некоторые функции, которые могут оказаться удобными при отладке.
- outputDebugString или outputChatBox для вывода информации любого вида
- tostring() обращает переменную в строковую, например, когда она является бинарной (двоичной)
- getElementType для выполнения проверки элемента MTA на получение его типа
Добавляйте отладочные сообщения, чтобы проверять когда, как часто и вообще, выполняется ли участок кода
Типичный пример проверки на выполнение участка с if. Чтобы его сделать, просто добавьте любое сообщение, которое вы потом будете в состоянии понять, внутрь участка с if.
if (variable1 == variable2) then
outputDebugString("вошел в if")
-- что-нибудь делаем
end
Другое применение — проверка переменной на предмет ее изменения. Для начала найдите все случаи, где переменная редактируется, и добавьте сообщения прямо рядом с ней.
Добавляйте отладочные сообщения для проверки значения переменной
Скажем, вы создали маркер, но он не появляется на той позиции, на которой вы этого хотели бы. Первое, что вы захотите сделать — проверить, была ли выполнена функция createMarker. Но одновременно с этим вы также можете проверить и значения, используемые при выполнении функции createMarker, всего за один запуск.
outputChatBox("posX - "..x.." posY - "..y.." posZ - "..z)
createMarker(x,y,z)
Это выведет в консоль отладки все три переменные, используемые в качестве коодинат для маркера. Подразумевая, что у вас они считываются из map-файла, теперь вы сможете сравнить выведенное в консоль с желаемыми значениями. tostring() гарантирует, что значения переменных смогут быть выведены вместе строкой, даже если они, например, двоичные.
Пример
Представьте, что где-то вы создали колшейп (collision shape) и хотите производить какое-либо действие над игроком, простоявшим в нем 10 секунд.
function colShapeHit(player)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
function colShapeLeave(player)
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
При попадании игрока в колшейп, в консоль отладки выводится следующее сообщение:
- ERROR: ..[path]: attempt to index global ‘colshapeTimer’ (a nil value)
Что значит, что вы пытались проиндексировать несуществующую таблицу. В образце выше это сделано, так как id таймера сохраняется в таблице. Нам нужно добавить проверку на то, существует ли таблица, а если нет — создать ее.
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
function colShapeLeave(player)
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Но мы все же получаем предупреждение, когда игрок попадает в колшейп, ждет сообщения и снова его покидает:
- WARNING: [..]: Bad argument @ ‘killTimer’ Line: ..
За исключением этого сообщения (о нем поговорим позже) все, похоже, работает правильно. Игрок попадает в колшейп, таймер стартует, если он остается, появляется сообщение, если он уходит, таймер убирается.
Более незаметная ошибка
Но, в силу некоторых обстоятельств, сообщение выводится дважды, если вы остаетесь в колшейпе на транспортном средстве. Если так получается, значит какой-то код выполняется дважды, мы добавим отладочные сообщения для проверки.
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- добавляем отладочное сообщение
outputDebugString("colShapeHit")
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
function colShapeLeave(player)
-- добавляем отладочное сообщение
outputDebugString("colShapeLeave")
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Теперь мы точно видим, что обе функции, прикрепленные к обработчикам, выполняются дважды, если мы в ТС, или один раз, если мы вне ТС. Такое может получаться, если транспортное средство тоже вызывает срабатывание колшейпа. Чтобы подтвердить или опровергнуть эту теорию, проверим переменную player, которая должна содержать элемент типа player.
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeHit "..getElementType(player))
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
function colShapeLeave(player)
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeLeave "..getElementType(player))
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Отладочные сообщения говорят, что одна из переменных player — действительно игрок, а другая — элемент типа vehicle, т.е. ТС. Так как мы хотим, чтобы срабатывание происходило при попадании в колшейп именно игрока, добавляем if, который предотвратит выполнение функции, если в него попал не игрок (не элемент типа player).
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeHit "..getElementType(player))
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
function colShapeLeave(player)
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeLeave "..getElementType(player))
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Теперь скрипт должен работать как задумано, но все еще будет выводить предупреждение, о котором было сказано ранее. Это происходит, так как таймер, который мы пытаемся убрать при покидании игроком колшейпа, не будет более существовать по прошествии 10 секунд (уже истек). Есть множество способов избавиться от этого предупреждения (вы же знаете, что таймер может более не существовать, и вы хотите его убрать, только если он еще существует). Одним из способов является проверка на то, существует ли упоминаемый в таблице таймер на самом деле. Чтобы ее сделать, нам понадобится isTimer, которой мы и воспользуемся при убирании таймера:
if (isTimer(colshapeTimer[player])) then killTimer(colshapeTimer[player]) end
Итак, полностью рабочий код таков:
function colShapeHit(player)
if (colshapeTimer == nil) then
colshapeTimer = {}
end
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeHit "..getElementType(player))
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
function colShapeLeave(player)
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeLeave "..getElementType(player))
-- убираем таймер при покидании игроком колшейпа
if (isTimer(colshapeTimer[player])) then
killTimer(colshapeTimer[player])
end
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Отладка проблем с производительностью
Если ваш сервер использует намного больше ресурсов, чем ему следовало бы, или вы просто хотите убедиться, что ваши скрипты эффективны, вы можете узнать правду, воспользовавшись отличным инструментом, который поставляется вместе с сервером MTA SA — performancebrowser. Удостоверьтесь, что он запущен, введя «start performancebrowser», а если у вас его нет, возьмите из комплекта стандартных ресурсов, поставляемых с сервером. Данный инструмент предоставляет потрясающее количество информации, полезной для отладки проблем с производительностью. Утечки памяти, утечки элементов и интенсивно использующие процессор скрипты легко найти через performancebrowser. Например, при использовании опции -d в Lua timing, вы можете увидеть, какие функции сильно загружают процессор.
Для доступа к performancebrowser вам понадобится перейти по адресу: http://здесьIPсервера:здесьHTTPпортсервера/performancebrowser/ в своем интернет-браузере. Заметьте, что в конце требуется символ / (слэш). То есть, например: http://127.0.0.1:22005/performancebrowser/ Затем вам понадобится войти со внутриигрового администраторского аккаунта или любого другого аккаунта, имеющего доступ к «general.HTTP». Большинство нужной вам информации находится в разделах Lua timing и Lua memory, там смотрите на те показатели, которые значительно превышают другие.
Примеры скриптов, которые могут вызывать провалы производительности
Добавление данных в таблицу без последующего удаления. Хотя пройдут месяцы/годы, пока это реально вызовет какие-либо проблемы.
local someData = {}
function storeData()
someData[source] = true
-- Здесь не учитывается выход игрока, что вызовет утечку памяти
-- Используя вкладку Lua timing, вы можете обнаружить использование RAM каждым из ресурсов.
end
addEventHandler("onPlayerJoin", root, storeData)
Утечка элементов возможна при использовании по какой-либо причине множества временных колшейпов и последующем их неустранении. Через некоторое время это повлечет за собой проблемы с пропускной способностью, расходом процессора и памяти сервера.
function useTemporaryCol()
local col = createColCircle(здесь какой-нибудь код)
if (нормальные для этого условия) then
destroyElement(col)
end
-- Но иногда этого не происходит, так что даже по окончании скрипта зона коллизии остается, что впоследствии
-- может вылиться в сотни, а то и тысячи бесполезных зон коллизии.
-- Вкладка Lua timing позволит вам увидеть количество элементов, созданных каждым скриптом.
end
Большой расход процессора чреват тем, что выливается в просадку FPS сервера до порога, когда тот становится неиграбельным. Менее чем за 24 часа это может превратить даже самый популярный сервер в пустующий. Количество «refs» в Lua timing обнаруживает данный тип скопления, удивительно, но вкладка Lua timing в данном случае не помогла, когда Lua memory — напротив.
addEventHandler("onPlayerJoin", root, function()
-- Код для заходов
addEventHandler("onPlayerQuit", root, function()
-- Код для того, когда выходят
-- Видите проблему? Он привязан к корню (root), к которому обработчик добавляется снова, снова и снова
end)
end)
Функция интенсивно использует процессор, потому что то, что она выполняет, занимает много времени. Это просто функция, которой для завершения требуется много времени. Без performancebrowser вы бы и не догадывались, в чем причина, но с performancebrowser вы можете увидеть, что ресурс сильно загружает процессор во вкладке Lua timing. Если вы затем введете: -d в редактируемое поле options, он даже скажет название файла и первую строку функции, которая так сильно загружает процессор.
function someDodgyCode()
for i=1, 100000 do
-- какой-нибудь код
end
end
Это команда luacheck, которую можно запустить в провайдере бесплатного хостинга OnWorks, используя одну из наших многочисленных бесплатных онлайн-рабочих станций, таких как Ubuntu Online, Fedora Online, онлайн-эмулятор Windows или онлайн-эмулятор MAC OS.
ПРОГРАММА:
ИМЯ
luacheck — Документация luacheck
Содержание:
СПИСОК OF ПРЕДУПРЕЖДЕНИЯ
Предупреждения, выдаваемые Luacheck, классифицируются с использованием трехзначных кодов предупреждений. Предупреждение
коды могут отображаться в выводе CLI, используя —коды Опция CLI или Коды вариант конфигурации.
Ошибки также имеют коды, начинающиеся с нуля.
┌─────┬────────────────────────────────────
│Код │ Описание │
├─────┼────────────────────────────────────
│011 │ Синтаксическая ошибка. │
├─────┼────────────────────────────────────
│021 │ Недопустимая встроенная опция. │
├─────┼────────────────────────────────────
│022 │ Встроенный толчок вверх │
│ │ директива. │
├─────┼────────────────────────────────────
│023 │ Встроенная директива pop. │
├─────┼────────────────────────────────────
│111 │ Установка неопределенного глобального │
│ │ переменная. │
├─────┼────────────────────────────────────
│112 │ Мутация неопределенного глобального │
│ │ переменная. │
├─────┼────────────────────────────────────
│113 │ Доступ к неопределенному глобальному │
│ │ переменная. │
├─────┼────────────────────────────────────
│121 │ Настройка глобального только для чтения │
│ │ переменная. │
├─────┼────────────────────────────────────
│122 │ Изменение глобального только для чтения │
│ │ переменная. │
├─────┼────────────────────────────────────
│131 │ Неиспользуемый неявно определенный глобальный │
│ │ переменная. │
├─────┼────────────────────────────────────
│211 │ Неиспользуемая локальная переменная. │
├─────┼────────────────────────────────────
│212 │ Неиспользованный аргумент. │
├─────┼────────────────────────────────────
│213 │ Неиспользуемая переменная цикла. │
├─────┼────────────────────────────────────
│221 │ Доступ к локальной переменной осуществляется, но │
│ │ никогда не устанавливается. │
├─────┼────────────────────────────────────
│231 │ Локальная переменная установлена, но никогда │
│ │ доступ. │
├─────┼────────────────────────────────────
│232 │ Аргумент установлен, но никогда │
│ │ доступ. │
├─────┼────────────────────────────────────
│233 │ Переменная цикла установлена, но никогда │
│ │ доступ. │
├─────┼────────────────────────────────────
│311 │ Значение, присвоенное местному │
│ │ переменная не используется. │
└─────┴────────────────────────────────────
│312 │ Значение аргумента не используется. │
├─────┼────────────────────────────────────
│313 │ Значение переменной цикла: │
│ │ не используется. │
├─────┼────────────────────────────────────
│321 │ Доступ к неинициализированному локальному │
│ │ переменная. │
├─────┼────────────────────────────────────
│411 │ Переопределение локальной переменной. │
├─────┼────────────────────────────────────
│412 │ Новое определение аргумента. │
├─────┼────────────────────────────────────
│413 │ Переопределение переменной цикла. │
├─────┼────────────────────────────────────
│421 │ Затенение локальной переменной. │
├─────┼────────────────────────────────────
│422 │ Слежка за аргументом. │
├─────┼────────────────────────────────────
│423 │ Затенение переменной цикла. │
├─────┼────────────────────────────────────
│431 │ Слежение за ростом стоимости. │
├─────┼────────────────────────────────────
│432 │ Затенение аргумента повышения ценности. │
├─────┼────────────────────────────────────
│433 │ Затенение цикла повышения стоимости │
│ │ переменная. │
├─────┼────────────────────────────────────
│511 │ Недоступный код. │
├─────┼────────────────────────────────────
│512 │ Цикл может быть выполнен не более
│ │ один раз. │
├─────┼────────────────────────────────────
│521 │ Неиспользованная этикетка. │
├─────┼────────────────────────────────────
│531 │ Левая часть задания │
│ │ слишком короткое. │
├─────┼────────────────────────────────────
│532 │ Левая часть задания │
│ │ слишком длинный. │
├─────┼────────────────────────────────────
│541 │ Пустой do конец блокировать. │
├─────┼────────────────────────────────────
│542 │ Пустой if ветвь. │
├─────┼────────────────────────────────────
│551 │ Пустой оператор. │
└─────┴────────────────────────────────────
Глобальный переменные
Для каждого файла Луачек составляет список определенных глобальных объектов, которые можно там использовать. По умолчанию
определены только глобалы из стандартной библиотеки Lua; пользовательские глобалы могут быть добавлены с помощью
—globals Опция CLI или глобальные config, а версия стандартной библиотеки может быть
выбран с помощью —стд Опция CLI или станд вариант конфигурации. Когда установлен неопределенный глобал,
измененный или доступный, Луачек выдает предупреждение.
Только для чтения глобальные
По умолчанию все стандартные глобальные переменные, кроме _G и пакет помечены как доступные только для чтения, так что
установка или изменение их приводит к предупреждению. Пользовательские глобальные переменные, доступные только для чтения, могут быть добавлены с помощью
—read-globals Опция CLI или read_globals вариант конфигурации.
Неявно определенный глобальные
Luacheck можно настроить так, чтобы глобальные переменные, назначенные при определенных условиях, были
определяется неявно. Когда -d/—allow_defined Опция CLI или allow_defined опция конфигурации
используется, все присвоения глобальным объектам определяют их; когда -t/—allow_defined_top Опция CLI или
allow_defined_top используется опция config, назначения глобальным объектам в функции верхнего уровня
область видимости (также известная как основной блок) определяют их. Предупреждение появляется, когда неявно
Определенный глобальный никуда не доступен.
Модули
Файлы могут быть помечены как модули с помощью -m/—модуль Опция CLI или модуль параметр конфигурации для
имитировать семантику устаревших
модуль
функция. Глобалы, неявно определенные внутри
модуль являются частью его интерфейса, не видны снаружи и не сообщаются
как неиспользованный. Назначения другим глобальным объектам не разрешены, даже определенным.
неиспользуемый переменные и ценности
Луачек генерирует предупреждения для всех неиспользуемых локальных переменных, кроме одной с именем _. Он также
обнаруживает переменные, которые установлены, но никогда не используются и не используются, но никогда не устанавливаются.
неиспользуемый ценности и неинициализированным переменные
Для каждого значения, присвоенного локальной переменной, Луачек вычисляет набор выражений, в которых он
может быть использован. Предупреждения выдаются для неиспользуемых значений (когда значение не может быть использовано
где угодно) и для доступа к неинициализированным переменным (когда никакие значения не могут достичь
выражение). Например, в следующем фрагменте значение, присвоенное Foo в строке 1 не используется, и
переменная бар не инициализирован в строке 9:
местный foo = expr1 ()
местный бар
если условие () то
foo = expr2 ()
bar = expr3 ()
еще
foo = expr4 ()
печать (бар)
конец
вернуть фу, бар
Старшая школа ценности и переменные
Неиспользуемое значение, присвоенное локальной переменной, является вторичным, если его источником является последний элемент в
правая часть присвоения, и используется другое значение из этого элемента. Вторичные ценности
обычно появляются, когда результат вызова функции помещается в локальные переменные, и только некоторые из них
позже используются. Например, здесь значение, присвоенное b вторично, значение, присвоенное c is
используется, и значение, присвоенное a просто не используется:
локальные a, b, c = f (), g ()
возврат с
Переменная является вторичной, если все присвоенные ей значения вторичны. В приведенном выше фрагменте
b вторичная переменная.
Предупреждения, связанные с неиспользованными вторичными значениями и переменными, можно удалить с помощью
-s/—no-unused-secondary Опция CLI или неиспользуемые_вторичные вариант конфигурации.
слежка Заявления
Луачек обнаруживает объявления локальных переменных, дублирующие предыдущие объявления, если только
переменная названа _. Если предыдущее объявление находится в той же области, что и новое,
это называется переопределением.
Обратите внимание, что это не необходимо определить новую локальную переменную при перезаписи аргумента:
локальная функция f (x)
local x = x или «по умолчанию» — плохо
конец
локальная функция f (x)
x = x или «default» — хорошо
конец
Control
поток и дата поток вопросы
Обнаружены следующие проблемы с потоком управления и потоками данных:
· Недостижимый код и циклы, которые могут быть выполнены не более одного раза (например, из-за
безусловный перерыв);
· Неиспользованные этикетки;
· Несбалансированные задания;
· Пустые блоки.
· Пустые операторы (точки с запятой без предшествующих операторов).
КОМАНДА ЛИНИЯ ИНТЕРФЕЙС
Луачек программа принимает файлы, каталоги и
камни
в качестве аргументов.
· Учитывая файл, Луачек проверим это.
· Данный —, Луачек проверит stdin.
· Учитывая каталог, Луачек проверит все файлы в нем, выбирая только файлы с
.луна продление, если —include-файлы опция используется. Эта функция требует
LuaFileSystem
(устанавливается автоматически, если для установки Luacheck использовался LuaRocks).
· Учитывая рокспек (файл с .рокспек расширение), Луачек проверит все файлы с
.луна расширение, упомянутое в Rockpec в build.install.lua, build.install.bin и
построить.модули столы.
Выход Луачек состоит из отдельных отчетов по каждому проверенному файлу и заканчивается
резюме:
$ luacheck источник
Проверка предупреждений src / bad_code.lua 5
src / bad_code.lua: 3:16: неиспользуемая вспомогательная переменная
src / bad_code.lua: 3: 23: неиспользуемый аргумент переменной длины
src / bad_code.lua: 7: 10: установка нестандартного объятия глобальной переменной
src / bad_code.lua: 8: 10: переменная opt была ранее определена как аргумент в строке 7
src / bad_code.lua: 9: 11: доступ к неопределенной переменной hepler
Проверка src / good_code.lua ОК
Проверка ошибки src / python_code.lua 1
src / python_code.lua: 1: 6: ожидалось ‘=’ рядом с ‘__future__’
Проверка предупреждений src / unused_code.lua 9
src / unused_code.lua: 3: 18: неиспользуемый аргумент baz
src / unused_code.lua: 4: 8: неиспользуемая переменная цикла i
src / unused_code.lua: 5:13: неиспользуемая переменная q
src / unused_code.lua: 7: 11: неиспользуемая переменная цикла a
src / unused_code.lua: 7: 14: неиспользуемая переменная цикла b
src / unused_code.lua: 7: 17: неиспользуемая переменная цикла c
src / unused_code.lua: 13: 7: значение, присвоенное переменной x, не используется
src / unused_code.lua: 14: 1: значение, присвоенное переменной x, не используется
src / unused_code.lua: 22: 1: значение, присвоенное переменной z, не используется
Итого: 14 предупреждений / 1 ошибка в 4 файлах
Луачек завершается с 0, если не было предупреждений или ошибок, и с положительным числом
в противном случае.
Command линия опционы
Короткие варианты, не принимающие аргументов, можно объединить в один, чтобы -qqu is
что эквивалентно -q -q -u. Для длинных вариантов оба —вариант ценностное or —option = значение может быть
используемый.
Опции, принимающие несколько аргументов, могут использоваться несколько раз; — игнорировать Foo — игнорировать бар is
что эквивалентно — игнорировать Foo бар.
Обратите внимание, что параметры, которые могут принимать несколько аргументов, например —globals, не следует использовать
непосредственно перед позиционными аргументами; данный —globals Foo бар файл.lua, Луачек будем
рассмотреть все Foo, бар и файл.lua global, а затем паникуйте, так как не осталось имен файлов.
┌──────────────────────────────────┬──────────────── ───────────────────
│Опция │ Значение │
├──────────────────────────────────┼──────────────── ───────────────────
│-g | — не глобальный │ Отфильтровать предупреждения, связанные с │
│ │ глобальные переменные. │
├──────────────────────────────────┼──────────────── ───────────────────
│-u | —не неиспользованный │ Отфильтровать предупреждения, связанные с │
│ │ неиспользуемые переменные и значения. │
├──────────────────────────────────┼──────────────── ───────────────────
│-r | — не переопределено │ Отфильтровать предупреждения, связанные с │
│ │ переопределенные переменные. │
├──────────────────────────────────┼──────────────── ───────────────────
│-a | —нет-неиспользуемых-аргументов │ Отфильтровать предупреждения, связанные с │
│ │ неиспользуемые аргументы и цикл │
│ │ переменные. │
├──────────────────────────────────┼──────────────── ───────────────────
│-s | —no-unused-secondary │ Отфильтровать предупреждения, связанные с │
│ │ набор неиспользуемых переменных │
│ │ с бывшими в употреблении. │
│ │ │
│ │ См. Вторичные значения и переменные │
├──────────────────────────────────┼──────────────── ───────────────────
│— без себя │ Отфильтровать предупреждения, связанные с │
│ │ неявный себя аргумент. │
└───────────────────────────────────┴──────────────── ────────────────────┘
│—стд │ Установить стандартные глобалы. может │
│ │ быть одним из: │
│ │ │
│ │ · _G — глобалы Lua │
│ │ переводчик Луачек │
│ │ работает (по умолчанию); │
│ │ │
│ │ · луа51 — глобалы Lua │
│ │ 5.1; │
│ │ │
│ │ · луа52 — глобалы Lua │
│ │ 5.2; │
│ │ │
│ │ · луа52с — глобалы Lua │
│ │ 5.2 скомпилирован с │
│ │ LUA_COMPAT_ALL; │
│ │ │
│ │ · луа53 — глобалы Lua │
│ │ 5.3; │
│ │ │
│ │ · луа53с — глобалы Lua │
│ │ 5.3 скомпилирован с │
│ │ LUA_COMPAT_5_2; │
│ │ │
│ │ · луахит — глобалы │
│ │ LuaJIT 2.0; │
│ │ │
│ │ · ngx_lua — глобалы │
│ │ Открытость │
│ │
lua-nginx-модуль
с │
│ │ LuaJIT 2.0; │
│ │ │
│ │ · мин — пересечение │
│ │ глобалы Lua 5.1, Lua │
│ │ 5.2 и LuaJIT 2.0; │
│ │ │
│ │ · Макс — объединение глобалов │
│ Lua 5.1, Lua 5.2 и │
│ │ LuaJIT 2.0; │
│ │ │
│ │ · разоренный — добавлены глобалы │
│ │ пользователя Busted 2.0; │
│ │ │
│ │ · никто — нет стандарта │
│ │ глобальные. │
│ │ │
│ │ См.
Наборы of стандарт
│
│ │
глобальные
│
├──────────────────────────────────┼──────────────── ───────────────────
│—globals [ ] … │ Добавить пользовательские глобалы поверх │
│ │ стандартные. │
├──────────────────────────────────┼──────────────── ───────────────────
│—read-globals [ ] … │ Добавить глобальные объекты только для чтения. │
├──────────────────────────────────┼──────────────── ───────────────────
│—new-globals [ ] … │ Установите собственные глобальные объекты. Удаляет │
│ │ пользовательские глобалы добавлены ранее. │
├──────────────────────────────────┼──────────────── ───────────────────
│—new-read-globals [ ] │ Настроить глобальные переменные только для чтения. Удаляет │
│… │ добавлены глобальные переменные только для чтения │
│ │ ранее. │
├──────────────────────────────────┼──────────────── ───────────────────
│-c | —compat │ Эквивалентно —стд Макс. │
└───────────────────────────────────┴──────────────── ────────────────────┘
│-d | — разрешено │ Разрешить определение глобальных объектов │
│ │ неявно, установив их. │
│ │ │
│ │ См. Неявно определенные глобальные переменные │
├──────────────────────────────────┼──────────────── ───────────────────
│-t | —allow-defined-top │ Разрешить определение глобальных объектов │
│ │ неявно, установив их в │
│ │ область верхнего уровня. │
│ │ │
│ │ См. Неявно определенные глобальные переменные │
├──────────────────────────────────┼──────────────── ───────────────────
│-m | —модуль │ Ограничить видимость неявно │
│ │ определили глобальные объекты в свои файлы. │
│ │ │
│ │ См. Модули │
├──────────────────────────────────┼──────────────── ───────────────────
│— игнорировать | -i [ ] │ Отфильтровать совпадения предупреждений │
│… │ узоры. │
├──────────────────────────────────┼──────────────── ───────────────────
│—включить | -e [ ] │ Не отсеивать предупреждения │
│… │ соответствие шаблонов. │
├──────────────────────────────────┼──────────────── ───────────────────
│—Только | -o [ ] … │ Отфильтровать несоответствующие предупреждения │
│ │ узоры. │
├──────────────────────────────────┼──────────────── ───────────────────
│— не встраиваемый │ Отключить встроенные параметры. │
├──────────────────────────────────┼──────────────── ───────────────────
│—config │ Путь к пользовательской конфигурации │
│ │ файл (по умолчанию: .luacheckrc). │
├──────────────────────────────────┼──────────────── ───────────────────
│—no-config │ Не ищите обычай │
│ │ файл конфигурации. │
├──────────────────────────────────┼──────────────── ───────────────────
│—имя файла │ Используйте в выводе другое имя файла, │
│ │ для выбора конфигурации │
│ │ отменяет и для файла │
│ │ фильтрация. │
├──────────────────────────────────┼──────────────── ───────────────────
│—exclude-файлы [ ] │ Не проверять соответствие файлов │
│… │ эти шаблоны сглаживания. │
│ │ Рекурсивные глобусы, такие как ** / *. lua │
│ │ поддерживаются. │
├──────────────────────────────────┼──────────────── ───────────────────
│—include-файлы [ ] │ Не проверять файлы, не совпадающие │
│… │ эти шаблоны сглаживания. │
├──────────────────────────────────┼──────────────── ───────────────────
│—кэш [ ] │ Путь к файлу кеша. (по умолчанию: │
│ │ .luacheckcache). Увидеть
Кэширование
│
├──────────────────────────────────┼──────────────── ───────────────────
│—без кеша │ Не использовать кеш. │
├──────────────────────────────────┼──────────────── ───────────────────
│-j | —работа │ Проверить файлы параллельно. │
│ │ Требуется
ЛуаЛанес
. │
└───────────────────────────────────┴──────────────── ────────────────────┘
│— форматтер │ Используйте настраиваемое средство форматирования. │
│ │ должен быть модулем │
│ │ имя или одно из: │
│ │ │
│ │ · Давл. — Тестировать что угодно │
│ │ Форматировщик протокола; │
│ │ │
│ │ · JUnit — JUnit XML │
│ │ форматировщик; │
│ │ │
│ │ · простой — простой │
│ │ предупреждение по строке │
│ │ форматировщик; │
│ │ │
│ │ · по умолчанию — стандарт │
│ │ форматировщик. │
├──────────────────────────────────┼──────────────── ───────────────────
│-q | —тихий │ Запретить вывод отчетов для файлов │
│ │ без предупреждений. │
│ │ │
│ │ · -qq — Подавить вывод │
│ │ предупреждений. │
│ │ │
│ │ · -qqq — Только выход │
│ │ резюме. │
├──────────────────────────────────┼──────────────── ───────────────────
│—коды │ Показать коды предупреждений. │
├──────────────────────────────────┼──────────────── ───────────────────
│— апельсины │ Показать диапазоны связанных столбцов │
│ │ к предупреждениям. │
├──────────────────────────────────┼──────────────── ───────────────────
│— бесцветный │ Не раскрашивайте вывод. │
├──────────────────────────────────┼──────────────── ───────────────────
│-v | —версия │ Показать версию Луачека и его │
│ │ зависимости и выход. │
├──────────────────────────────────┼──────────────── ───────────────────
│-h | —Помогите │ Показать справку и выйти. │
└───────────────────────────────────┴──────────────── ────────────────────┘
Шаблоны
Параметры интерфейса командной строки — игнорировать, —включить и —Только и соответствующие параметры конфигурации позволяют фильтровать
предупреждения, использующие сопоставление шаблонов с кодами предупреждений, именами переменных или и тем, и другим. Если узор
содержит косую черту, часть перед косой чертой соответствует коду предупреждения, а часть после соответствует
имя переменной. В противном случае, если шаблон содержит букву или подчеркивание, он соответствует
имя переменной. В противном случае он соответствует коду предупреждения. Например:
┌────────┬────────────────────────────────────┐
│Шаблон │ Соответствующие предупреждения │
├────────┼────────────────────────────────────
│4.2 │ Затенение деклараций │
│ │ аргументы или переосмысление их. │
├────────┼────────────────────────────────────
│. * _ │ Предупреждения, связанные с переменными │
│ │ с _ суффикс. │
├────────┼────────────────────────────────────
│4.2 /.*_ │ Затенение деклараций │
│ │ аргументы с _ суффикс или │
│ │ переосмысливая их. │
└────────┴────────────────────────────────────
Если еще не было привязано, шаблоны, соответствующие именам переменных, привязаны к обеим сторонам и
шаблоны, совпадающие с кодами предупреждений, привязаны к их началу. Это позволяет
фильтровать предупреждения по категориям (например, —Только 1 фокусируется Луачек о глобальных предупреждениях).
Наборы of стандарт глобальные
Опция CLI —stds позволяет комбинировать описанные выше встроенные наборы с помощью +, Например,
—стд Макс эквивалентна —std = lua51 + lua52 + lua53. Ведущий знак плюса добавляет новые наборы в
по умолчанию вместо его замены. Например, —стд + разорено подходит для проверки
тестовые файлы, которые используют
Разоренный
фреймворк для тестирования. Пользовательские наборы глобалов могут быть определены с помощью
мутирующая глобальная переменная стандартные стандарты в конфиге. См. Custom_stds
Форматировщики
Опция CLI — форматтер позволяет выбрать настраиваемый модуль форматирования для Луачек выход. Обычай
formatter — это модуль Lua, возвращающий функцию с тремя аргументами: отчет, возвращенный
Луачек модуль (см. отчет), массив имен файлов и таблица опций. Параметры содержат
значения, присвоенные тихий, цвет, предел, Коды, диапазоны и форматировщик опции в CLI или
config. Функция форматирования должна возвращать строку.
Кэширование
Если LuaFileSystem доступна, Луачек может кэшировать результаты проверки файлов. На последующих
проверок, перепроверяются только те файлы, которые были изменены с момента последней проверки, что улучшает
время работы значительно. Изменение параметров (например, определение дополнительных глобальных объектов) не
сделать кеш недействительным. Кеширование можно включить с помощью —кэш Вариант или кэш конфиг
вариант. С использованием —кэш без аргументов или постановки кэш параметр конфигурации для правда Наборы
.luacheckcache как файл кеша. Обратите внимание, что —кэш должен использоваться каждый раз Луачек is
запускать, а не только при первом запуске.
Стабильный интерфейс для редактор плагины и инструменты
Интерфейс командной строки Luacheck может меняться между второстепенными выпусками. Начиная с 0.11.0
версии, следующий интерфейс гарантирован как минимум до версии 1.0.0 и должен быть
используется инструментами, использующими вывод Luacheck, например, плагинами редактора.
· Luacheck следует запускать из каталога, в котором находится проверенный файл.
· Файл можно передать через стандартный ввод, используя — в качестве аргумента или используя временный файл. Настоящий
имя файла должно быть передано с использованием —имя файла опцию.
· Следует использовать обычный форматтер. Он выводит по одной проблеме (предупреждению или ошибке) в каждой строке.
· Чтобы получить точное местоположение ошибки, — апельсины вариант можно использовать. Каждая строка начинается с настоящего
имя файла (передается с использованием —имя файла), с последующим : : — :,
в котором номер строки, в которой возникла проблема, и — is
включая диапазон столбцов токена, относящихся к выпуску. Нумерация начинается с 1. Если
— апельсины не используется, конечный столбец и тире не печатаются.
· Чтобы получить коды предупреждений и ошибок, —коды вариант можно использовать. Для каждой строки подстрока
в круглых скобках содержится трехзначный код выпуска с префиксом E на ошибки и W
для предупреждений. Отсутствие такой подстроки указывает на фатальную ошибку (например, ошибку ввода-вывода).
· Остальная часть строки — это предупреждающее сообщение.
Если требуется совместимость со старой версией Luacheck, вывод Луачек —Помогите может быть
привык получать свою версию. Если он содержит строку 0. ., Где Я сидел
минимум 11 и заплата — любое число, следует использовать описанный выше интерфейс.
КОНФИГУРАЦИЯ ФАЙЛОВ
Луачек пытается загрузить конфигурацию из .luacheckrc файл в текущем каталоге. Если
не найден, он будет искать его в родительском каталоге и так далее, пока он
достигает корня файловой системы. Путь к конфигурации можно указать с помощью —config вариант, и в этом случае
он будет использоваться во время рекурсивной загрузки. Загрузку конфигурации можно отключить с помощью —no-config
флаг.
Config — это просто сценарий Lua, выполняемый Луачек. Он может устанавливать различные параметры
присваивая глобальные переменные или возвращая таблицу с именами опций в качестве ключей.
Конфиг опционы
┌────────────────────┬───────────────────────────┬── ───────────────────
│Опция │ Тип │ Значение по умолчанию │
├───────────────────┼───────────────────────────── ───────────────────
│цвет │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│Коды │ Логическое │ ложный │
└────────────────────┴───────────────────────────┴── ────────────────────┘
│форматировщик │ Строка или функция │ «По умолчанию» │
├───────────────────┼───────────────────────────── ───────────────────
│кэш │ Логическое или строковое │ ложный │
├───────────────────┼───────────────────────────── ───────────────────
│работы │ Положительное целое число │ 1 │
├───────────────────┼───────────────────────────── ───────────────────
│exclude_files │ Массив строк │ {} │
├───────────────────┼───────────────────────────── ───────────────────
│include_files │ Массив строк │ (Включить все файлы) │
├───────────────────┼───────────────────────────── ───────────────────
│Глобальный │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│неиспользованный │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│Redefined │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│неиспользуемые_аргументы │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│неиспользуемые_вторичные │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│себя │ Логическое │ правда │
├───────────────────┼───────────────────────────── ───────────────────
│станд │ Строка или набор │ «_ГРАММ» │
│ │ стандартные глобалы │ │
├───────────────────┼───────────────────────────── ───────────────────
│глобальные │ Массив строк │ {} │
├───────────────────┼───────────────────────────── ───────────────────
│new_globals │ Массив строк │ (Не перезаписывать) │
├───────────────────┼───────────────────────────── ───────────────────
│read_globals │ Массив строк │ {} │
├───────────────────┼───────────────────────────── ───────────────────
│new_read_globals │ Массив строк │ (Не перезаписывать) │
├───────────────────┼───────────────────────────── ───────────────────
│Compat │ Логическое │ ложный │
├───────────────────┼───────────────────────────── ───────────────────
│allow_defined │ Логическое │ ложный │
├───────────────────┼───────────────────────────── ───────────────────
│allow_defined_top │ Логическое │ ложный │
├───────────────────┼───────────────────────────── ───────────────────
│модуль │ Логическое │ ложный │
├───────────────────┼───────────────────────────── ───────────────────
│игнорировать │ Массив паттернов (см. │ {} │
│ │ узоры) │ │
├───────────────────┼───────────────────────────── ───────────────────
│включить │ Массив паттернов │ {} │
├───────────────────┼───────────────────────────── ───────────────────
│только │ Массив паттернов │ (Не фильтровать) │
├───────────────────┼───────────────────────────── ───────────────────
│встроенный │ Логическое │ правда │
└────────────────────┴───────────────────────────┴── ────────────────────┘
Пример конфига, который делает Луачек убедитесь, что только глобальные переменные с переносного
используется пересечение Lua 5.1, Lua 5.2, Lua 5.3 и LuaJIT 2.0, а также отключает
обнаружение неиспользуемых аргументов:
std = «мин»
ignore = {«212»}
На заказ Наборы of глобальные
станд опция позволяет установить собственный стандартный набор глобалов с помощью таблицы. В этой таблице
Строковые ключи являются глобальными, а строка в части массива — глобальными только для чтения.
Кроме того, пользовательским наборам можно присвоить имена, изменив глобальные стандартные стандарты Переменная. Для
например, при использовании
LPEG
библиотека, имеет смысл кратко получить доступ к ее функциям, используя
глобалы. В этом случае следующая конфигурация позволяет убрать ложные срабатывания, связанные с
глобальный доступ легко:
stds.lpeg = требуется «lpeg»
local lpeg = требуется «lpeg»
локальная функция parse1 (…)
— Эта функция использует только функции lpeg как глобальные.
локальный _ENV = lpeg
— luacheck: std lpeg
местная цифра, пробел = R «09», S «»
— …
конец
локальная функция parse2 (…)
— Эта функция использует функции lpeg, а также стандартные глобальные переменные.
local _ENV = setmetatable ({}, {__index = function (_, k) return _ENV [k] or lpeg [k] end})
— luacheck: std + lpeg
местная цифра, пробел = R «09», S «»
местный номер = C (цифра ^ 1) / номер
— …
конец
Пофайловый и на путь переопределения
Среда, в которой Луачек загружает конфиг, содержащий специальный глобальный файлов. Когда
проверка файла , Луачек переопределит параметры из основной конфигурации с записями
от файлы [ ] и файлы [ ], сначала применяя записи для более коротких путей. Для
Например, следующая конфигурация повторно включает обнаружение неиспользуемых аргументов только для файлов в
src / dir, но не для SRC / каталог / myfile.lua, и позволяет использовать
Разоренный
глобалы внутри спецификации /:
std = «мин»
ignore = {«212»}
файлы [«src / dir»] = {enable = {«212»}}
файлы [«src / dir / myfile.lua»] = {ignore = {«212»}}
файлы [«spec»] = {std = «+ busted»}
Обратите внимание, что файлов table поддерживает автовивификацию, так что
файлы [«myfile.lua»]. ignore = {«212»}
и
файлы [«myfile.lua»] = {ignore = {«212»}}
эквивалентны.
В ЛИНИЮ ОПЦИИ
Луачек поддерживает установку некоторых параметров непосредственно в проверенных файлах с помощью встроенного
комментарии к конфигурации. Встроенный комментарий конфигурации начинается с Луачек: этикетка,
возможно, после некоторого пробела. Текст комментария должен содержать разделенные запятыми.
options, где вызов опции состоит из ее имени и аргументов, разделенных пробелами. В
поддерживаются следующие варианты:
┌───────────────────┬─────────────────────────────── ─────┐
│Опция │ Количество аргументов │
├────────────────────┼────────────────────────────── ─────┤
│глобальный │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│ неиспользованный │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│переопределен │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│ неиспользуемые аргументы │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│ неиспользованные вторичные обмотки │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│ себя │ 0 │
└────────────────────┴────────────────────────────── ─────┘
│compat │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│модуль │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│ разрешено 0 │
├────────────────────┼────────────────────────────── ─────┤
│ разрешить определенный верх │ 0 │
├────────────────────┼────────────────────────────── ─────┤
│стд │ 1 │
├────────────────────┼────────────────────────────── ─────┤
│глобальные │ 0+ │
├────────────────────┼────────────────────────────── ─────┤
│новые глобалы │ 0+ │
├────────────────────┼────────────────────────────── ─────┤
│ читать глобалы │ 0+ │
├────────────────────┼────────────────────────────── ─────┤
│новые читаемые глобалы │ 0+ │
├────────────────────┼────────────────────────────── ─────┤
│ игнорировать │ 0+ (без аргументов все
│ │ игнорируется) │
├────────────────────┼────────────────────────────── ─────┤
│ включить │ 1+ │
├────────────────────┼────────────────────────────── ─────┤
│только │ 1+ │
└────────────────────┴────────────────────────────── ─────┘
Опции, которые не принимают аргументов, могут иметь префикс нет чтобы перевернуть их смысл. Например
—луачек: нет неиспользованный арг отключает предупреждения о неиспользуемых аргументах.
Часть файла, на которую влияет встроенный параметр, зависит от того, где он размещен. Если есть
код в строке с опцией затрагивается только эта строка; в противном случае все до
конец текущего закрытия. В частности, встроенные параметры в верхней части файла
повлиять на все это:
— luacheck: globals g1 g2, игнорировать foo
local foo = g1 (g2) — предупреждений не генерируется.
— О следующей неиспользованной функции не сообщается.
локальная функция f () — luacheck: игнорировать
— луачек: глобалы g3
g3 () — Без предупреждения.
конец
g3 () — выдается предупреждение, поскольку встроенная опция, определяющая g3, затрагивает только функцию f.
Для детального контроля над видимостью встроенных параметров используйте Луачек: толкать и Луачек:
поп директивы:
— luacheck: нажать ignore foo
foo () — Без предупреждения.
— луачек: поп
foo () — выдается предупреждение.
Встроенные параметры можно полностью отключить с помощью — не встраиваемый Опция CLI или встроенный конфиг
опцию.
ЛУАЧЕК МОДУЛЬ
Используйте локальным Луачек = требовать «Луачек» импортировать Луачек модуль. Он содержит
следующие функции:
· luacheck.get_report (источник): Данная исходная строка возвращает данные анализа (таблицу).
· luacheck.process_reports (отчеты, опции): Обрабатывает массив аналитических отчетов и
применяет параметры. отчеты [i] использования опционы, варианты [i], варианты [i] [1], варианты [i] [2]…
как опции, перекрывая друг друга в указанном порядке. Таблица опций представляет собой таблицу с полями
аналогично параметрам конфигурации; посмотреть варианты. Отчеты об анализе с полем роковой игнорируются.
process_reports возвращает окончательный отчет, см.
Report формат
.
· luacheck.check_strings (источники, опции): Проверяет массив источников с помощью опций, возвращает
заключительный отчет. Таблицы с полем роковой в источников массив игнорируются.
· luacheck.check_files (файлы, опции): Проверяет массив файлов с помощью опций, возвращает окончательный
отчет. Вместо имен файлов можно передавать дескрипторы открытых файлов, и в этом случае они будут
читать до EOF и закрывать.
· luacheck.get_message (проблема): Возвращает строковое сообщение о проблеме, см.
Report формат
.
luacheck._VERSION содержит версию Луачека в виде строки в БОЛЬШОЙ.МАЛЫЙ.ПАТЧ формат.
. Луачек как функция эквивалентна вызову luacheck.check_files.
Report формат
Итоговый отчет — это массив файловых отчетов плюс поля. предупреждение, Ошибки и фатальный
содержащее общее количество предупреждений, ошибок и фатальных ошибок соответственно.
Файловый отчет — это набор проблем (предупреждений или ошибок). Если фатальная ошибка произошла во время
проверяя файл, его отчет будет иметь роковой поле, содержащее тип ошибки.
Проблема — таблица с полем код с указанием его типа (см. предупреждение) и поля линия,
обзор и end_column указывая на источник предупреждения. имя поле может содержать имя
связанной переменной. Задачи некоторых типов также могут иметь дополнительные поля:
┌──────┬────────────────────────────────────
│Коды │ Дополнительные поля │
├──────┼────────────────────────────────────
│011 │ MSG поле содержит синтаксическую ошибку │
│ │ сообщение. │
├──────┼────────────────────────────────────
│111 │ модуль поле указывает, что │
│ │ присваивается немодуль │
│ │ глобальная переменная. │
├──────┼────────────────────────────────────
│211 │ FUNC поле указывает, что неиспользуемые │
│ │ переменная — это функция. │
├──────┼────────────────────────────────────
│4 .. │ пред_строка и пред_столбец поля │
│ │ содержат расположение │
│ │ перезаписанное определение. │
└──────┴────────────────────────────────────
Другие поля могут присутствовать по внутренним причинам.
Это документация для версии 0.13.0
Луачек
, линтер для
Lua
.
Используйте luacheck в Интернете с помощью сервисов onworks.net
Lua online compiler
Write, Run & Share Lua code online using OneCompiler’s Lua online compiler for free. It’s one of the robust, feature-rich online compilers for Lua language, running the latest Lua version 5.3. Getting started with the OneCompiler’s Lua editor is easy and fast. The editor shows sample boilerplate code when you choose language as Lua and start coding.
Taking inputs (stdin)
OneCompiler’s Lua online editor supports stdin and users can give inputs to programs using the STDIN textbox under the I/O tab. Following is a sample Lua program which takes name as input and prints hello message with your name.
name = io.read("*a")
print ("Hello ", name)About Lua
Lua is a light weight embeddable scripting language which is built on top of C. It is used in almost all kind of applications like games, web applications, mobile applications, image processing etc. It’s a very powerful, fast, easy to learn, open-source scripting language.
Syntax help
Variables
- By default all the variables declared are global variables
- If the variables are explicitly mentioned as local then they are local variables.
- Lua is a dynamically typed language and hence only the values will have types not the variables.
Examples
-- global variables
a = 10
-- local variables
local x = 30| Value Type | Description |
|---|---|
| number | Represents numbers |
| string | Represents text |
| nil | Differentiates values whether it has data or not |
| boolean | Value can be either true or false |
| function | Represents a sub-routine |
| userdata | Represents arbitary C data |
| thread | Represents independent threads of execution. |
| table | Can hold any value except nil |
Loops
1. While:
While is also used to iterate a set of statements based on a condition. Usually while is preferred when number of iterations are not known in advance.
while(condition)
do
--code
end2. Repeat-Until:
Repeat-Until is also used to iterate a set of statements based on a condition. It is very similar to Do-While, it is mostly used when you need to execute the statements atleast once.
repeat
--code
until( condition )3. For:
For loop is used to iterate a set of statements based on a condition.
for init,max/min value, increment
do
--code
endFunctions
Function is a sub-routine which contains set of statements. Usually functions are written when multiple calls are required to same set of statements which increase re-usuability and modularity.
optional_function_scope function function_name( argument1, argument2, argument3........, argumentn)
--code
return params with comma seperated
end