Arma Reforger:Script Editor: Basic Code Formatter Plugin - Revision history

Lou Montana: Fix

2025-03-03T16:18:03Z

Fix

← Older revision		Revision as of 18:18, 3 March 2025
Line 77:		Line 77:

	protected ScriptInvokerVoid Event_OnSomething;		protected ScriptInvokerVoid Event_OnSomething;
	protected static string ~~m_sValue3~~;		protected static string m_sValue;

	// must fix the separator (below)		// must fix the separator (below)

Lou Montana: Add spellcheck warning

2024-09-16T10:36:05Z

Add spellcheck warning

← Older revision		Revision as of 12:36, 16 September 2024
Line 62:		Line 62:
	* a forgotten {{hl\|Print()}} call (a Print/PrintFormat without log level is considered a temporary debug one)		* a forgotten {{hl\|Print()}} call (a Print/PrintFormat without log level is considered a temporary debug one)
	* non-tag-prefixed classes/enums (e.g {{hl\|EMyEnum}} vs {{hl\|TAG_EMyEnum}})		* non-tag-prefixed classes/enums (e.g {{hl\|EMyEnum}} vs {{hl\|TAG_EMyEnum}})
			* ''some'' spelling mistakes in comments (e.g "solider", "overriden", "dammage"...)

Lou Montana: Fix classes

2024-09-09T10:31:34Z

Fix classes

Lou Montana: Fix example (w/ non-breakable space Alt+255)

2024-02-18T17:35:48Z

Fix example (w/ non-breakable space Alt+255)

← Older revision		Revision as of 19:35, 18 February 2024
Line 70:		Line 70:
	! After		! After
	\|-		\|-
	\| <enforce noGuess>		\| <enforce noGuess noTrim>
	class abc:Managed // must warn for non-prefixed class + must space around ':'		class abc:Managed // must warn for non-prefixed class + must space around ':'
	{		{
Line 87:		Line 87:

	// must remove trailing empty space (below)		// must remove trailing empty space (below)
	}		}
	// must remove the final semicolon below		// must remove the final semicolon below
	};		};

Lou Montana: Add features

2024-02-15T11:39:43Z

Add features

← Older revision		Revision as of 13:39, 15 February 2024
Line 1:		Line 1:
			{{Infobox/WorkbenchPlugin
			\|name= Basic Code Formatter
			\|editor= script
			\|descr= A plugin to help formatting code and following {{Link\|Arma Reforger:Scripting: Conventions\|conventions}} and {{Link\|Arma Reforger:Scripting: Best Practices\|good practices}}
			\|shortcut= <nowiki/>
			* {{Controls\|Ctrl\|Shift\|K}}
			* {{Controls\|Ctrl\|Alt\|Shift\|K}} (forced)
			\|file= {{Link\|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_ScriptTemplatePlugin.c}}
			}}
	'''Basic Code Formatter''' is a plugin that helps formatting code to {{Name\|bi}} standards as well as warns for bad practice.		'''Basic Code Formatter''' is a plugin that helps formatting code to {{Name\|bi}} standards as well as warns for bad practice.

Line 21:		Line 30:

	{{Feature\|informative\|{{Controls\|Ctrl\|Alt\|Shift\|K}} can be used to force formatting of all the current file's lines.}}		{{Feature\|informative\|{{Controls\|Ctrl\|Alt\|Shift\|K}} can be used to force formatting of all the current file's lines.}}


			== Features ==

			=== Modification ===

			It can:
			* trim line ends (trailing spaces and tabs)
			* fix indentation (turn four spaces into a tab, remove extra spaces)
			* auto-format method separators - all it takes is <enforce inline>//---</enforce> three dashes
			* do general formatting:
			** remove semicolons {{hl\|;}} after a class-closing bracket
			** {{hl\|if(}} / {{hl\|while(}} / {{hl\|foreach(}}, etc
			** double spaces, double semicolons, capital NULL, etc<br>{{Feature\|informative\|See <enforce inline>SCR_BasicCodeFormatter.GeneralFormatting()</enforce>.}}
			* add a final line return to the file

			{{Feature\|informative\|The plugin does not format comment or string content.}}

			=== Warnings ===

			It warns about:
			* wrong syntax (e.g {{hl\|new ref}})
			* improvable syntax (e.g {{hl\|array<string> strings {{=}} new array<string>();}} can be reduced to {{hl\|array<string> strings {{=}} {};}})
			* multiple empty lines
			* usage of the {{hl\|{{Link\|Arma Reforger:Scripting: Keywords#auto\|auto}}}} and {{hl\|{{Link\|Arma Reforger:Scripting: Keywords#autoptr\|autoptr}}}} keywords
			* divisions that could be multiplications (e.g {{hl\|value / 2}} is {{hl\|value * 0.5}}), as multiplications are usually cheaper in term of CPU
			* unbracketed loops ({{hl\|if}}, {{hl\|for}}, {{hl\|foreach}}, {{hl\|while}})
			* {{hl\|if}} one-liners - always put the "then" part on a new line
			* badly named variables and constants (e.g {{hl\|string m_iValue}} where the prefix for string is s - see {{Link\|Arma Reforger:Scripting: Values#String\|Values - String}})
			* {{Link/Enfusion\|armaR\|ScriptInvoker}} direct usage (see {{Link\|Arma Reforger:ScriptInvoker Usage}})
			* a forgotten {{hl\|Print()}} call (a Print without log level is considered a temporary debug one)
			* non-tag-prefixed classes/enums (e.g {{hl\|EMyEnum}} vs {{hl\|TAG_EMyEnum}})

Lou Montana: Fix category

2024-02-13T14:26:57Z

Fix category

← Older revision		Revision as of 16:26, 13 February 2024
Line 89:		Line 89:


	{{GameCategory\|armaR\|Modding~~\|Tutorials~~\|Official Tools\|Script Editor Plugins}}		{{GameCategory\|armaR\|Modding\|Official Tools\|Script Editor Plugins}}

Lou Montana: Lou Montana moved page Arma Reforger:Script Editor: Basic Code Formatter Plugin Tutorial to Arma Reforger:Script Editor: Basic Code Formatter Plugin without leaving a redirect: Name standard

2024-02-13T14:26:42Z

Lou Montana moved page Arma Reforger:Script Editor: Basic Code Formatter Plugin Tutorial to Arma Reforger:Script Editor: Basic Code Formatter Plugin without leaving a redirect: Name standard

← Older revision	Revision as of 16:26, 13 February 2024
(No difference)

Lou Montana: Page creation

2024-02-13T14:26:26Z

Page creation

New page

'''Basic Code Formatter''' is a plugin that helps formatting code to {{Name|bi}} standards as well as warns for bad practice.

It features:
{{Columns|2|
* General space formatting
* Line end trimming
* Indentation fix from spaces to tabs
* Method separator fix
* Auto line end at the end of the file
* Scripting prefix check
* Batch processing (all addon scripts at once)
* The option to only formats modified lines (if using SVN/Git)
* Bad practice warnings
* A demo mode to practice in read-only.
}}

== Usage ==

It is triggered by {{Controls|Ctrl|Shift|K}}; depending on the selected options, it will either process the current file or the selected addon's files.

{{Feature|informative|{{Controls|Ctrl|Alt|Shift|K}} can be used to force formatting of all the current file's lines.}}

== Example ==

{| class="wikitable valign-top"
! Before
! After
|-
| <enforce noGuess>
class abc:Managed // must warn for non-prefixed class + must space around ':'
{
[Attribute()]; // must remove the semicolon

protected ScriptInvokerVoid Event_OnSomething;
protected static string m_sValue3;

// must fix the separator (below)
//---
protected void Method()
{ // must replace 5 spaces by one tab
if(true ) return; // must reformat the if and warn about one-liner
// must warn about two empty lines (below)

// must remove trailing empty space (below)
}
// must remove the final semicolon below
};
// must add a line return (below)
</enforce>
| <enforce noGuess noTrim>
class abc : Managed // must warn for non-prefixed class + must space around ':'
{
[Attribute()] // must remove the semicolon

protected ScriptInvokerVoid Event_OnSomething;
protected static string m_sValue;

// must fix the separator (below)
//------------------------------------------------------------------------------------------------
protected void Method()
{ // must replace 5 spaces by one tab
if (true) return; // must reformat the if and warn about one-liner
// must warn about two empty lines (below)

// must remove trailing empty space (below)
}
// must remove the final semicolon below
}
// must add a line return (below)

</enforce>
|-
! colspan="2" | Changelog
|-
| colspan="2" |
<pre style="font-size: .9em">
SCRIPT : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SCRIPT : SCR_BasicCodeFormatterPluginExample.c - 7 lines changed, 1× line trimming, 1× indent fix(es) at line(s) 11, 5 formattings, 1 end spaces trimming, 1 4-spaces indent -> tabs replaced, 1 space(s) in indentation removed, 1 method separators fixed, added final newline (read: 3 ms, format: 83 ms, diff: 81 ms - total: 167 ms)
SCRIPT : Checking all 20 lines (100% of the file)
SCRIPT : 1× multiple consecutive empty lines found at line(s) 14 - leave only one
SCRIPT : 2× badly-named variables found at line(s) 5-6 - use proper prefixes: m_s for ResourceName/string, m_v for vectors, NO m_p, CASED_CONSTS, etc
SCRIPT : 1× non-prefixed class/enum found at line(s) 1 - classes and enums should be prefixed; see the settings to setup accepted prefixes (current SCR_)
</pre>
|}

{{GameCategory|armaR|Modding|Tutorials|Official Tools|Script Editor Plugins}}

← Older revision		Revision as of 12:31, 9 September 2024
Line 6:		Line 6:
	* {{Controls\|Ctrl\|Shift\|K}}		* {{Controls\|Ctrl\|Shift\|K}}
	* {{Controls\|Ctrl\|Alt\|Shift\|K}} (forced)		* {{Controls\|Ctrl\|Alt\|Shift\|K}} (forced)
	\|file= {{Link\|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/~~SCR_ScriptTemplatePlugin~~.c}}		\|file= {{Link\|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
	}}		}}
	'''Basic Code Formatter''' is a plugin that helps formatting code to {{Name\|bi}} standards as well as warns for bad practice.		'''Basic Code Formatter''' is a plugin that helps formatting code to {{Name\|bi}} standards as well as warns for bad practice.
Line 43:		Line 43:
	** remove semicolons {{hl\|;}} after a class-closing bracket		** remove semicolons {{hl\|;}} after a class-closing bracket
	** {{hl\|if(}} / {{hl\|while(}} / {{hl\|foreach(}}, etc		** {{hl\|if(}} / {{hl\|while(}} / {{hl\|foreach(}}, etc
	** double spaces, double semicolons, capital NULL, etc<br>{{Feature\|informative\|See <enforce inline>~~SCR_BasicCodeFormatter~~.GeneralFormatting()</enforce>.}}		** double spaces, double semicolons, capital NULL, etc<br>{{Feature\|informative\|See <enforce inline>SCR_BasicCodeFormatterPlugin.GeneralFormatting()</enforce>.}}
	* add a final line return to the file		* add a final line return to the file

Line 60:		Line 60:
	* badly named variables and constants (e.g {{hl\|string m_iValue}} where the prefix for string is s - see {{Link\|Arma Reforger:Scripting: Values#String\|Values - String}})		* badly named variables and constants (e.g {{hl\|string m_iValue}} where the prefix for string is s - see {{Link\|Arma Reforger:Scripting: Values#String\|Values - String}})
	* {{Link/Enfusion\|armaR\|ScriptInvoker}} direct usage (see {{Link\|Arma Reforger:ScriptInvoker Usage}})		* {{Link/Enfusion\|armaR\|ScriptInvoker}} direct usage (see {{Link\|Arma Reforger:ScriptInvoker Usage}})
	* a forgotten {{hl\|Print()}} call (a Print without log level is considered a temporary debug one)		* a forgotten {{hl\|Print()}} call (a Print/PrintFormat without log level is considered a temporary debug one)
	* non-tag-prefixed classes/enums (e.g {{hl\|EMyEnum}} vs {{hl\|TAG_EMyEnum}})		* non-tag-prefixed classes/enums (e.g {{hl\|EMyEnum}} vs {{hl\|TAG_EMyEnum}})