Difference between revisions of "Module:No globals/doc"

From Northumberland Climbing
Jump to navigation Jump to search
module>QueerEcofeminist
m (Reverted 3 edits by 174.252.201.231 (talk) to last revision by Tomybrz. (TW))
 
m (1 revision imported)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{module rating|release}}{{module rating|protected}}
+
{{high-use|13,053,000+|all-pages = yes}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+
{{used in system}}
{{Shared Template Warning|Module:No globals|No globals}}
+
{{module rating|protected}}
 +
<!-- Template categories go at the bottom of this page. -->
  
== Usage ==
+
This module causes an error if any nil [[global variable|global]] is read or if any global is written to, with the exception of <var>arg</var>. To use, add <syntaxhighlight lang="lua" inline>require('Module:No globals')</syntaxhighlight> to the top of the module using it. The <var>arg</var> variable is excluded because it is necessary for Scribunto's [[mw:Extension:Scribunto/Lua reference manual#require|require]] function to work properly. (See the Scribunto source code [[phab:diffusion/ELUA/browse/master/includes/engines/LuaCommon/lualib/package.lua;1fad4da13706f4dbdd0477a834675b9d09757bf6|here]].)
Include this module at the top of your code. An error will be raised any time your code tries to read or write to a non-local (undeclared) variable.
 
  
== Tests ==
+
== See also ==
{| class=wikitable
+
* [[Module:Log globals]] – adds all nil global reads/writes to the lua log
| [[Module:No globals]] || {{#invoke:No globals/testcases|run|displayMode=short}}
 
|-
 
| [[Module:No globals/sandbox]] || {{#invoke:No globals/testcases|run||displayMode=short|module=No globals/sandbox}}
 
|}
 
* See [[Module:No globals/testcases|testcases]]
 
* [https://www.mediawiki.org/w/index.php?title=Special%3AComparePages&page1=Module%3ANo%20globals&page2=Module%3ANo%20globals%2Fsandbox Diff] sandbox code
 
 
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
  
 +
<includeonly>{{Sandbox other||
 +
<!-- Template categories go here. -->
 +
[[Category:Lua metamodules]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 05:51, 31 July 2020

This module causes an error if any nil global is read or if any global is written to, with the exception of arg. To use, add require('Module:No globals') to the top of the module using it. The arg variable is excluded because it is necessary for Scribunto's require function to work properly. (See the Scribunto source code here.)

See also[edit]