-
Notifications
You must be signed in to change notification settings - Fork 5
Settings
Juan José Longoria edited this page Oct 11, 2021
·
2 revisions
Aura Helper has to many settings to configure to many Aura Helper features, commands and tools like Apex formatter or Compress Sort Order among others. All settings are grouped in Apex Format, Api, IntelliSense - Auto Completion, Documentation and Metadata:
Section to group all Apex Format settings to configure the format style, Aura Helper has to many options. You can find all options into extension settings and are grouped into Class Members, Comments, Operators, Puntuation and Queries:
Format options for Apex Class and Interfaces Members. Find on: **Aurahelper > Apex Format > Class Members > [option]**
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| New Lines Between Class Fields | Number |
Add the specified new lines between class fields or constants. | 0 |
| New Lines Between Code Blocke Members | Number |
Add the specified new lines between method, enums, inner classes, properties or other code block declaration on classes and interfaces. | 1 |
| New Lines Between Getter And Setter Accessor | Number |
Add the specified new lines between getter and setter accessor on properties declaration. | 1 |
| Single Line Properties | Boolean |
Keep property's getter and setter on a single line when getter and setter has no body. | true |
Format options for Apex Comments. Find on: **Aurahelper > Apex Format > Comment > [option]**
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Hold After Whitespaces On Line Comment | Boolean |
Keep the after whitespaces when end comments if have any code. | false |
| Hold Before Whitespaces On Line Comment | Boolean |
Keep the before whitespaces when start comments if not are on new line. | false |
| New Lines Bewteen Comments | Number |
New lines between comments when have more than one comment block followed. Only apply if the comments are in different lines previous format. | 0 |
Format options for Apex Code Operators. Find on: **Aurahelper > Apex Format > Operator > [option]**
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Add Whitespace After Open Parenthesis Operator | Boolean |
Add a white space after ( priority operator | false |
| Add Whitespace After Operator | Boolean |
Add a white space after any arithmetic, logic, assignment or bitwise operator. | true |
| Add Whitespace Before Close Parenthesis Operator | Boolean |
Add a white space before ) priority operator. | false |
| Add Whitespace Before Operator | Boolean |
Add a white space before any arithmetic, logic, assignment or bitwise operators. | true |
Format options for Apex Code Puntuation, New Lines and Symbols like brackets. Find on: **Aurahelper > Apex Format > Puntuation > [option]**
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Add Whitespace After Close Curly Bracket | Boolean |
Add white space after { symbol if 'Add New Line After Close Curly Bracket' is set to false | true |
| Add White Space After Comma | Boolean |
Add a white space after , symbol | true |
| Add Whitespace After Open Guard Parenthesis | Boolean |
Add a white space after ( symbol for flow control structures (if, else if, for, foreach, while, do...while, catch) | false |
| Add Whitespace Before Close Guard Parenthesis | Boolean |
Add a white space before ( symbol for flow control structures (if, else if, for, foreach, while, do...while, catch) | true |
| Add Whitespace Before Open Curly Bracket | Boolean |
Add a white space before { symbol (Not affect to List, Set or Map explicit value declaration). Only apply if Open Curly Bracket On New Line is set to false | true |
| Add Whitespace Before Open Guard Parenthesis | Boolean |
Add a white space before ( symbol for flow control structures (if, else if, for, foreach, while, do...while, catch) | true |
| Add Whitespace Before Open Trigger Events | Boolean |
Add a white space before ( symbol on trigger events declaration | true |
| Max Blank Lines | Number |
Number of the maximum blank lines, -1 for keep the code blank lines | 5 |
| Open Curly Bracket On New Line | Boolean |
Add the { symbol on a new line (Not affect to List, Set or Map explicit value declaration). | false |
Format options for SOQL Queries. Find on: **Aurahelper > Apex Format > Query > [option]**
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Max Projection Field Per Line | Number |
Set the maximum projection fields per line. 0 to put all fields on the same line | 8 |
| One Clause Per Line | Boolean |
Set every query clause on a new line | true |
Section to group all Aura Helper API Settings.
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Use Aura Helper CLI | Boolean |
Use Aura Helper CLI to execute some processes (Recommended to PCs with low resources). If not selected, all operation will be executed into VSCode context (faster but need more resources). | false |
Section to group all IntelliSense settings (the most of these settings are grouped on Auto Completion group, but will be changed in next version to IntelliSense)
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Active Apex Comment Suggestion | Boolean |
Use Code Suggestion and autocompletion tools for create a method or class comment on Apex. | true |
| Active Apex Suggestion | Boolean |
Use Code Suggestion and autocompletion tools for Apex Code (variables, fields, methods...). | true |
| Active Attribute Suggest | Boolean |
Use Code Suggestion and autocompletion tools for component attributes (v.). |
true |
| Active Component Call Suggest | Boolean |
Use Code Suggestion and autocompletion tools for show available attributes for standard components when are called. | true |
| Active Controller Functions Suggest | Boolean |
Use Code Suggestion and autocompletion tools for JavaScript Controller Functions (c.). |
true |
| Active Custom Component Call Suggest | Boolean |
Use Code Suggestion and autocompletion tools for show available attributes for custom components when are called. | true |
| Active Helper Functions Suggest | Boolean |
Use Code Suggestion and autocompletion tools for JavaScript Helper Functions (helper.). |
true |
| Active Query Suggestion | Boolean |
Use Code Suggestion and autocompletion tools on queries. | true |
| Active Sobject Fields Suggestion | Boolean |
Use Code Suggestion and autocompletion tools for the fields of an SObject. | true |
| Active SObject Suggestion | Boolean |
Use Code Suggestion and autocompletion tools for list all Sobjects on your org. | true |
| Enable Hover Information | Boolean |
True to enable hover information provide by Aura Helper. False to disable it. | true |
Section to group all Documentation settings.
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Use Standard Java Comments | Boolean |
True to use the Standard Java Comments style on Apex, false to use your custom Apex comment template. (Need Reload Window). | false |
Section to group all Metadata Settings.
| Option | Datatype | Description | Default Value |
|---|---|---|---|
| Custom APIVersion | Number |
Salesforce API Version for use if you select Use Custom API Version setting. | 0 |
| Refresh SObject Definitions On Start | Boolean |
Refresh the Aura Helper's SObject Definitions when VSCode Start. Only will be refresh the not existing definitions. To force update all definitions, execute the command for it. | true |
| Use Custom APIVersion | Boolean |
Aura Helper use the SFDX CLI Command Version as Salesforce API Version for download metadata from Org by default. Check this field for use custom API Version. | false |
| Xml Sort Order | Enum |
Sort Order for all XML files when choose compress option or run compress commands. | Simple XML Elements First |