home \| news \| discuss \| issues \| license LURE: STYLE
¶ tim@menzies.us August'17 Why \| Install \| What \| Guide \| Style If you are reading my code, it will save you time to know how I write my Lua. Execution Always use `luajit` (it is faster). In the shell environment, always have `$Lure` set to the LURE directory: `Lure=PathtoLureDir` Always have data files in `$Lure/data'. Always have `LUA_PATH` set to include the LURE directory. For example, your run command might be: `LUA_PATH="$Lure/lib/?.lua;;" $(which luajit) file.l` Formatting Indents = 2 spaces (no tabs). Short variable names; e.g. not `self` but `i`. Join all lines that are only `end`. For example: `local function map(t,f) if t then for i,v in pairs(t) do f(v) end end end` Module names should be upper case (that's my goal, and that convention is sweeping out through my code). E.g. `local CSV = require "csv"` Test suites The file `X.lua` may have demo code in `Xok.lua`. Use `random.lua` not the built-in random number generator since mine ins platform independent (same numbers, different platforms-- better for writing unit tests). Documentation Add documents to enable `locco`-style documentation `./locco.lua yourCode.lua -- generates docs/yourCode.html` Some rules: No file called `index.lua` (messes up my documentation system) Html written to lib/docs Your `.gitignore` should ignore `docs` folder. Separate functions with lines: `function love() talk() if laugh() then return smile() end end -------------------------- function hate() fight() steal() return 1 end` Directories All files in the same directory. All data in "/data" underneath some path name mentioned on `os.getenv("Lure")`.` Printing All files use `require "show"` which changes the default version of `print` and `tostring`. Note that to hide a field from being printed (e.g. since it is too long), make its first letter an underscore. Encapsulation Module-based polytheism Modules usually have `create` `update` `updates` Module names are UPPER CASE Most functions and variables are local Modules end by returning a table of functions Temptations (to avoid) No use of meta tables (that way, madness lies). No OO tricks: So many ways to do it in Lua... I found that I never stop experimenting. And people hate my OO code: so many levels of redirection. So I took the hint. Keep in simple. Or risk consuing people. Configuration Global configuration options stored in `config` and reset to defaults using `defaults()` (which are stored in the global `the`). So a standard experiment starts with require "show" local R=require "random" local O=require "tests" local XX=require "moduleURtesting" local function _test1() defaults() -- set the defaults the.this.that = 10 -- override a default do something with XX assert(something) end local function _anotherTest() defaults() -- set the defaults the.this.that = 4321 -- override a default do something else with XXX assert(something) end R.seed(1) -- set the random seed O.k{_test1,_anotherTest} -- counts assertion failures, continue even if 1 crashes	require "show"
¶ Legal LURE, Copyright (c) 2017, Tim Menzies All rights reserved, BSD 3-Clause License Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

home | news | discuss | issues | license

LURE: STYLE

tim@menzies.us
August'17

Why | Install | What | Guide | Style

If you are reading my code, it will save you time to know how I write my Lua.

Execution

Always use luajit (it is faster).

In the shell environment, always have $Lure set to the LURE directory:

  Lure=PathtoLureDir

Always have data files in `$Lure/data'.

Always have LUA_PATH set to include the LURE directory. For example, your run command might be:

  LUA_PATH="$Lure/lib/?.lua;;" $(which luajit) file.l

Formatting

Indents = 2 spaces (no tabs).

Short variable names; e.g. not self but i.

Join all lines that are only end. For example:

local function map(t,f)
  if t then
    for i,v in pairs(t) do f(v) end end end

Module names should be upper case (that's my goal, and that convention is sweeping out through my code). E.g.

local CSV = require "csv"

Test suites

The file X.lua may have demo code in Xok.lua.

Use random.lua not the built-in random number generator since mine ins platform independent (same numbers, different platforms-- better for writing unit tests).

Documentation

Add documents to enable locco-style documentation

 ./locco.lua yourCode.lua -- generates docs/yourCode.html

Some rules:

No file called index.lua (messes up my documentation system)
Html written to lib/docs
Your .gitignore should ignore docs folder.

Separate functions with lines:

 function love()
   talk()
   if laugh() then
     return smile() end end
 --------------------------
 function hate()
   fight()
   steal()
   return 1 end

Directories

All files in the same directory.

All data in "/data" underneath some path name mentioned on os.getenv("Lure").`

Printing

All files use require "show" which changes the default version of print and tostring. Note that to hide a field from being printed (e.g. since it is too long), make its first letter an underscore.

Encapsulation

Module-based polytheism

Modules usually have create update updates
Module names are UPPER CASE
Most functions and variables are local
Modules end by returning a table of functions

Temptations (to avoid)

No use of meta tables (that way, madness lies).

No OO tricks:

So many ways to do it in Lua... I found that I never stop experimenting.
And people hate my OO code: so many levels of redirection. So I took the hint. Keep in simple. Or risk consuing people.

Configuration

Global configuration options stored in config and reset to defaults using defaults() (which are stored in the global the). So a standard experiment starts with

require "show"
local R=require "random"
local O=require "tests"
local XX=require "moduleURtesting"

local function _test1()
  defaults() -- set the defaults
  the.this.that = 10 -- override a default
  do something with XX
  assert(something)
end 

local function _anotherTest()
  defaults() -- set the defaults
  the.this.that = 4321 -- override a default
  do something else with XXX
  assert(something)
end 

R.seed(1) -- set the random seed
O.k{_test1,_anotherTest} -- counts assertion failures, continue even if 1 crashes

require "show"

Legal

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.