Banri: Created page with "{{documentation}} This module is deprecated in favour of using `mw.logObject(obj)`, but is still provided as an alternative. {{Helper module |name = Logger |fname1..."

2021-03-24T01:57:50Z

Created page with "{{documentation}} This module is deprecated in favour of using <code>mw.logObject(obj)</code>, but is still provided as an alternative. {{Helper module |name = Logger |fname1..."

New page

{{documentation}}
This module is deprecated in favour of using <code>mw.logObject(obj)</code>, but is still provided as an alternative.
{{Helper module
|name = Logger

|fname1 = log(table)
|ftype1 = table
|fuse1 = '''Deprecated:''' use<code>mw.logObject(obj)</code> instead.

Logs the contents of the table to the console (does not expand subtables).

Notes:
* Assumes all table indices can be represented as strings - using functions or tables as indices will result in non-specific log entries
* This is best used by adding <code>p.logger = require('Module:Logger')</code> to the top of the module, then calling <code>p.logger.log(obj)</code> in the debug console on the module page
* This module will only print to the debug console - it has no use when used outside of the development environment and should be removed/commented out before saving

|fname2 = deep_log(table)
|ftype2 = table
|fuse2 = '''Deprecated:''' use<code>mw.logObject(obj)</code> instead.

Logs the contents of the table to the console, expanding subtables. See above notes.

|fname3 = dumpObject(table, options)
|ftype3 = table, table/nil
|fuse3 = Modified version of mw.dumpObject. Default values of the options are:

* <code>clean</code> = <samp>false</samp>;     Removes the <code>table#n</code> and expands all tables even if the same table appears multiple times. The output is safe to load again by lua without further processing. Does not work for circular dependencies.
* <code>indentSize</code> = 2;     Number of spaces/tabs to add for each indent level.
* <code>useTabs</code> = <samp>false</samp>;     Use tabs to indent instead of spaces.
* <code>tabSize</code> = 4;     Used to calculate the collapseLimit.
* <code>collapseLimit</code> = 0;     Maximum length for collapsing a table onto a single line.
* <code>collapseArrays</code> = <samp>true</samp>;     Allow arrays to collapse onto a single line.
* <code>wrapLongArrays</code> = <samp>false</samp>;     Keep arrays collapsed and simply continue on a new line if the current line is longer then <samp>collapseLimit</samp>.
* <code>collapseObjects</code> = <samp>true</samp>;     Allow key-value pairs to collapse onto a single line.
* <code>addEqualSignSpaces</code> = <samp>false</samp>;     Add spaces around equal signes when the table is collapsed. Non collapsed table always have spaces.
* <code>addBracketSpaces</code> = <samp>true</samp>;     Add spaces between the brackets and the data for collapsed tables i.e. <code>{ 'data' }</code>.
* <code>numberPrecision</code> = <samp>-1</samp>;     Number of decimals. Trailing zeros are trimmed. Negative numbers means let lua decide.

|fname4 = logObject(table, options)
|ftype4 = table, table/nil
|fuse4 = Uses dumpObject and prints its result to the console.

|fname5 = logCleanTable(table, options)
|ftype5 = table, table/nil
|fuse5 = Uses dumpObject and prints its results to the console but has the following default options changed:

* <code>clean</code> = <samp>true</samp>
* <code>indentSize</code> = 4
* <code>collapseLimit</code> = 100
* <code>collapseArrays</code> = <samp>true</samp>
* <code>collapseObjects</code> = <samp>true</samp>

|example =
<syntaxhighlight lang='lua'>
local logger = require('Module:Logger')

local t1 = { 1, 2, 3, 4 }
local t2 = { 1, 2, 3, a='a' }
local t3 = { a='a', b='b' }
local t4 = { a=t1, b=t1, t2, t3 }
local t5 = { 1, 2, 3, '4444444444444444444444444444444444444444444444444444444444444444444444444444444444444444444' }
local t6 = { '1', '2', a={'12'} }

mw.log( p.dumpObject(t1) )
logger.logCleanTable(t2)
logger.logCleanTable(t3)
logger.logCleanTable(t4, { collapseLimit=60 })
logger.logCleanTable(t5)
logger.logObject(t6)
-- table#1 (#=4, n=4) {
-- 1,
-- 2,
-- 3,
-- 4,
-- }
-- { 1, 2, 3, a="a" }
-- { a="a", b="b" }
-- {
-- { 1, 2, 3, a="a" },
-- { a="a", b="b" },
-- a = { 1, 2, 3, 4 },
-- b = { 1, 2, 3, 4 },
-- }
-- {
-- 1,
-- 2,
-- 3,
-- "4444444444444444444444444444444444444444444444444444444444444444444444444444444444444444444",
-- }
-- table#1 (#=2, n=3) {
-- "1",
-- "2",
-- ["a"] = table#2 (#=1, n=1) {
-- "12",
-- },
-- }
</syntaxhighlight>
}}

Module:Logger/doc - Revision history

Banri: Created page with "{{documentation}} This module is deprecated in favour of using mw.logObject(obj), but is still provided as an alternative. {{Helper module |name = Logger |fname1..."

Banri: Created page with "{{documentation}} This module is deprecated in favour of using `mw.logObject(obj)`, but is still provided as an alternative. {{Helper module |name = Logger |fname1..."