NEW: @W-17916450@ update v5 CLI to allow rules to be saved to JSON (Part 2)

Author: jshackell-sfdc

messages/rules-command.md

@@ -32,9 +32,9 @@ We're continually improving Salesforce Code Analyzer. Tell us what you think! Gi
 
   <%= config.bin %> <%= command.id %>  --rule-selector eslint:all
 
-- List all rules for all engines:
+- List the details about all rules for all engines; also write the rules in JSON format to a file called "rules.json" in the "out" folder, which must already exist:
 
-    <%= config.bin %> <%= command.id %>  --rule-selector all
+    <%= config.bin %> <%= command.id %>  --rule-selector all --output-file ./out/rules.json --view detail
 
 - Get a more accurate list of the rules that apply specifically to your workspace (all the files in the current folder): 
 
@@ -102,14 +102,16 @@ Format to display the rules in the terminal.
 
 # flags.view.description
 
-The format `table` is concise and shows minimal output, the format `detail` shows all available information. If you specify neither --view nor --output-file, then the default table view is shown. If you specify --output-file but not --view, only summary information is shown.
+The format `table` is concise and shows minimal output, the format `detail` shows all available information. 
+
+If you specify neither --view nor --output-file, then the default table view is shown. If you specify --output-file but not --view, only summary information is shown in the terminal.
 
 # flags.output-file.summary
 
-Output file location to write the selected rules. The file is written in JSON format.
+Name of the file where the selected rules are written. The file format depends on the extension you specify; currently, only .json is supported for JSON-formatted output.
 
 # flags.output-file.description
 
-Use this flag to write the selected rules to a JSON file. For example: "--output-file ./out/rules.json” creates a JSON results file in the "./out" folder. If the file exists already, it will be overwritten.
+If you specify a folder, such as "--output-file ./out/rules.json", the folder must already exist or you get an error. If the file already exists, it's overwritten without prompting.
 
-If you don't specify this flag, the command outputs the rules in the terminal. The view flag can be used in combination with this flag to save the file and output the results.
+If you don't specify this flag, the command outputs the rules to only the terminal. 

messages/rules-writer.md

@@ -1,3 +1,3 @@
 # error.unrecognized-file-format
 
-The output file %s has an unsupported extension. Valid extensions include: .json.
+The output file %s has an unsupported extension. Valid extension(s): .json.

messages/run-command.md

@@ -126,20 +126,23 @@ If you specify neither --view nor --output-file, then the default table view is
 
 # flags.output-file.summary
 
-Output file that contains the analysis results. The file format depends on the extension you specify, such as .csv, .html, .xml, and so on. 
+Name of the file where the analysis results are written. The file format depends on the extension you specify, such as .csv, .html, .xml, and so on. 
 
 # flags.output-file.description
 
-If you don't specify this flag, the command outputs the results in the terminal. Use this flag to print the results to a file; the format of the results depends on the extension you provide. For example, "--output-file results.csv" creates a comma-separated values file. You can specify one of these extensions:
+If you don't specify this flag, the command outputs the results to only the terminal. Use this flag to print the results to a file; the format of the results depends on the extension you provide. For example, "--output-file results.csv" creates a comma-separated values file. You can specify one of these extensions:
 
 - .csv
 - .html or .htm
 - .json
 - .sarif or .sarif.json
 - .xml
 
-To output the results to multiple files, specify this flag multiple times.  For example: "--output-file ./out/results.json --output-file ./out/report.html" creates a JSON results file and an HTML file in the "./out" folder. 
+To output the results to multiple files, specify this flag multiple times.  For example: "--output-file results.json --output-file report.html" creates both a JSON results file and an HTML file.
+
+If you specify a folder, such as "--output-file ./out/results.json", the folder must already exist or you get an error. If the file already exists, it's overwritten without prompting.
 
 # error.invalid-severity-threshold
 
 Expected --severity-threshold=%s to be one of: %s
+

yarn.lock

@@ -1771,10 +1771,10 @@
     strip-ansi "6.0.1"
     ts-retry-promise "^0.8.1"
 
-"@salesforce/code-analyzer-core@0.23.0":
-  version "0.23.0"
-  resolved "https://registry.yarnpkg.com/@salesforce/code-analyzer-core/-/code-analyzer-core-0.23.0.tgz#c0527bba10303d60f71cbbe0e65b5c08ce6608cd"
-  integrity sha512-tjq5eaatKnyqYwdLSKn5RpglrfoeAwzRaCykvndQZBqWopntyjB7KYrX0sBXLRXRCHpwXVj7mpp84t+vj4dP8w==
+"@salesforce/code-analyzer-core@0.24.0":
+  version "0.24.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/code-analyzer-core/-/code-analyzer-core-0.24.0.tgz#5381143f05ef4c76b56aa4f58505dea2c7cd9b4a"
+  integrity sha512-VvFWJqd4bi/862gExO2pp7kKhN4HYyOgqiV0E669LzqMyN7McqdRQFiew93o8cKxuzs49R/D3EKFiB+jenU3vQ==
   dependencies:
     "@salesforce/code-analyzer-engine-api" "0.18.0"
     "@types/js-yaml" "^4.0.9"