NEW (CodeAnalyzer): @W-13569501@: 3.16.0 Release Work #1158

teresa-allen-sfdc · 2023-08-24T16:35:23Z

release summary
new Graph Engine rule
promoted from pilot to GA, two rules
new VS code extension doc

Two rules updated pilot to GA, one new pilot rule

…canner into teresa-docdev

- added new extension topic

…canner into teresa-docdev

jfeingold35 · 2023-08-24T17:28:03Z

docs/_data/sidebar-v3.yml

+    url: /v3.x/code-analyzer-vs-code-extension
+    new: true


The url and new lines need to be indented with two spaces instead of four.

jfeingold35 · 2023-08-24T17:31:21Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

@@ -0,0 +1,144 @@
+# Salesforce Code Analyzer Visual Studio Code Extension (Beta)


Remove this header line and replace it with:

--- title: Salesforce Code Analyzer Visual Studio Code Extension (Beta) lang: en redirect_from: /en/code-analyzer-vs-code-extension ---

jfeingold35 · 2023-08-24T17:35:18Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+* [RetireJS](https://retirejs.github.io/retire.js/)
+* [Salesforce Graph Engine](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/salesforce-graph-engine/introduction/) (Generally Available rules only)
+
+You can also enable the extension to scan these languages:


It's my fault for not catching this earlier, but "You can also enable the extension to scan these languages" is slightly misleading, as it suggests that the act of enabling the extension allows the scanning of those languages. In actuality, the languages need to be enabled within the plug-in's settings. It may be beneficial to link to the relevant part of the FAQ, sfdx-scanner/en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y.

jfeingold35 · 2023-08-24T17:38:51Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+
+Regardless of which option you chose, the progress bar notifies you that the scan of your current file is active.
+
+![The VS Code progress bar displaying a Code Analyzer is analyzing targets message.](/docs/assets/images/vscode-images/AnalyzingTargets.png)


Change this link to ./assets/images/vscode-images/AnalyzingTargets.png.

jfeingold35 · 2023-08-24T17:39:16Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+
+When your scan is complete, click the scan summary in the progress bar (1). You see a scrollable list of violations that Code Analyzer found (2).
+
+![alt text: Sample VS Code code and Salesforce Code Analyzer scan results](/docs/assets/images/vscode-images/ScanSummary.png)


Change this link to ./assets/images/vscode-images/ScanSummary.png

jfeingold35 · 2023-08-24T17:41:14Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+
+	*Example*: /Users/MyUsername/Code/sfdx-scanner/
+
+![alt text: Salesforce Code Analyzer Settings with Code Analyzer > PMD Custom Config File section and a sample file location](/docs/assets/images/vscode-images/SettingsTwoBubbles.png)


Replace this link with ./assets/images/vscode-images/SettingsTwoBubbles.png.

jfeingold35 · 2023-08-24T17:42:02Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+
+The progress bar notifies you that the scan of your current file is active.
+
+![alt text: The VS Code progress bar displaying a Scanning targets notification.](/docs/assets/images/vscode-images/RunningGraphEngineAnalysis.png)


Replace this link with ./assets/images/vscode-images/RunningGraphEngineAnalysis.png.

jfeingold35 · 2023-08-24T17:42:23Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+
+When your scan is complete, a new tab opens with an HTML display of the violations found.
+
+![alt text: A sample Salesforce Graph Engine pop-up window with an html list of violations found](/docs/assets/images/vscode-images/GraphEngineResultsBlur.png)


Replace this link with ./assets/images/vscode-images/GraphEngineResultsBlur.png.

jfeingold35 · 2023-08-24T17:47:00Z

docs/_articles/en/v3.x/release-information.md

+
+* NEW (CodeAnalyzer): We made some updates to the RetireJS vulnerability database.
+* NEW (GraphEngine): To improve your code performance, we added one new pilot path-based Salesforce Graph Engine rule: PerformNullCheckOnSoqlVariables. This rule determines when a variable is noticed in the WHERE clause of a SOQL query and is missing a null check.
+* NEW (GraphEngine): Two recently released Graph Engine pilot rules are now generally available: AvoidDatabaseOperationInLoop and UseWithSharingOnDatabaseOperation.


Do we want to use sub-bullets for the two rules, the way we did in the 3.15.0 release note that announced their introduction?

jfeingold35 · 2023-08-24T17:48:27Z

docs/_articles/en/v3.x/release-information.md

+* NEW (CodeAnalyzer): We made some updates to the RetireJS vulnerability database.
+* NEW (GraphEngine): To improve your code performance, we added one new pilot path-based Salesforce Graph Engine rule: PerformNullCheckOnSoqlVariables. This rule determines when a variable is noticed in the WHERE clause of a SOQL query and is missing a null check.
+* NEW (GraphEngine): Two recently released Graph Engine pilot rules are now generally available: AvoidDatabaseOperationInLoop and UseWithSharingOnDatabaseOperation.
+* NEW (CodeAnalyzer): To scan your code easily, we released the [Salesforce Code Analyzer Visual Studio Code extension (beta)](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/code-analyzer-vs-code-extension). 


Change the link to ./en/v3.x/code-analyzer-vs-code-extension

teresa-allen-sfdc · 2023-08-25T13:36:07Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

+* [RetireJS](https://retirejs.github.io/retire.js/)
+* [Salesforce Graph Engine](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/salesforce-graph-engine/introduction/) (Generally Available rules only)
+
+Additionhally, you can also [enable]([https://forcedotcom.github.io/sfdx-scanner/en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y]) these languages in Salesforce Code Analyzer settings:


@jfeingold35 I updated this sentence per your comment. But I'm confused: if the user wants to run Code Analyzer on Java or XML, can they use the VS Code extension? If they have to change the setting via the CLI and can't use the VS Code extension, then this paragraph and two bullet points should be removed. Also, see the thread on the core release note - it's near ready to check in, so I'd appreciate your input there, too.

https://docs.google.com/document/d/1DrCR4CAgM0yrlbmCi3eWnbtoZlDSupXc2n4pvbLfXoY/edit?usp=sharing

…canner into teresa-docdev

jfeingold35 · 2023-08-25T14:56:43Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

@@ -12,7 +12,7 @@ Use Code Analyzer VS Code extension (beta) to scan multiple languages:
 * [RetireJS](https://retirejs.github.io/retire.js/)
 * [Salesforce Graph Engine](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/salesforce-graph-engine/introduction/) (Generally Available rules only)

-You can also enable the extension to scan these languages:
+You can also [enable]([https://forcedotcom.github.io/sfdx-scanner/en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y]) these languages in Salesforce Code Analyzer settings:


This link is broken.

Suggested change

You can also [enable]([https://forcedotcom.github.io/sfdx-scanner/en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y]) these languages in Salesforce Code Analyzer settings:

You can also [enable](./en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y) these languages in Salesforce Code Analyzer settings:

jfeingold35 · 2023-08-25T14:57:28Z

docs/_articles/en/v3.x/code-analyzer-vs-code-extension.md

@@ -1,4 +1,4 @@
-# Salesforce Code Analyzer Visual Studio Code Extension (Beta)
+--- title: Salesforce Code Analyzer Visual Studio Code Extension (Beta) lang: en redirect_from: /en/code-analyzer-vs-code-extension ---


The dashes and the properties all need to be on separate lines.

Suggested change

--- title: Salesforce Code Analyzer Visual Studio Code Extension (Beta) lang: en redirect_from: /en/code-analyzer-vs-code-extension ---

---

title: Salesforce Code Analyzer Visual Studio Code Extension (Beta)

lang: en

redirect_from: /en/code-analyzer-vs-code-extension

---

teresa-allen-sfdc added 17 commits August 21, 2023 10:44

Update 3.16.0 release-information.md

fdedc46

Update release-information.md

5db1112

Update rules.md

0c74ed7

Two rules updated pilot to GA, one new pilot rule

Upload images

2edcdb9

Merge branch 'teresa-docdev' of https://github.com/forcedotcom/sfdx-s…

2e6cd5a

…canner into teresa-docdev

Create code-analyzer-vs-code-extension

0ab5353

Update code-analyzer-vs-code-extension

f22c47b

Update sidebar-v3.yml

27574de

- added new extension topic

Commit images

0679690

Merge branch 'teresa-docdev' of https://github.com/forcedotcom/sfdx-s…

96e839d

…canner into teresa-docdev

Update code-analyzer-vs-code-extension

3fdd5b9

Update release-information.md

122fef1

Add one more code analyzer image

fb0138b

Merge branch 'teresa-docdev' of https://github.com/forcedotcom/sfdx-s…

2bc5886

…canner into teresa-docdev

Add new Code Analyzer image

2349757

New VS code extension doc with images

4619fbe

Update rules.md

a1fc01d

salesforce-cla bot added the cla:signed label Aug 24, 2023

jfeingold35 changed the base branch from dev to docdev August 24, 2023 17:22

jfeingold35 requested changes Aug 24, 2023

View reviewed changes

teresa-allen-sfdc added 3 commits August 25, 2023 09:28

Update code-analyzer-vs-code-extension.md

b15ffdb

Update code-analyzer-vs-code-extension.md

6fee4e6

Update code-analyzer-vs-code-extension.md

4ff7f70

teresa-allen-sfdc commented Aug 25, 2023

View reviewed changes

teresa-allen-sfdc added 6 commits August 25, 2023 09:36

Update code-analyzer-vs-code-extension.md

21ee1b2

Update code-analyzer-vs-code-extension.md

c14392d

Update release-information.md

1c91569

Update sidebar-v3.yml

b0c4de0

Update code-analyzer-vs-code-extension.md

379538c

Update code-analyzer-vs-code-extension.md

7a4b8aa

teresa-allen-sfdc added 10 commits August 25, 2023 11:17

Update versions-v3.yml

c6b1076

Update code-analyzer-vs-code-extension.md

04ad18d

Update index.md

9e94bec

Update index.md

3506a15

Create new GraphEngine image

8021c75

Merge branch 'teresa-docdev' of https://github.com/forcedotcom/sfdx-s…

4b49d57

…canner into teresa-docdev

Update code-analyzer-vs-code-extension.md

1537a7f

Delete RunningGraphEngineAnalysis.png

447d7c1

move image

6282267

Delete CodeAnalyzerViolationImage.png

c3bb467

jfeingold35 reviewed Aug 25, 2023

View reviewed changes

jfeingold35 approved these changes Aug 25, 2023

View reviewed changes

jfeingold35 merged commit ab0e574 into docdev Aug 25, 2023
2 checks passed

teresa-allen-sfdc deleted the teresa-docdev branch September 26, 2023 14:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NEW (CodeAnalyzer): @W-13569501@: 3.16.0 Release Work #1158

NEW (CodeAnalyzer): @W-13569501@: 3.16.0 Release Work #1158

teresa-allen-sfdc commented Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

jfeingold35 Aug 24, 2023

teresa-allen-sfdc Aug 25, 2023

jfeingold35 Aug 25, 2023

jfeingold35 Aug 25, 2023

		@@ -0,0 +1,144 @@
		# Salesforce Code Analyzer Visual Studio Code Extension (Beta)


		Regardless of which option you chose, the progress bar notifies you that the scan of your current file is active.

		![The VS Code progress bar displaying a Code Analyzer is analyzing targets message.](/docs/assets/images/vscode-images/AnalyzingTargets.png)


		When your scan is complete, click the scan summary in the progress bar (1). You see a scrollable list of violations that Code Analyzer found (2).

		![alt text: Sample VS Code code and Salesforce Code Analyzer scan results](/docs/assets/images/vscode-images/ScanSummary.png)


		Example: /Users/MyUsername/Code/sfdx-scanner/

		![alt text: Salesforce Code Analyzer Settings with Code Analyzer > PMD Custom Config File section and a sample file location](/docs/assets/images/vscode-images/SettingsTwoBubbles.png)


		The progress bar notifies you that the scan of your current file is active.

		![alt text: The VS Code progress bar displaying a Scanning targets notification.](/docs/assets/images/vscode-images/RunningGraphEngineAnalysis.png)


		When your scan is complete, a new tab opens with an HTML display of the violations found.

		![alt text: A sample Salesforce Graph Engine pop-up window with an html list of violations found](/docs/assets/images/vscode-images/GraphEngineResultsBlur.png)

	You can also [enable]([https://forcedotcom.github.io/sfdx-scanner/en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y]) these languages in Salesforce Code Analyzer settings:
	You can also [enable](./en/v3.x/faq/#q-how-do-i-enable-engine-xs-default-rules-for-language-y) these languages in Salesforce Code Analyzer settings:

		@@ -1,4 +1,4 @@
		# Salesforce Code Analyzer Visual Studio Code Extension (Beta)
		--- title: Salesforce Code Analyzer Visual Studio Code Extension (Beta) lang: en redirect_from: /en/code-analyzer-vs-code-extension ---

NEW (CodeAnalyzer): @W-13569501@: 3.16.0 Release Work #1158

NEW (CodeAnalyzer): @W-13569501@: 3.16.0 Release Work #1158

Conversation

teresa-allen-sfdc commented Aug 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment