Module:Sandbox/Aidan9382/CodeAnalysis/doc - Revision history

Aidan9382: dont generate a category for this

2023-10-30T07:37:29Z

dont generate a category for this

← Previous revision		Revision as of 07:37, 30 October 2023
Line 1:		Line 1:
	{{Module rating\|beta}}		{{Module rating\|beta\|nocat=true}}

	This function provides basic analysis of module code, pointing out any unused variables or unexpected globals. Note that just because this module points out certain behaviour does not neccessarily mean the behaviour is wrong nor needs correcting, but is rather a guide.		This function provides basic analysis of module code, pointing out any unused variables or unexpected globals. Note that just because this module points out certain behaviour does not neccessarily mean the behaviour is wrong nor needs correcting, but is rather a guide.

Aidan9382: changes

2023-05-13T09:18:12Z

changes

← Previous revision		Revision as of 09:18, 13 May 2023
Line 7:		Line 7:
	== Usage ==		== Usage ==

	This module can be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis")()</syntaxhighlight> ~~(The module entry point can be accessed directly without calling it via <code>.run</code>)~~. The module will then log any behaviour it notices. The function can be provided an argument to specify a target page other than the current ~~page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted~~ page.		This module can be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis").run()</syntaxhighlight>. The module will then log any behaviour it notices. The function can be provided a string argument to specify a target page other than the current page.

	This module can also be used via templates using <code>#invoke:</code>, like the following: <syntaxhighlight lang=wikitext inline>{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main}}</syntaxhighlight>. The module will then produce a wikitable of anything it notes within the code. An argument can be provided to the first positional parameter to specify a certain page to analyse.		This module can also be used via templates using <code>#invoke:</code>, like the following: <syntaxhighlight lang=wikitext inline>{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main}}</syntaxhighlight>. The module will then produce a wikitable of anything it notes within the code. An argument can be provided to the first positional parameter to specify a certain page to analyse.

Aidan9382: clarification

2023-05-12T12:30:04Z

clarification

← Previous revision		Revision as of 12:30, 12 May 2023
Line 1:		Line 1:
	{{Module rating\|beta}}		{{Module rating\|beta}}

	This function provides basic analysis of module code, pointing out any unused variables or unexpected globals.		This function provides basic analysis of module code, pointing out any unused variables or unexpected globals. Note that just because this module points out certain behaviour does not neccessarily mean the behaviour is wrong nor needs correcting, but is rather a guide.

	The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.		The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.

Aidan9382: +test

2023-05-12T12:05:34Z

+test

← Previous revision		Revision as of 12:05, 12 May 2023
Line 15:		Line 15:

	{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main\|Module:Wikitext Parsing}}		{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main\|Module:Wikitext Parsing}}

			{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main\|Module:Banner shell}}

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Aidan9382: notes

2023-05-12T11:41:36Z

notes

← Previous revision		Revision as of 11:41, 12 May 2023
Line 7:		Line 7:
	== Usage ==		== Usage ==

	This module can be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis")~~.run~~()</syntaxhighlight>. The module will then log any behaviour it notices. The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.		This module can be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis")()</syntaxhighlight> (The module entry point can be accessed directly without calling it via <code>.run</code>). The module will then log any behaviour it notices. The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.

	This module can also be used via templates using <code>#invoke:</code>, like the following: <syntaxhighlight lang=wikitext inline>{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main}}</syntaxhighlight>. The module will then produce a wikitable of anything it notes within the code. An argument can be provided to the first positional parameter to specify a certain page to analyse.		This module can also be used via templates using <code>#invoke:</code>, like the following: <syntaxhighlight lang=wikitext inline>{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main}}</syntaxhighlight>. The module will then produce a wikitable of anything it notes within the code. An argument can be provided to the first positional parameter to specify a certain page to analyse.

Aidan9382: update for template entry point

2023-05-12T11:36:32Z

update for template entry point

← Previous revision		Revision as of 11:36, 12 May 2023
Line 1:		Line 1:
	{{Module rating\|beta}}		{{Module rating\|beta}}

			This function provides basic analysis of module code, pointing out any unused variables or unexpected globals.
⚫	== Usage ==

		⚫	The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.
⚫	This module ~~is to~~ be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis").run()</syntaxhighlight>. The module will then ~~note~~ any ~~unused~~ ~~locals~~ or ~~any~~ ~~global~~ ~~references.~~ ~~<!--More~~ to ~~come~~ ~~soon?~~ ~~who~~ ~~knows-->~~

		⚫	== Usage ==
	The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.

		⚫	This module can be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis").run()</syntaxhighlight>. The module will then log any behaviour it notices. The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.
⚫	The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.

			This module can also be used via templates using <code>#invoke:</code>, like the following: <syntaxhighlight lang=wikitext inline>{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main}}</syntaxhighlight>. The module will then produce a wikitable of anything it notes within the code. An argument can be provided to the first positional parameter to specify a certain page to analyse.

	== Examples ==		== Examples ==

Aidan9382: no prefix, duh

2023-05-12T11:19:21Z

no prefix, duh

← Previous revision		Revision as of 11:19, 12 May 2023
Line 10:		Line 10:

	== Examples ==		== Examples ==
	{{#invoke~~:Module~~:Sandbox/Aidan9382/CodeAnalysis\|main}}		{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main}}

	{{#invoke~~:Module~~:Sandbox/Aidan9382/CodeAnalysis\|main\|Module:Wikitext Parsing}}		{{#invoke:Sandbox/Aidan9382/CodeAnalysis\|main\|Module:Wikitext Parsing}}

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Aidan9382: testing invoke stuff (ignore the errors emitting for now)

2023-05-12T11:18:59Z

testing invoke stuff (ignore the errors emitting for now)

← Previous revision		Revision as of 11:18, 12 May 2023
Line 1:		Line 1:
	{{Module rating\|beta}}		{{Module rating\|beta}}

			== Usage ==
⚫	This module is to be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis")()</syntaxhighlight>. The module will then note any unused locals or any global references. <!--More to come soon? who knows-->

		⚫	This module is to be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis").run()</syntaxhighlight>. The module will then note any unused locals or any global references. <!--More to come soon? who knows-->

	The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.		The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.

	The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.		The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.

			== Examples ==
			{{#invoke:Module:Sandbox/Aidan9382/CodeAnalysis\|main}}

			{{#invoke:Module:Sandbox/Aidan9382/CodeAnalysis\|main\|Module:Wikitext Parsing}}

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Aidan9382: Initial docs

2023-05-12T11:03:10Z

Initial docs

New page

{{Module rating|beta}}

This module is to be required and used from the Debug console, like the following: <syntaxhighlight lang=lua inline>require("Module:Sandbox/Aidan9382/CodeAnalysis")()</syntaxhighlight>. The module will then note any unused locals or any global references. 

The function can be provided an argument to specify a target page other than the current page. Valid inputs are the name of the wanted page as a string, or the mw.title object of the wanted page.

The code of this is mostly lifted from https://github.com/9382/Dump/tree/main/LuaObfuscator, which in turn lifts a lot of code from https://github.com/stravant/LuaMinify.

<includeonly>{{Sandbox other||


}}</includeonly>