[Guide] Linting lua and json files to spot missed errors

[aubergine18]

I've been looking through the sources of several mods to get a feel for how the modding system works and what can be done with it... I had "linting" tools installed on my text editor which highlighted numerous issues. Seems most modders aren't linting their code. *sad face*

Here's how I get my files linted, using ST3:

1. Install SublimeText 3

It has unlimited free demo (but buy it if you think it's awesome to help support the devs): ST3 Beta (currently in beta, but already better than v2)

2. Install Package Control

A free package manager addon for SublimeText: Package Control

3. Install Sublime Linter

This is an open source generic linting framework for Sublime Text - it provides a consistent UI for multiple linting tools (eg. for Javascript, Lua, JSON, Ruby, etc). Get it here.

4. Install Lua

• Windows installer
• Mac OS X: Install homebrew (a package manager) first, then in a terminal window do

  Code: Select all

  brew install lua

  to install it
• Linux binaries, etc.

5. Install linters

• Lua: requires `luacheck`= read install instructions!!
• JSON

6. Stop it moaning about inbuilt globals

The linter doesn't know about the globals that Factorio defines, but you can teach it with an inline comment at the start of your lua script file. For example to tell it about `defines`, `game`, `global` and `script`, use:

Code: Select all

--luacheck: globals defines game global script

Depending on which file you're editing, you might want to add other globals such as `data` or `recipes` etc.

Don't add custom globals though, you should be defining them as locals (actually improves performance in some cases, and just good practice to get in to). Yes, even functions `local function foo() ...`.

That's it - when you start editing you'll see errors quickly reported as you type

Useful ST3 packages

• Highlight trailing spaces
• Detect weird whitespace (eg. non-printing chars)
• Better open/closing bracket highlighter
• GitHub integration

[Helfima]

I prefere Eclipse IDE

1) download eclipse
https://eclipse.org/downloads/eclipse-packages/ choose "Eclipse IDE for Java EE Developers"

2) install plugin lua
launch eclipse
open Help/Install new software
add Work with http://download.eclipse.org/ldt/releases/milestones/
select lua developement tools and lua developement tools SDK
use next and accept if necessary

3) Make a project
File/New/Lua project

4) Use comment
With comment Eclipse can build Outline with fonction name and args
It s very nice to check fonction argument and find it quickly

5) add mod in factorio
Open CMD Dos in folder factorio MOD
Make a junction with your MOD

Code: Select all

mklink /J helmod_0.2.11 C:\Users\Helfima\workspace\helmod\src

scrren eclipse

2016-09-11_151050.png (109.19 KiB) Viewed 3140 times

[aubergine18]

Another alternative is the free open source ZeroBrane IDE for Lua - it has inbuilt static analysis of some kind which should provide similar linting functionality to luacheck:

https://studio.zerobrane.com/features

[aubergine18]

bumping, still seeing lots of people not using proper editors and running in to basic syntax errors as a result.

[apriori]

bumping, still seeing lots of people not using proper editors and running in to basic syntax errors as a result.

Hmm... I just use npp... If there's any editor/IDE that can help me in looking through "classes" (fields and methods) - tell me please.