Skip to content

Commit f6dffd2

Browse files
scr-oathscr-oath
committed
Added README.
1 parent 2d4d685 commit f6dffd2

4 files changed

Lines changed: 60 additions & 32 deletions

File tree

‎log/README.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,31 @@ info:set_output("STDOUT") -- to STDOUT
7878
info:set_output("-") -- to STDOUT
7979
info:set_output("STDERR") -- to STDERR
8080
```
81+
82+
# loglevel - usage similar to slf4j
83+
84+
```lua
85+
local log = require 'loglevel'
86+
log.set_default_output('some-file-on-disk') -- defaults to "STDOUT"
87+
88+
-- Logs go to /dev/null
89+
log.DEBUG:print('foobar')
90+
log.DEBUG:printf('foo bar %s', 'baz')
91+
92+
-- Logs go to some-file-on-disk (the default_output setting)
93+
log.set_level('DEBUG') -- defaults to "INFO"
94+
log.DEBUG:print('foobar')
95+
log.DEBUG:printf('foo bar %s', 'baz')
96+
97+
-- Other loggers
98+
log.DEBUG:print('debug')
99+
log.INFO:print('info')
100+
log.WARN:print('warn')
101+
log.ERROR:print('error')
102+
103+
-- Log levels
104+
log.set_level('DEBUG')
105+
log.set_level('INFO')
106+
log.set_level('WARN')
107+
log.set_level('ERROR')
108+
```

‎log/loglevel.lua‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,58 @@ local log = require 'log'
44
local loglevel = {
55
levels = { DEBUG = 0, INFO = 1, WARN = 2, ERROR = 3 },
66
defaultOutput = 'STDERR',
7-
level = 'INFO',
7+
_level = 'INFO',
88
}
99
setmetatable(loglevel, {
1010
__index = log
1111
})
1212

13-
-- Gets the output for the given level as compared to the loglevel.level
14-
local function outputForLevel(level)
13+
-- Gets the output for the given level as compared to the loglevel._level
14+
local function output_for_level(level)
1515
level = string.upper(level)
1616
local level_value = loglevel.levels[level]
1717
if not level_value then
1818
error('Illegal level ' + level)
1919
end
20-
local current_level_value = loglevel.levels[loglevel.level]
20+
local current_level_value = loglevel.levels[loglevel._level]
2121
local output = (current_level_value <= level_value) and loglevel.defaultOutput or '/dev/null'
2222
return output
2323
end
2424

2525
-- Attach the logs to the loglevel object
2626
for level in pairs(loglevel.levels) do
27-
local output = outputForLevel(level)
27+
local output = output_for_level(level)
2828
loglevel[level] = log.new(output)
2929
loglevel[level]:set_prefix(string.format('[%s] ', level))
3030
loglevel[level]:set_flags { date = true }
3131
end
3232

3333
-- Returns the current level
34-
function loglevel.Level()
35-
return loglevel.level
34+
function loglevel.get_level()
35+
return loglevel._level
3636
end
3737

3838
-- Sets the level and adjusts all logs to either squelch or go to the defaultOutput
39-
function loglevel.SetLevel(new_level)
39+
function loglevel.set_level(new_level)
4040
new_level = string.upper(new_level)
4141
local new_level_value = loglevel.levels[new_level]
4242
if not new_level_value then
4343
error('Illegal level ' + new_level)
4444
end
45-
loglevel.level = new_level
45+
loglevel._level = new_level
4646
for level in pairs(loglevel.levels) do
47-
local output = outputForLevel(level)
47+
local output = output_for_level(level)
4848
loglevel[level]:set_output(output)
4949
end
5050
end
5151

5252
-- Gets the default output
53-
function loglevel.DefaultOutput()
53+
function loglevel.default_output()
5454
return loglevel.defaultOutput
5555
end
5656

5757
-- Set the default output
58-
function loglevel.SetDefaultOutput(output)
58+
function loglevel.set_default_output(output)
5959
loglevel.defaultOutput = output
6060
end
6161

‎log/lua_const.go‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// GENERATED BY textFileToGoConst
22
// GitHub: github.com/logrusorgru/textFileToGoConst
33
// input file: loglevel.lua
4-
// generated: Thu Nov 17 09:46:24 PST 2022
4+
// generated: Thu Nov 17 09:49:22 PST 2022
55

66
package log
77

@@ -11,58 +11,58 @@ const lua_loglevel = `local log = require 'log'
1111
local loglevel = {
1212
levels = { DEBUG = 0, INFO = 1, WARN = 2, ERROR = 3 },
1313
defaultOutput = 'STDERR',
14-
level = 'INFO',
14+
_level = 'INFO',
1515
}
1616
setmetatable(loglevel, {
1717
__index = log
1818
})
1919
20-
-- Gets the output for the given level as compared to the loglevel.level
21-
local function outputForLevel(level)
20+
-- Gets the output for the given level as compared to the loglevel._level
21+
local function output_for_level(level)
2222
level = string.upper(level)
2323
local level_value = loglevel.levels[level]
2424
if not level_value then
2525
error('Illegal level ' + level)
2626
end
27-
local current_level_value = loglevel.levels[loglevel.level]
27+
local current_level_value = loglevel.levels[loglevel._level]
2828
local output = (current_level_value <= level_value) and loglevel.defaultOutput or '/dev/null'
2929
return output
3030
end
3131
3232
-- Attach the logs to the loglevel object
3333
for level in pairs(loglevel.levels) do
34-
local output = outputForLevel(level)
34+
local output = output_for_level(level)
3535
loglevel[level] = log.new(output)
3636
loglevel[level]:set_prefix(string.format('[%s] ', level))
3737
loglevel[level]:set_flags { date = true }
3838
end
3939
4040
-- Returns the current level
41-
function loglevel.Level()
42-
return loglevel.level
41+
function loglevel.get_level()
42+
return loglevel._level
4343
end
4444
4545
-- Sets the level and adjusts all logs to either squelch or go to the defaultOutput
46-
function loglevel.SetLevel(new_level)
46+
function loglevel.set_level(new_level)
4747
new_level = string.upper(new_level)
4848
local new_level_value = loglevel.levels[new_level]
4949
if not new_level_value then
5050
error('Illegal level ' + new_level)
5151
end
52-
loglevel.level = new_level
52+
loglevel._level = new_level
5353
for level in pairs(loglevel.levels) do
54-
local output = outputForLevel(level)
54+
local output = output_for_level(level)
5555
loglevel[level]:set_output(output)
5656
end
5757
end
5858
5959
-- Gets the default output
60-
function loglevel.DefaultOutput()
60+
function loglevel.default_output()
6161
return loglevel.defaultOutput
6262
end
6363
6464
-- Set the default output
65-
function loglevel.SetDefaultOutput(output)
65+
function loglevel.set_default_output(output)
6666
loglevel.defaultOutput = output
6767
end
6868

‎log/test/test_loglevel.lua‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ local LogLevelSuite = suite.Suite:new {
1111
function LogLevelSuite:SetupTest()
1212
self.temp_dir = self:T():TempDir()
1313
self.output = filepath.join(self.temp_dir, 'test.output')
14-
log.SetDefaultOutput(self.output)
15-
log.SetLevel('INFO')
14+
log.set_default_output(self.output)
15+
log.set_level('INFO')
1616
end
1717

1818
function LogLevelSuite:TearDownTest()
19-
log.SetDefaultOutput('STDERR')
20-
log.SetLevel('INFO')
19+
log.set_default_output('STDERR')
20+
log.set_level('INFO')
2121
end
2222

2323
function LogLevelSuite:getOutput()
@@ -43,15 +43,15 @@ function LogLevelSuite:TestDebugNoContent()
4343
end
4444

4545
function LogLevelSuite:TestDebugWithDebugSetHasContent()
46-
log.SetLevel('DEBUG')
46+
log.set_level('DEBUG')
4747
log.DEBUG:print('foobar')
4848
local got, err = self:getOutput()
4949
assert(not err, err)
5050
assert(got ~= "", got)
5151
end
5252

5353
function LogLevelSuite:TestInfoHasContent()
54-
log.SetLevel('INFO')
54+
log.set_level('INFO')
5555
log.INFO:print('foobar')
5656
local got, err = self:getOutput()
5757
assert(not err, err)
@@ -66,7 +66,7 @@ function LogLevelSuite:TestErrorHasContent()
6666
end
6767

6868
function LogLevelSuite:TestBogusLogLevelHasError()
69-
local ok, err = pcall(log.SetLevel, 'DJFDJFDJFJF')
69+
local ok, err = pcall(log.set_level, 'DJFDJFDJFJF')
7070
assert(not ok)
7171
assert(err)
7272
end

0 commit comments

Comments
 (0)