Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 22 additions & 23 deletions .github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml
Original file line number Diff line number Diff line change
@@ -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
description: Report an issue with one of the commands contained in the "@salesforce/plugin-code-analyzer" Salesforce CLI plugin.
title: "[BUG][code-analyzer] <YOUR_TITLE_HERE>"
labels: []
body:
- type: checkboxes
attributes:
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:
1. Read the error message.
2. Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.html) documentation.
3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased.
2. Read the [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/get-started.html) documentation.
3. Double-check the command that you ran. Make sure that items like file names, method names, and tag names are correctly spelled and cased.
4. Verify that your code is syntactically valid.
5. Verify that the error is reproducible on another machine.
6. Check open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
5. Verify that the error is reproducible on another computer.
6. Check the open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
options:
- label: I confirm I have gone through the above steps and still have an issue to report
- label: I confirm I have gone through the above steps and still have an issue to report.
required: true
- type: textarea
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 overview of the bug.
validations:
required: true
- type: textarea
attributes:
label: Output / Logs
description: Attach any output or logs here
description: Attach any output or logs here.
placeholder: |
Add log output here or drag files here.
Add log output or drag files here.
- type: textarea
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. If possible, ensure the steps are reproducible on another machine and attach any files that demonstrate the issue.
placeholder: |
1. I first do ...
2. Then I do ...
Expand All @@ -49,34 +48,34 @@ body:
attributes:
label: Operating System
description: |
What is your machine's operating system?
What's your computer's operating system?
placeholder: |
Example: MacOS Sonoma 14.4.1
Example: macOS Sonoma 14.4.1
validations:
required: true
- type: input
attributes:
label: Salesforce CLI Version
description: |
What do you get from the command "sf --version"?
What do you get when you run the "sf --version" command?
placeholder: |
Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2
Example: @salesforce/cli/2.90.4 darwin-x64 node-v22.15.0
validations:
required: true
- type: input
attributes:
label: Code Analyzer Plugin (code-analyzer) Version
description: |
What do you get from the command "sf plugins"?
What do you get when you run the "sf plugins" command?
placeholder: |
Example: code-analyzer 5.0.0
Example: code-analyzer 5.0.0 (5.0.0)
validations:
required: true
- type: input
attributes:
label: Node Version
description: |
What do you get from the command "node --version"?
What do you get when you run the "node --version" command?
placeholder: |
Example: v23.4.0
validations:
Expand All @@ -85,7 +84,7 @@ body:
attributes:
label: Java Version
description: |
What do you get from the command "java -version"?
What do you get when you run the "java -version" command?
placeholder: |
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
validations:
Expand All @@ -94,15 +93,15 @@ body:
attributes:
label: Python Version
description: |
What do you get from the command "python --version"?
What do you get when you run the "python --version" command?
placeholder: |
Example: Python 3.11.8
validations:
required: false
- type: textarea
attributes:
label: Additional Context (Screenshots, Files, etc)
description: Add any other context about the problem.
description: Add any other context about your problem.
placeholder: |
Drag any files or screenshots you have here.
- type: textarea
Expand Down
41 changes: 20 additions & 21 deletions .github/ISSUE_TEMPLATE/1-scanner_bug.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
name: Report a Bug with a scanner command (v4)
description: Report an issue with a scanner command.
name: Report a Bug with the "scanner" (v4) CLI Commands
description: Report an issue with one of the commands contained in the "@salesforce/sfdx-scanner" Salesforce CLI plugin.
title: "[BUG][scanner] <YOUR_TITLE_HERE>"
labels: []
body:
- type: checkboxes
attributes:
label: Have you tried to resolve this issue yourself first?
description: |
Oftentimes, you can resolve `scanner` issues on your own. Follow these steps:
You can often resolve `scanner` issues on your own. Follow these steps:
1. Read the error message.
2. Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview) documentation.
3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased.
2. Read the [Salesforce Code Analyzer v4](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer-3x.html) documentation.
3. Double-check the command that you ran. Make sure that items like file names, method names, and category names are correctly spelled and cased.
4. Verify that your code is syntactically valid.
5. Verify that the error is reproducible on another machine.
5. Verify that the error is reproducible on another computer.
6. Check open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
options:
- label: I confirm I have gone through the above steps and still have an issue to report
- label: I confirm I have gone through the above steps and still have an issue to report.
required: true
- type: textarea
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 overview of the bug.
validations:
required: true
- type: textarea
attributes:
label: Output / Logs
description: Attach any output or logs here
description: Attach any output or logs here.
placeholder: |
Add log output here or drag files here.
Add log output or drag files here.
- type: textarea
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. If possible, ensure the steps are reproducible on another machine and attach any files that demonstrate the issue.
placeholder: |
1. I first do ...
2. Then I do ...
Expand All @@ -49,34 +48,34 @@ body:
attributes:
label: Operating System
description: |
What is your machine's operating system?
What is your computer's operating system?
placeholder: |
Example: MacOS Sonoma 14.4.1
Example: macOS Sonoma 14.4.1
validations:
required: true
- type: input
attributes:
label: Salesforce CLI Version
description: |
What do you get from the command "sf --version"?
What do you get when you run the "sf --version" command?
placeholder: |
Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2
Example: @salesforce/cli/2.90.4 darwin-x64 node-v22.15.0
validations:
required: true
- type: input
attributes:
label: Scanner Plugin Version
description: |
What do you get from the command "sf plugins"?
What do you get when you run the "sf plugins" command?
placeholder: |
Example: @salesforce/sfdx-scanner/4.10.0
Example: @salesforce/sfdx-scanner 4.12.0 (4.12.0)
validations:
required: true
- type: input
attributes:
label: Node Version
description: |
What do you get from the command "node --version"?
What do you get when you run the "node --version" command?
placeholder: |
Example: v23.4.0
validations:
Expand All @@ -85,7 +84,7 @@ body:
attributes:
label: Java Version
description: |
What do you get from the command "java -version"?
What do you get when you run the "java -version" command?
placeholder: |
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
validations:
Expand All @@ -111,4 +110,4 @@ body:
- Critical
default: 0
validations:
required: true
required: true
143 changes: 143 additions & 0 deletions .github/ISSUE_TEMPLATE/2-vscode_extension_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
name: Report a Bug with the "Salesforce Code Analyzer" VS Code Extension
description: Report an issue that's with the VS Code extension but not with the CLI commands.
title: "[BUG][vscode-extension] <YOUR_TITLE_HERE>"
body:
- type: checkboxes
attributes:
label: Have you tried to resolve this issue yourself first?
description: |
You can often resolve these issues on your own. Follow these steps:
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 same Salesforce CLI command. Use the "Developer: Set Log Level" command from the Command Palette to set the log levels to 'DEBUG', and then the "Output" panel will display the code-analyzer command.
5. Verify that your code is syntactically valid.
6. Verify that the error is reproducible on another computer.
7. Check open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
options:
- label: I confirm I have gone through the above steps and still have an issue to report.
required: true
- type: textarea
attributes:
label: Bug Description
description: Provide a clear and concise overview of the bug.
validations:
required: true
- type: textarea
attributes:
label: Output / Logs
description: Attach any output or logs here.
placeholder: |
Add log output or drag files here.
- 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. If possible, ensure the steps are reproducible on another machine and attach any files that demonstrate the issue.
placeholder: |
1. I first do ...
2. Then I do ...
3. Lastly, I do ...
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: Provide a clear and concise description of what you expected to happen.
validations:
required: true
- type: input
attributes:
label: Operating System
description: |
What is your computer's operating system?
placeholder: |
Example: macOS Sonoma 14.4.1
validations:
required: true
- type: input
attributes:
label: Visual Studio Code Version
description: |
What version do you see when you click "Code > About Visual Studio Code"?
placeholder: |
Example: Version: 1.89.1 (Universal)
validations:
required: true
- type: input
attributes:
label: Salesforce CLI Version
description: |
What do you get when you run the "sf --version" command in the terminal?
placeholder: |
Example: @salesforce/cli/2.90.4 darwin-x64 node-v22.15.0
validations:
required: true
- type: dropdown
attributes:
label: Using v4
description: "Are you using Code Analyzer v4? (Is the setting 'Code Analyzer: Use v4 (Deprecated)' checked?)"
options:
- ""
- "No"
- "Yes"
- "Not sure"
validations:
required: true
- type: input
attributes:
label: Code Analyzer CLI Plugin Version
description: |
What do you get when you run the "sf plugins" command in the terminal?
placeholder: |
code-analyzer 5.0.0; or if using v4: @salesforce/sfdx-scanner 4.12.0
validations:
required: false
- type: input
attributes:
label: Node Version
description: |
What do you get when you run the "node --version" command in the terminal?
placeholder: |
Example: v23.4.0
validations:
required: false
- type: input
attributes:
label: Java Version
description: |
What do you get when you run the "java -version" command in the terminal?
placeholder: |
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
validations:
required: false
- type: input
attributes:
label: Python Version
description: |
What do you get when you run the "python --version" command in the terminal?
placeholder: |
Example: Python 3.11.8
validations:
required: false
- type: textarea
attributes:
label: Additional Context (Screenshots, Files, etc)
description: Add any other context about the problem.
placeholder: |
Drag any files or screenshots you have here.
- type: textarea
attributes:
label: Workaround
description: What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?
- type: dropdown
attributes:
label: Urgency
description: What is the severity of the problem?
options:
- Low
- Moderate
- High
- Critical
default: 0
validations:
required: true
Loading