Dev environment

Contributors to this project use a variety of IDEs for writing code.

VSCode is the most used, but Intellij, and atom are also represented.

For VSCode the following extensions are recommended: LuaCoderAssist, Factorio Lua API autocomplete. Bracket Pair Colorizer and GitLens are nice additions as well.

For settings:

{
    "search.showLineNumbers": true,
    "files.associations": {
        ".luacheckrc": "lua"
    },
    "files.eol": "\n",
    "files.insertFinalNewline": true,
    "files.trimTrailingWhitespace": true,
    "files.trimFinalNewlines": true,
    "LuaCoderAssist.luacheck.fileSizeLimit": 1000,
    "LuaCoderAssist.format.lineWidth": 300,
    "LuaCoderAssist.luaparse.luaversion": 5.2,
    "LuaCoderAssist.metric.enable": false,
    "LuaCoderAssist.luacheck.keepAfterClosed": false,
    "LuaCoderAssist.ldoc.authorInFunctionLevel": false,
    "LuaCoderAssist.luacheck.automaticOption": false,
    "bracketPairColorizer.showBracketsInGutter": true,
    "bracketPairColorizer.showBracketsInRuler": true,
}

For IDEs compatible with .editorconfig the following is recommended:

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# Matches multiple files with brace expansion notation
# Set default charset
[*.lua]
charset = utf-8
indent_style = space
indent_size = 4