olivine-labs/lua-style-guide

Olivine Labs Lua Style Guide

lua-style-guide's Issues

Function in table constructor conflicts with earlier example

-- good
local me = {
fullname = function(self)
return self.first_name + " " + self.last_name
end
}

Smalls Functions Are Good For The Universe link is dead

In the functions section, the link mentioned, doesn't open.

Create a lint tool?

Could Lustache be used to create a linter based on your style guide?

Linter

Does this styleguide work against any Lua-based Linting software out there?

Storing anything in index 0 does not effect the length operator.

-- nils don't count
local list = {}
list[0] = nil
list[1] = "item"

print(#list) -- 0
print(select('#', list)) -- 1

Naming Inconsistencies

In the function section, you advocate function syntax over variable syntax. You name the "bad" function "yup" and the "good" function "nope". It's difficult to know which style you prefer because of the misleading naming.

In the naming convention section, you advocate the use underscores for ignored variables. Both code snippets are labeled as "good" despite one using "k, v in pairs()"

Sections 'Accessors' and 'Constructors' do not exist

They are in the ToC but the links lead nowhere

Whitespace after opening and before closing brackets not respected

Use one space after commas.
...
--good
local thing = {1, 2, 3}

invisible empty line in code box makes 'bad' and 'good' undistinguishable

In Olivine-Labs/lua-style-guide#whitespace, in item

Place an empty newline at the end of the file.

The fenced code box for good does not show the newline. I don't know if this could be fixed, I didn't find a use case for that in the documentation.

variadic arguments

Lua does not have autmagic arg-s anymore. What is your favorite style for functions that take variadic arguments? Using local arg = {...}, select(), both?