From c11ca621688ba27041d117518c17a591bb8396bf Mon Sep 17 00:00:00 2001 From: Stephen Carter Date: Fri, 15 Nov 2024 11:48:24 -0500 Subject: [PATCH 1/2] NEW: @W-17100389@: Add in feedback url to help text and log --- messages/config-command.md | 2 ++ messages/path-start-util.md | 4 ++-- messages/rules-command.md | 2 ++ messages/run-command.md | 2 ++ messages/shared.md | 4 ++++ messages/workspace-util.md | 2 +- src/lib/listeners/LogEventListener.ts | 2 ++ 7 files changed, 15 insertions(+), 3 deletions(-) diff --git a/messages/config-command.md b/messages/config-command.md index a7d73693f..1339fa37f 100644 --- a/messages/config-command.md +++ b/messages/config-command.md @@ -8,6 +8,8 @@ Code Analyzer gives you the ability to configure settings that modify Code Analy To apply a custom configuration with Code Analyzer, either keep your custom configuration settings in a `code-analyzer.yml` file located in the current folder from which you are executing commands, or specify the location of your custom configuration file to the Code Analyzer commands with the --config-file flag. +We're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback. + # command.examples - Display the current state of the Code Analyzer configuration using the default behavior: display top level configuration, display the engine and rule override settings associated with all the rules that have a "Recommended" tag; and automatically apply any existing custom configuration settings found in a `code-analyzer.yml` or `code-analyzer.yaml` file in the current folder: diff --git a/messages/path-start-util.md b/messages/path-start-util.md index 8c8415903..832162d91 100644 --- a/messages/path-start-util.md +++ b/messages/path-start-util.md @@ -1,7 +1,7 @@ # error.glob-method-conflict -*DRAFT*: Path start point %s is invalid: When specifying a method with the #methodName syntax, glob patterns cannot be used. +Path start point %s is invalid: When specifying a method with the #methodName syntax, glob patterns cannot be used. # error.negative-globs-unsupported -*DRAFT*: Path start point %s is invalid: Negative globs are unsupported. +Path start point %s is invalid: Negative globs are unsupported. diff --git a/messages/rules-command.md b/messages/rules-command.md index d225950b3..7e2e243d3 100644 --- a/messages/rules-command.md +++ b/messages/rules-command.md @@ -8,6 +8,8 @@ You can also view details about the rules, such as the engine it's associated wi Use this command to determine the exact set of rules to analyze your code. The `code-analyzer run` command has similar flags as this command, so once you've determined the flag values for this command that list the rules you want to run, you specify the same values to the `code-analyzer run` command. +We're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback. + # command.examples - List rules using the default behavior: include rules from all engines that have a "Recommended" tag; display the rules using concise table format; and automatically apply rule or engine overrides if a "code-analyzer.yml" or "code-analyzer.yaml" file exists in the current folder: diff --git a/messages/run-command.md b/messages/run-command.md index 154d493b7..ee74f6edf 100644 --- a/messages/run-command.md +++ b/messages/run-command.md @@ -8,6 +8,8 @@ You can scan your codebase with the recommended rules. Or use flags to filter th If you want to preview the list of rules before you actually run them, use the `code-analyzer rules` command, which also has the "--rules-selector", "--workspace", and "--config-file" flags that together define the list of rules to be run. +We're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback. + # command.examples - Analyze code using the default behavior: analyze the files in the current folder (default workspace) using the Recommended rules; display the output in the terminal with the concise table view; and automatically apply rule or engine overrides if a "code-analyzer.yml" or "code-analyzer.yaml" file exists in the current folder: diff --git a/messages/shared.md b/messages/shared.md index c39149101..039af4710 100644 --- a/messages/shared.md +++ b/messages/shared.md @@ -5,3 +5,7 @@ Developer Preview # warning.command-state This command is in %s. + +# log.give-us-feedback + +We're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback. diff --git a/messages/workspace-util.md b/messages/workspace-util.md index c9b61fa7f..57b4ac1fe 100644 --- a/messages/workspace-util.md +++ b/messages/workspace-util.md @@ -1,3 +1,3 @@ # error.negative-globs-unsupported -*DRAFT*: Workspace path %s is invalid: Negative globs are unsupported. +Workspace path %s is invalid: Negative globs are unsupported. diff --git a/src/lib/listeners/LogEventListener.ts b/src/lib/listeners/LogEventListener.ts index f717f5d59..41e8a0379 100644 --- a/src/lib/listeners/LogEventListener.ts +++ b/src/lib/listeners/LogEventListener.ts @@ -1,6 +1,7 @@ import {CodeAnalyzer, EngineLogEvent, EventType, LogEvent, LogLevel} from '@salesforce/code-analyzer-core'; import {Display} from '../Display'; import {LogWriter} from '../writers/LogWriter'; +import {BundleName, getMessage} from "../messages"; export interface LogEventListener { listen(codeAnalyzer: CodeAnalyzer): void; @@ -58,6 +59,7 @@ export class LogEventLogger implements LogEventListener { } public stopListening(): void { + this.logWriter.writeToLog('\n' + getMessage(BundleName.Shared, 'log.give-us-feedback')); this.logWriter.closeLog(); } From 812864d8ce920e9ae9d2487644e209bbfdb28601 Mon Sep 17 00:00:00 2001 From: Stephen Carter Date: Fri, 15 Nov 2024 12:03:43 -0500 Subject: [PATCH 2/2] Implement review feedback --- messages/path-start-util.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messages/path-start-util.md b/messages/path-start-util.md index 832162d91..e40d93bcf 100644 --- a/messages/path-start-util.md +++ b/messages/path-start-util.md @@ -1,6 +1,6 @@ # error.glob-method-conflict -Path start point %s is invalid: When specifying a method with the #methodName syntax, glob patterns cannot be used. +Path start point %s is invalid: You can't use glob patterns when specifying a method with the #methodName syntax. # error.negative-globs-unsupported