CHANGE(chore): @W-18505636@ Updates for forcedotcom/code-analyzer name change #1817

randi274 · 2025-05-21T20:04:37Z

This PR:

Updates any lingering sfdx-scanner references with the repository rename to code-analyzer
Updates the README for latest functionality
Adds additional issue templates for the VS Code Extensions and the Run Github Action to use

randi274 · 2025-05-21T20:05:14Z

.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml

    attributes:
      label: Bug Description
-      description: Provide a clear and concise description of what the bug is and include the exact command that you ran.
+      description: Provide a clear and concise description of what the bug is.


The exact command is asked for later, so thought this could be shortened

randi274 · 2025-05-21T20:07:11Z

package.json

 {
 	"name": "@salesforce/plugin-code-analyzer",
-	"description": "Static code scanner that applies quality and security rules to Apex code, and provides feedback.",
+	"description": "Static code scanner that applies quality and security rules to Salesforce code and provides feedback.",


Since we scan more than just Apex, I wanted to open up this description. However, I wasn't sure we'd be ok locking so closely to Salesforce since code-analyzer is not entirely platform specific. Happy to update this as we need! Maybe @jshackell-sfdc can weigh in here as well.

Yeah I agree with your change. I would go even further and remove the word "Static" even.

Let's see if @jshackell-sfdc doesn't already have a better short description that we could put here instead.

I liked the notion of matching what we have in the readme as well, so I made these match!

stephen-carter-at-sf · 2025-05-21T20:37:24Z

.github/ISSUE_TEMPLATE/1-scanner_bug.yml

@@ -1,7 +1,6 @@
 name: Report a Bug with a scanner command (v4)


Since you updated the 0-code_analyzer_bug.yml to have

name: Report a Bug with the sf CLI `code-analyzer` commands

then shouldn't this 1_scanner_bug.yml be something like:

name: Report a Bug with the sf CLI `scanner` (v4) commands

stephen-carter-at-sf · 2025-05-21T20:39:21Z

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

@@ -0,0 +1,142 @@
+name: Report a Bug with the Salesforce Code Analyzer VS Code Extension


Can we add some quotes like maybe:

name: Report a Bug with the "Salesforce Code Analyzer" VS Code Extension

stephen-carter-at-sf · 2025-05-21T20:40:35Z

.github/ISSUE_TEMPLATE/3-github_action_bug.yml

@@ -0,0 +1,122 @@
+name: Report a Bug with the Run Salesforce Code Analyzer Github Action


ditto about quotes... maybe:

name Report a Bug with the "Run Salesforce Code Analyzer" GitHub Action

Also note that GitHub should have a capital H.

stephen-carter-at-sf · 2025-05-21T20:42:39Z

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

+      label: Scanner Plugin Version
+      description: |
+        If you are using V4, what do you get from typing the command "sf plugins" in the terminal?
+      placeholder: |
+        Example: @salesforce/sfdx-scanner/4.10.0


Let's assume that folks have moved to v5 and instead let's just ask about their code-analyzer version just like we do on the code-analyzer cli issue page and all its requirements.

With this one, I was thinking it would likely be part of the troubleshooting steps of "are you using v4", because if they are, we would direct them to using v5 and hopefully resolve the issue 🤞

I understand.. but where is the code-analyzer version when they are using code-analyzer and not scanner?

stephen-carter-at-sf · 2025-05-21T20:44:08Z

README.md

 * how to install Code Analyzer
 * what is included in the Code Analyzer command reference
-* the structure of Code Analyzer architecture
+* what rules are included from code-scanning engines such as PMD and ESLint


I don't think we need the word "code-scanning" here. It isn't a term we normally use. So let's just say "... from engines ..."

Agreed "code-scanning felt funky - I was looking for something that might help explain what an "engine" means for someone who hasn't worked with Code Analyzer before. I'll take another stab at this one and ask @jshackell-sfdc!

stephen-carter-at-sf · 2025-05-21T20:46:28Z

package.json

 {
 	"name": "@salesforce/plugin-code-analyzer",
-	"description": "Static code scanner that applies quality and security rules to Apex code, and provides feedback.",
+	"description": "Static code scanner that applies quality and security rules to Salesforce code and provides feedback.",


Yeah I agree with your change. I would go even further and remove the word "Static" even.

Let's see if @jshackell-sfdc doesn't already have a better short description that we could put here instead.

README.md

…e change and more

README.md

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

jfeingold35 · 2025-05-27T17:56:11Z

.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml

      label: Have you tried to resolve this issue yourself first?
      description: |
-        Oftentimes, you can resolve `code-analyzer` issues on your own. Follow these steps:
+        You can often resolve "code-analyzer" issues on your own. Follow these steps:


Maybe I'm wrong here but I think we actually do want the ticks so "code-analyzer" renders as code?

.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml

jfeingold35 · 2025-05-27T18:00:09Z

.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml

    attributes:
      label: Steps To Reproduce
-      description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
+      description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.


We should probably also instruct them to make sure that the STRs are runnable on another machine. E.g., attach any files that might be necessary for us to scan against to reproduce the problem, etc.
It's irksome when they just give the steps they do on their local machine without any way for us to recreate their setup.

jfeingold35 · 2025-05-27T18:00:39Z

.github/ISSUE_TEMPLATE/1-scanner_bug.yml

    attributes:
      label: Steps To Reproduce
-      description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
+      description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.


Same comment as other file.

jfeingold35 · 2025-05-27T18:01:25Z

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

+    attributes:
+      label: Have you tried to resolve this issue yourself first?
+      description: |
+        You can often resolve "vscode-extension" issues on your own. Follow these steps:


"vscode-extension" feels wrong, but I'm not intuitively sure what should go here. Should it be the name of the actual pacakge the VSCode extension is released as, maybe?

I'll go with a generic! that's what I did for the gha

jfeingold35 · 2025-05-27T18:02:34Z

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

+        1. Read the error message.
+        2. Read the [Salesforce Code Analyzer VS Code Extension](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/analyze-vscode.html) documentation.
+        3. Double-check the VS Code extension feature you used. Make sure that items like file names, method names, and category names are correctly spelled and cased.
+        4. Verify that you can't reproduce the issue using the appropriate Salesforce CLI command directly.


We'll want to include instructions for how they can set the logger to include the actual command that was run, right? (i.e., turning the debug settings to DEBUG, etc?)

@jfeingold35 can you add a suggestion for how to phrase this? I can remember how to update that setting (and haven't used it with other extensions before).

Use the "Developer: Set Log Level" command from the Command Palette to set the log levels to 'DEBUG', and then the "Output" panel will indicate what the underlying code-analyzer command for the given VSCode command was.

jfeingold35 · 2025-05-27T18:02:45Z

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.


Same comment as elsewhere.

jfeingold35 · 2025-05-27T18:03:21Z

.github/ISSUE_TEMPLATE/3-github_action_bug.yml

+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.


See comment elsewhere.

stephen-carter-at-sf · 2025-05-27T19:17:29Z

.github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml

+  - type: dropdown
+    attributes:
+      label: Code Analyzer Version
+      description: "Are you using Code Analyzer v4? (Is the setting 'Code Analyzer: Use v4 (Deprecated)' checked?)"
+      options:
+        - "Yes"
+        - "No"
+        - "Not sure"
+      default: 0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Scanner Plugin Version
+      description: |
+        If you are using Code Analyzer v4, what do you get when you run the "sf plugins" command in the terminal?
+      placeholder: |
+        Example: @salesforce/sfdx-scanner 4.12.0 (4.12.0)
+    validations:
+      required: false


I see you have "Code Analyzer Version" but the question is about v4 use or not. We need to actually get the Code Analyzer Version from the user and relabel the drop down about v4 use or not.

Agreed, let me clarify this section.

Updated this - hopefully this reads better now!

stephen-carter-at-sf · 2025-05-27T19:18:38Z

.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml

@@ -1,38 +1,37 @@
-name: Report a Bug with a code-analyzer command
-description: Report an issue with a code-analyzer command.
+name: Report a Bug With the "code-analyzer" (v5) CLI Commands


Can you double check with @jshackell-sfdc on whether the word "with" should be capitalized here. I thought it fit into the same category as the words "a" and "the".

If not, then we should update all of our issues files to not capitalize "with".

stephen-carter-at-sf · 2025-05-27T19:22:12Z

.github/ISSUE_TEMPLATE/3-github_action_bug.yml

@@ -0,0 +1,123 @@
+name: Report a Bug with the "Run Salesforce Code Analyzer" GitHub Action


Note that this has a lower case "with" - which I like. So we should make them all consistent.

randi274 commented May 21, 2025

View reviewed changes

randi274 force-pushed the randi/W-18505636-ga-updates branch from ce27483 to 905b0fc Compare May 21, 2025 20:09

stephen-carter-at-sf requested changes May 21, 2025

View reviewed changes

randi274 added 5 commits May 23, 2025 15:51

CHANGE(chore): @W-18505636@ Updates for forcedotcom/code-analyzer nam…

3081dee

…e change and more

Remove user story label

a5cb370

Review feedback and updating outdated github action syntax

cf20e33

Updating windows syntax

2029359

Switch to quotes and update output for windows

b5514c1

randi274 force-pushed the randi/W-18505636-ga-updates branch from 89f4d84 to 5378b48 Compare May 23, 2025 19:51

Doc updates

64220e8

randi274 force-pushed the randi/W-18505636-ga-updates branch from 5378b48 to 64220e8 Compare May 27, 2025 14:02

jshackell-sfdc approved these changes May 27, 2025

View reviewed changes

randi274 added 4 commits May 27, 2025 13:14

Remaining doc updates

18084d2

Merge branch 'dev' into randi/W-18505636-ga-updates

c36ede2

Update non-unique label

978774e

Merge branch 'dev' into randi/W-18505636-ga-updates

9593fb7

jfeingold35 reviewed May 27, 2025

View reviewed changes

Review feedback

ada453c

jfeingold35 approved these changes May 27, 2025

View reviewed changes

stephen-carter-at-sf requested changes May 27, 2025

View reviewed changes

stephen-carter-at-sf reviewed May 27, 2025

View reviewed changes

Moar feedback

d6fc5eb

stephen-carter-at-sf approved these changes May 27, 2025

View reviewed changes

randi274 merged commit f800322 into dev May 27, 2025
10 checks passed

randi274 deleted the randi/W-18505636-ga-updates branch October 29, 2025 15:56

		@@ -1,7 +1,6 @@
		name: Report a Bug with a scanner command (v4)

		@@ -0,0 +1,142 @@
		name: Report a Bug with the Salesforce Code Analyzer VS Code Extension

		@@ -0,0 +1,122 @@
		name: Report a Bug with the Run Salesforce Code Analyzer Github Action

		@@ -0,0 +1,123 @@
		name: Report a Bug with the "Run Salesforce Code Analyzer" GitHub Action

CHANGE(chore): @W-18505636@ Updates for forcedotcom/code-analyzer name change #1817

CHANGE(chore): @W-18505636@ Updates for forcedotcom/code-analyzer name change #1817

Uh oh!

Conversation

randi274 commented May 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants