@salesforce/cli 2.151.5 → 2.152.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1773,14 +1773,12 @@
1773
1773
  "messages:audit:dev"
1774
1774
  ]
1775
1775
  },
1776
- "dev:convert:messages": {
1776
+ "dev:configure:repo": {
1777
1777
  "aliases": [],
1778
1778
  "args": {},
1779
- "description": "Preserves the filename and the original messages file, then creates a new file with the Markdown extension and standard headers for the command and flag summaries, descriptions, and so on. After you review the new Markdown file, delete the old .json file.",
1779
+ "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules.",
1780
1780
  "examples": [
1781
- "Convert the my-command.json message file into my-command.md with the standard messages headers:\n<%= config.bin %> <%= command.id %> --filename my-command.json",
1782
- "Similar to previous example, but specify the plugin project directory:",
1783
- "<%= config.bin %> <%= command.id %> --project-dir ./path/to/plugin --filename my-command.json"
1781
+ "Configure the repo \"testPackageRelease\", with owner \"salesforcecli\", for GitHub Actions.\n<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1784
1782
  ],
1785
1783
  "flags": {
1786
1784
  "json": {
@@ -1798,64 +1796,70 @@
1798
1796
  "multiple": false,
1799
1797
  "type": "option"
1800
1798
  },
1801
- "project-dir": {
1802
- "aliases": [
1803
- "projectdir"
1804
- ],
1805
- "char": "p",
1806
- "name": "project-dir",
1807
- "summary": "Location of the project whose messages are to be converted.",
1808
- "default": ".",
1799
+ "repository": {
1800
+ "char": "r",
1801
+ "name": "repository",
1802
+ "required": true,
1803
+ "summary": "GitHub owner/repo for which you want to configure GitHub Actions.",
1809
1804
  "hasDynamicHelp": false,
1810
1805
  "multiple": false,
1811
1806
  "type": "option"
1812
1807
  },
1813
- "file-name": {
1808
+ "dry-run": {
1814
1809
  "aliases": [
1815
- "filename"
1810
+ "dryrun"
1816
1811
  ],
1817
- "char": "f",
1818
- "name": "file-name",
1819
- "required": true,
1820
- "summary": "Filename to convert.",
1812
+ "char": "d",
1813
+ "name": "dry-run",
1814
+ "summary": "Make no changes.",
1815
+ "allowNo": false,
1816
+ "type": "boolean"
1817
+ },
1818
+ "bot": {
1819
+ "char": "b",
1820
+ "name": "bot",
1821
+ "summary": "GitHub login/username for the bot.",
1822
+ "default": "SF-CLI-BOT",
1821
1823
  "hasDynamicHelp": false,
1822
- "multiple": true,
1824
+ "multiple": false,
1823
1825
  "type": "option"
1824
1826
  }
1825
1827
  },
1826
1828
  "hasDynamicHelp": false,
1829
+ "hidden": true,
1827
1830
  "hiddenAliases": [],
1828
- "id": "dev:convert:messages",
1831
+ "id": "dev:configure:repo",
1829
1832
  "pluginAlias": "@salesforce/plugin-dev",
1830
1833
  "pluginName": "@salesforce/plugin-dev",
1831
1834
  "pluginType": "jit",
1832
1835
  "strict": true,
1833
- "summary": "Convert a .json messages file into Markdown.",
1836
+ "summary": "Configure a GitHub repo for the GitHub Actions pipeline.",
1834
1837
  "enableJsonFlag": true,
1835
1838
  "isESM": true,
1836
1839
  "relativePath": [
1837
1840
  "lib",
1838
1841
  "commands",
1839
1842
  "dev",
1840
- "convert",
1841
- "messages.js"
1843
+ "configure",
1844
+ "repo.js"
1842
1845
  ],
1843
1846
  "aliasPermutations": [],
1844
1847
  "permutations": [
1845
- "dev:convert:messages",
1846
- "convert:dev:messages",
1847
- "convert:messages:dev",
1848
- "dev:messages:convert",
1849
- "messages:dev:convert",
1850
- "messages:convert:dev"
1848
+ "dev:configure:repo",
1849
+ "configure:dev:repo",
1850
+ "configure:repo:dev",
1851
+ "dev:repo:configure",
1852
+ "repo:dev:configure",
1853
+ "repo:configure:dev"
1851
1854
  ]
1852
1855
  },
1853
- "dev:convert:script": {
1856
+ "dev:configure:secrets": {
1854
1857
  "aliases": [],
1855
1858
  "args": {},
1856
- "description": "Important: Use this command only to get started on the sfdx->sf script migration. We don't guarantee that the new sf-style command replacements work correctly or as you expect. You must test, and probably update, the new script before putting it into production. We also don't guarantee that the JSON results are the same as before. \n\nThis command can convert a large part of your script, but possibly not all. There are some sfdx-style commands that don't have an obvious sf-style equivalent. In this case, this command doesn't replace the sfdx-style command but instead adds a comment to remind you that you must convert it manually. See the Salesforce CLI Command Reference for migration information about each deprecated sfdx-style command: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference.htm.\n\nThis command is interactive; as it scans your script, it prompts you when it finds an sfdx-style command or flag and asks if you want to convert it to the displayed suggestion. The command doesn't update the script file directly; rather, it creates a new file whose name is the original name but with \"-converted\" appended to it. The script replaces all instances of \"sfdx\" with \"sf\". For each prompt you answer \"y\" to, the command replaces the sfdx-style names with their equivalent sf-style ones. For example, \"sfdx force:apex:execute --targetusername myscratch\" is replaced with \"sf apex run --target-org myscratch\".",
1859
+ "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets.",
1857
1860
  "examples": [
1858
- "Convert the YAML file called \"myScript.yml\" located in the current directory; the new file that contains the replacements is called \"myScript-converted.yml\":\n<%= config.bin %> <%= command.id %> --script ./myScript.yml"
1861
+ "Ensure secrets access for the repo \"testPackageRelease\", with owner \"salesforcecli\":",
1862
+ "<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1859
1863
  ],
1860
1864
  "flags": {
1861
1865
  "json": {
@@ -1873,56 +1877,62 @@
1873
1877
  "multiple": false,
1874
1878
  "type": "option"
1875
1879
  },
1876
- "script": {
1877
- "char": "s",
1878
- "name": "script",
1880
+ "repository": {
1881
+ "char": "r",
1882
+ "name": "repository",
1879
1883
  "required": true,
1880
- "summary": "Filepath to the script you want to convert.",
1884
+ "summary": "Github owner/repo.",
1881
1885
  "hasDynamicHelp": false,
1882
1886
  "multiple": false,
1883
1887
  "type": "option"
1884
1888
  },
1885
- "no-prompt": {
1886
- "hidden": true,
1887
- "name": "no-prompt",
1888
- "summary": "Don't prompt for suggested replacements.",
1889
+ "dry-run": {
1890
+ "aliases": [
1891
+ "dryrun"
1892
+ ],
1893
+ "char": "d",
1894
+ "name": "dry-run",
1895
+ "summary": "Make no changes.",
1889
1896
  "allowNo": false,
1890
1897
  "type": "boolean"
1891
1898
  }
1892
1899
  },
1893
1900
  "hasDynamicHelp": false,
1901
+ "hidden": true,
1894
1902
  "hiddenAliases": [],
1895
- "id": "dev:convert:script",
1903
+ "id": "dev:configure:secrets",
1896
1904
  "pluginAlias": "@salesforce/plugin-dev",
1897
1905
  "pluginName": "@salesforce/plugin-dev",
1898
1906
  "pluginType": "jit",
1899
1907
  "strict": true,
1900
- "summary": "Convert a script file that contains deprecated sfdx-style commands to use the new sf-style commands instead.",
1908
+ "summary": "Ensures a GitHub repo has correct access to secrets based on its workflows.",
1901
1909
  "enableJsonFlag": true,
1902
1910
  "isESM": true,
1903
1911
  "relativePath": [
1904
1912
  "lib",
1905
1913
  "commands",
1906
1914
  "dev",
1907
- "convert",
1908
- "script.js"
1915
+ "configure",
1916
+ "secrets.js"
1909
1917
  ],
1910
1918
  "aliasPermutations": [],
1911
1919
  "permutations": [
1912
- "dev:convert:script",
1913
- "convert:dev:script",
1914
- "convert:script:dev",
1915
- "dev:script:convert",
1916
- "script:dev:convert",
1917
- "script:convert:dev"
1920
+ "dev:configure:secrets",
1921
+ "configure:dev:secrets",
1922
+ "configure:secrets:dev",
1923
+ "dev:secrets:configure",
1924
+ "secrets:dev:configure",
1925
+ "secrets:configure:dev"
1918
1926
  ]
1919
1927
  },
1920
- "dev:configure:repo": {
1928
+ "dev:convert:messages": {
1921
1929
  "aliases": [],
1922
1930
  "args": {},
1923
- "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules.",
1931
+ "description": "Preserves the filename and the original messages file, then creates a new file with the Markdown extension and standard headers for the command and flag summaries, descriptions, and so on. After you review the new Markdown file, delete the old .json file.",
1924
1932
  "examples": [
1925
- "Configure the repo \"testPackageRelease\", with owner \"salesforcecli\", for GitHub Actions.\n<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
1933
+ "Convert the my-command.json message file into my-command.md with the standard messages headers:\n<%= config.bin %> <%= command.id %> --filename my-command.json",
1934
+ "Similar to previous example, but specify the plugin project directory:",
1935
+ "<%= config.bin %> <%= command.id %> --project-dir ./path/to/plugin --filename my-command.json"
1926
1936
  ],
1927
1937
  "flags": {
1928
1938
  "json": {
@@ -1940,70 +1950,64 @@
1940
1950
  "multiple": false,
1941
1951
  "type": "option"
1942
1952
  },
1943
- "repository": {
1944
- "char": "r",
1945
- "name": "repository",
1946
- "required": true,
1947
- "summary": "GitHub owner/repo for which you want to configure GitHub Actions.",
1953
+ "project-dir": {
1954
+ "aliases": [
1955
+ "projectdir"
1956
+ ],
1957
+ "char": "p",
1958
+ "name": "project-dir",
1959
+ "summary": "Location of the project whose messages are to be converted.",
1960
+ "default": ".",
1948
1961
  "hasDynamicHelp": false,
1949
1962
  "multiple": false,
1950
1963
  "type": "option"
1951
1964
  },
1952
- "dry-run": {
1965
+ "file-name": {
1953
1966
  "aliases": [
1954
- "dryrun"
1967
+ "filename"
1955
1968
  ],
1956
- "char": "d",
1957
- "name": "dry-run",
1958
- "summary": "Make no changes.",
1959
- "allowNo": false,
1960
- "type": "boolean"
1961
- },
1962
- "bot": {
1963
- "char": "b",
1964
- "name": "bot",
1965
- "summary": "GitHub login/username for the bot.",
1966
- "default": "SF-CLI-BOT",
1969
+ "char": "f",
1970
+ "name": "file-name",
1971
+ "required": true,
1972
+ "summary": "Filename to convert.",
1967
1973
  "hasDynamicHelp": false,
1968
- "multiple": false,
1974
+ "multiple": true,
1969
1975
  "type": "option"
1970
1976
  }
1971
1977
  },
1972
1978
  "hasDynamicHelp": false,
1973
- "hidden": true,
1974
1979
  "hiddenAliases": [],
1975
- "id": "dev:configure:repo",
1980
+ "id": "dev:convert:messages",
1976
1981
  "pluginAlias": "@salesforce/plugin-dev",
1977
1982
  "pluginName": "@salesforce/plugin-dev",
1978
1983
  "pluginType": "jit",
1979
1984
  "strict": true,
1980
- "summary": "Configure a GitHub repo for the GitHub Actions pipeline.",
1985
+ "summary": "Convert a .json messages file into Markdown.",
1981
1986
  "enableJsonFlag": true,
1982
1987
  "isESM": true,
1983
1988
  "relativePath": [
1984
1989
  "lib",
1985
1990
  "commands",
1986
1991
  "dev",
1987
- "configure",
1988
- "repo.js"
1992
+ "convert",
1993
+ "messages.js"
1989
1994
  ],
1990
1995
  "aliasPermutations": [],
1991
1996
  "permutations": [
1992
- "dev:configure:repo",
1993
- "configure:dev:repo",
1994
- "configure:repo:dev",
1995
- "dev:repo:configure",
1996
- "repo:dev:configure",
1997
- "repo:configure:dev"
1997
+ "dev:convert:messages",
1998
+ "convert:dev:messages",
1999
+ "convert:messages:dev",
2000
+ "dev:messages:convert",
2001
+ "messages:dev:convert",
2002
+ "messages:convert:dev"
1998
2003
  ]
1999
2004
  },
2000
- "dev:configure:secrets": {
2005
+ "dev:convert:script": {
2001
2006
  "aliases": [],
2002
2007
  "args": {},
2003
- "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets.",
2008
+ "description": "Important: Use this command only to get started on the sfdx->sf script migration. We don't guarantee that the new sf-style command replacements work correctly or as you expect. You must test, and probably update, the new script before putting it into production. We also don't guarantee that the JSON results are the same as before. \n\nThis command can convert a large part of your script, but possibly not all. There are some sfdx-style commands that don't have an obvious sf-style equivalent. In this case, this command doesn't replace the sfdx-style command but instead adds a comment to remind you that you must convert it manually. See the Salesforce CLI Command Reference for migration information about each deprecated sfdx-style command: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference.htm.\n\nThis command is interactive; as it scans your script, it prompts you when it finds an sfdx-style command or flag and asks if you want to convert it to the displayed suggestion. The command doesn't update the script file directly; rather, it creates a new file whose name is the original name but with \"-converted\" appended to it. The script replaces all instances of \"sfdx\" with \"sf\". For each prompt you answer \"y\" to, the command replaces the sfdx-style names with their equivalent sf-style ones. For example, \"sfdx force:apex:execute --targetusername myscratch\" is replaced with \"sf apex run --target-org myscratch\".",
2004
2009
  "examples": [
2005
- "Ensure secrets access for the repo \"testPackageRelease\", with owner \"salesforcecli\":",
2006
- "<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
2010
+ "Convert the YAML file called \"myScript.yml\" located in the current directory; the new file that contains the replacements is called \"myScript-converted.yml\":\n<%= config.bin %> <%= command.id %> --script ./myScript.yml"
2007
2011
  ],
2008
2012
  "flags": {
2009
2013
  "json": {
@@ -2021,52 +2025,48 @@
2021
2025
  "multiple": false,
2022
2026
  "type": "option"
2023
2027
  },
2024
- "repository": {
2025
- "char": "r",
2026
- "name": "repository",
2028
+ "script": {
2029
+ "char": "s",
2030
+ "name": "script",
2027
2031
  "required": true,
2028
- "summary": "Github owner/repo.",
2032
+ "summary": "Filepath to the script you want to convert.",
2029
2033
  "hasDynamicHelp": false,
2030
2034
  "multiple": false,
2031
2035
  "type": "option"
2032
2036
  },
2033
- "dry-run": {
2034
- "aliases": [
2035
- "dryrun"
2036
- ],
2037
- "char": "d",
2038
- "name": "dry-run",
2039
- "summary": "Make no changes.",
2037
+ "no-prompt": {
2038
+ "hidden": true,
2039
+ "name": "no-prompt",
2040
+ "summary": "Don't prompt for suggested replacements.",
2040
2041
  "allowNo": false,
2041
2042
  "type": "boolean"
2042
2043
  }
2043
2044
  },
2044
2045
  "hasDynamicHelp": false,
2045
- "hidden": true,
2046
2046
  "hiddenAliases": [],
2047
- "id": "dev:configure:secrets",
2047
+ "id": "dev:convert:script",
2048
2048
  "pluginAlias": "@salesforce/plugin-dev",
2049
2049
  "pluginName": "@salesforce/plugin-dev",
2050
2050
  "pluginType": "jit",
2051
2051
  "strict": true,
2052
- "summary": "Ensures a GitHub repo has correct access to secrets based on its workflows.",
2052
+ "summary": "Convert a script file that contains deprecated sfdx-style commands to use the new sf-style commands instead.",
2053
2053
  "enableJsonFlag": true,
2054
2054
  "isESM": true,
2055
2055
  "relativePath": [
2056
2056
  "lib",
2057
2057
  "commands",
2058
2058
  "dev",
2059
- "configure",
2060
- "secrets.js"
2059
+ "convert",
2060
+ "script.js"
2061
2061
  ],
2062
2062
  "aliasPermutations": [],
2063
2063
  "permutations": [
2064
- "dev:configure:secrets",
2065
- "configure:dev:secrets",
2066
- "configure:secrets:dev",
2067
- "dev:secrets:configure",
2068
- "secrets:dev:configure",
2069
- "secrets:configure:dev"
2064
+ "dev:convert:script",
2065
+ "convert:dev:script",
2066
+ "convert:script:dev",
2067
+ "dev:script:convert",
2068
+ "script:dev:convert",
2069
+ "script:convert:dev"
2070
2070
  ]
2071
2071
  },
2072
2072
  "dev:generate:command": {
@@ -5098,16 +5098,15 @@
5098
5098
  "validate.js"
5099
5099
  ]
5100
5100
  },
5101
- "flow:run:test": {
5101
+ "flow:get:log": {
5102
5102
  "aliases": [],
5103
5103
  "args": {},
5104
- "description": "Specify which tests to run by using the --class-names flag followed by the names of the flows you want to test. For example, if you save a flow with the name Flow1, then use: --class-names Flow1.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for classes in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.\n\nBy default, \"flow run test\" runs asynchronously and immediately returns a test run ID. If you use the -–synchronous flag, you can use the --wait flag to specify the number of minutes to wait; if the tests finish in that timeframe, the command displays the results. If the tests haven't finished by the end of the wait time, the command displays a test run ID. Use the \"flow get test --test-run-id\" command to get the results.\n\nTo run both Flow and Apex tests together, run the \"sf logic run test\" CLI command, which has similar flags as this command, but expands the --tests flag to also include Apex tests.\n\nYou must have the \"View All Data\" org system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.",
5104
+ "description": "Provide a flow test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the \"sf flow run test\" command.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for flow tests in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.",
5105
5105
  "examples": [
5106
- "Run all local tests in your default org:\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests",
5107
- "Run all the Flow1 and Flow2 flow tests in the org with alias “scratchOrg”:\n<%= config.bin %> <%= command.id %> --target-org scratchOrg --class-names Flow1 --class-names Flow2",
5108
- "Run specific Flow1 and Flow2 flow tests in your default org:\n<%= config.bin %> <%= command.id %> --tests Flow1.Test1 --tests Flow2.Test2 --test-level RunSpecifiedTests",
5109
- "Run all tests synchronously in your default org; the command waits to display the test results until all tests finish:\n<%= config.bin %> <%= command.id %> –synchronous",
5110
- "Run all local tests in the org with the username “me@my.org”; save the output to the specified directory:\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests --output-dir /Users/susan/temp/cliOutput --target-org me@my.org"
5106
+ "Display flow test results for your default org using a test run ID:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id>",
5107
+ "Similar to previous example, but output the result in JUnit format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --result-format junit",
5108
+ "Also retrieve code coverage results and output in JSON format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --json",
5109
+ "Specify a directory in which to save the test results from the org with the “me@my.org” username (rather than your default org):\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@my.org'"
5111
5110
  ],
5112
5111
  "flags": {
5113
5112
  "json": {
@@ -5142,137 +5141,61 @@
5142
5141
  "multiple": false,
5143
5142
  "type": "option"
5144
5143
  },
5145
- "result-format": {
5146
- "char": "r",
5147
- "name": "result-format",
5148
- "summary": "Format of the test results.",
5149
- "default": "human",
5144
+ "log-id": {
5145
+ "char": "i",
5146
+ "name": "log-id",
5147
+ "summary": "ID of the specific log to display.",
5150
5148
  "hasDynamicHelp": false,
5151
5149
  "multiple": false,
5152
- "options": [
5153
- "human",
5154
- "tap",
5155
- "junit",
5156
- "json"
5157
- ],
5158
5150
  "type": "option"
5159
5151
  },
5160
- "concise": {
5161
- "name": "concise",
5162
- "summary": "Display only failed test results; works with human-readable output only.",
5163
- "allowNo": false,
5164
- "type": "boolean"
5165
- },
5166
- "output-dir": {
5167
- "char": "d",
5168
- "name": "output-dir",
5169
- "summary": "Directory in which to store test result files.",
5152
+ "number": {
5153
+ "char": "n",
5154
+ "name": "number",
5155
+ "summary": "Number of the most recent logs to display.",
5170
5156
  "hasDynamicHelp": false,
5171
5157
  "multiple": false,
5172
5158
  "type": "option"
5173
5159
  },
5174
- "code-coverage": {
5175
- "char": "c",
5176
- "name": "code-coverage",
5177
- "summary": "Retrieve code coverage results.",
5178
- "allowNo": false,
5179
- "type": "boolean"
5180
- },
5181
- "synchronous": {
5182
- "char": "y",
5183
- "name": "synchronous",
5184
- "summary": "Run flow tests for one flow synchronously; if not specified, tests are run asynchronously.",
5185
- "allowNo": false,
5186
- "type": "boolean"
5187
- },
5188
- "test-level": {
5189
- "char": "l",
5190
- "description": "Here's what the levels mean:\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages.\n- RunAllTestsInOrg — All tests are run. The tests include all tests in your org, including tests of managed packages.\n- RunSpecifiedTests - Only the tests that you specify with the --tests flag are run.",
5191
- "name": "test-level",
5192
- "summary": "Level of tests to run; default is RunLocalTests.",
5160
+ "output-dir": {
5161
+ "char": "d",
5162
+ "name": "output-dir",
5163
+ "summary": "Directory in which to store test result files.",
5193
5164
  "hasDynamicHelp": false,
5194
5165
  "multiple": false,
5195
- "options": [
5196
- "RunLocalTests",
5197
- "RunAllTestsInOrg",
5198
- "RunSpecifiedTests"
5199
- ],
5200
- "type": "option"
5201
- },
5202
- "class-names": {
5203
- "aliases": [
5204
- "classnames"
5205
- ],
5206
- "char": "n",
5207
- "description": "Default is all flow tests. If you select --class-names, you can't specify --tests.",
5208
- "exclusive": [
5209
- "suite-names",
5210
- "tests"
5211
- ],
5212
- "name": "class-names",
5213
- "summary": "Flow names that contain flow tests to run.",
5214
- "hasDynamicHelp": false,
5215
- "multiple": true,
5216
- "type": "option"
5217
- },
5218
- "suite-names": {
5219
- "aliases": [
5220
- "suitenames"
5221
- ],
5222
- "char": "s",
5223
- "description": "Not available for flow tests.",
5224
- "exclusive": [
5225
- "class-names",
5226
- "tests"
5227
- ],
5228
- "name": "suite-names",
5229
- "summary": "Not available for flow tests.",
5230
- "hasDynamicHelp": false,
5231
- "multiple": true,
5232
- "type": "option"
5233
- },
5234
- "tests": {
5235
- "char": "t",
5236
- "description": "Default is all flow tests. If you specify --tests, you can't specify --class-names.",
5237
- "exclusive": [
5238
- "class-names",
5239
- "suite-names"
5240
- ],
5241
- "name": "tests",
5242
- "summary": "Flow test names to run.",
5243
- "hasDynamicHelp": false,
5244
- "multiple": true,
5245
5166
  "type": "option"
5246
5167
  }
5247
5168
  },
5248
5169
  "hasDynamicHelp": true,
5170
+ "hidden": true,
5249
5171
  "hiddenAliases": [],
5250
- "id": "flow:run:test",
5172
+ "id": "flow:get:log",
5251
5173
  "pluginAlias": "@salesforce/plugin-flow",
5252
5174
  "pluginName": "@salesforce/plugin-flow",
5253
5175
  "pluginType": "jit",
5176
+ "state": "preview",
5254
5177
  "strict": true,
5255
- "summary": "Invoke flow tests in an org.",
5178
+ "summary": "Display test results for a specific asynchronous test run.",
5256
5179
  "enableJsonFlag": true,
5257
5180
  "isESM": true,
5258
5181
  "relativePath": [
5259
5182
  "lib",
5260
5183
  "commands",
5261
5184
  "flow",
5262
- "run",
5263
- "test.js"
5185
+ "get",
5186
+ "log.js"
5264
5187
  ],
5265
5188
  "aliasPermutations": [],
5266
5189
  "permutations": [
5267
- "flow:run:test",
5268
- "run:flow:test",
5269
- "run:test:flow",
5270
- "flow:test:run",
5271
- "test:flow:run",
5272
- "test:run:flow"
5190
+ "flow:get:log",
5191
+ "get:flow:log",
5192
+ "get:log:flow",
5193
+ "flow:log:get",
5194
+ "log:flow:get",
5195
+ "log:get:flow"
5273
5196
  ]
5274
5197
  },
5275
- "flow:get:log": {
5198
+ "flow:get:test": {
5276
5199
  "aliases": [],
5277
5200
  "args": {},
5278
5201
  "description": "Provide a flow test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the \"sf flow run test\" command.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for flow tests in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.",
@@ -5315,21 +5238,30 @@
5315
5238
  "multiple": false,
5316
5239
  "type": "option"
5317
5240
  },
5318
- "log-id": {
5241
+ "test-run-id": {
5319
5242
  "char": "i",
5320
- "name": "log-id",
5321
- "summary": "ID of the specific log to display.",
5243
+ "name": "test-run-id",
5244
+ "required": true,
5245
+ "summary": "ID of the test run.",
5322
5246
  "hasDynamicHelp": false,
5323
5247
  "multiple": false,
5324
5248
  "type": "option"
5325
5249
  },
5326
- "number": {
5327
- "char": "n",
5328
- "name": "number",
5329
- "summary": "Number of the most recent logs to display.",
5330
- "hasDynamicHelp": false,
5331
- "multiple": false,
5332
- "type": "option"
5250
+ "code-coverage": {
5251
+ "char": "c",
5252
+ "name": "code-coverage",
5253
+ "summary": "Retrieve code coverage results.",
5254
+ "allowNo": false,
5255
+ "type": "boolean"
5256
+ },
5257
+ "detailed-coverage": {
5258
+ "dependsOn": [
5259
+ "code-coverage"
5260
+ ],
5261
+ "name": "detailed-coverage",
5262
+ "summary": "Not available for flow tests.",
5263
+ "allowNo": false,
5264
+ "type": "boolean"
5333
5265
  },
5334
5266
  "output-dir": {
5335
5267
  "char": "d",
@@ -5338,16 +5270,35 @@
5338
5270
  "hasDynamicHelp": false,
5339
5271
  "multiple": false,
5340
5272
  "type": "option"
5273
+ },
5274
+ "result-format": {
5275
+ "char": "r",
5276
+ "name": "result-format",
5277
+ "summary": "Format of the test results.",
5278
+ "default": "human",
5279
+ "hasDynamicHelp": false,
5280
+ "multiple": false,
5281
+ "options": [
5282
+ "human",
5283
+ "tap",
5284
+ "junit",
5285
+ "json"
5286
+ ],
5287
+ "type": "option"
5288
+ },
5289
+ "concise": {
5290
+ "name": "concise",
5291
+ "summary": "Display only failed test results; works with human-readable output only.",
5292
+ "allowNo": false,
5293
+ "type": "boolean"
5341
5294
  }
5342
5295
  },
5343
5296
  "hasDynamicHelp": true,
5344
- "hidden": true,
5345
5297
  "hiddenAliases": [],
5346
- "id": "flow:get:log",
5298
+ "id": "flow:get:test",
5347
5299
  "pluginAlias": "@salesforce/plugin-flow",
5348
5300
  "pluginName": "@salesforce/plugin-flow",
5349
5301
  "pluginType": "jit",
5350
- "state": "preview",
5351
5302
  "strict": true,
5352
5303
  "summary": "Display test results for a specific asynchronous test run.",
5353
5304
  "enableJsonFlag": true,
@@ -5357,27 +5308,28 @@
5357
5308
  "commands",
5358
5309
  "flow",
5359
5310
  "get",
5360
- "log.js"
5311
+ "test.js"
5361
5312
  ],
5362
5313
  "aliasPermutations": [],
5363
5314
  "permutations": [
5364
- "flow:get:log",
5365
- "get:flow:log",
5366
- "get:log:flow",
5367
- "flow:log:get",
5368
- "log:flow:get",
5369
- "log:get:flow"
5315
+ "flow:get:test",
5316
+ "get:flow:test",
5317
+ "get:test:flow",
5318
+ "flow:test:get",
5319
+ "test:flow:get",
5320
+ "test:get:flow"
5370
5321
  ]
5371
5322
  },
5372
- "flow:get:test": {
5323
+ "flow:run:test": {
5373
5324
  "aliases": [],
5374
5325
  "args": {},
5375
- "description": "Provide a flow test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the \"sf flow run test\" command.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for flow tests in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.",
5326
+ "description": "Specify which tests to run by using the --class-names flag followed by the names of the flows you want to test. For example, if you save a flow with the name Flow1, then use: --class-names Flow1.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for classes in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.\n\nBy default, \"flow run test\" runs asynchronously and immediately returns a test run ID. If you use the -–synchronous flag, you can use the --wait flag to specify the number of minutes to wait; if the tests finish in that timeframe, the command displays the results. If the tests haven't finished by the end of the wait time, the command displays a test run ID. Use the \"flow get test --test-run-id\" command to get the results.\n\nTo run both Flow and Apex tests together, run the \"sf logic run test\" CLI command, which has similar flags as this command, but expands the --tests flag to also include Apex tests.\n\nYou must have the \"View All Data\" org system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.",
5376
5327
  "examples": [
5377
- "Display flow test results for your default org using a test run ID:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id>",
5378
- "Similar to previous example, but output the result in JUnit format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --result-format junit",
5379
- "Also retrieve code coverage results and output in JSON format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --json",
5380
- "Specify a directory in which to save the test results from the org with the “me@my.org” username (rather than your default org):\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@my.org'"
5328
+ "Run all local tests in your default org:\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests",
5329
+ "Run all the Flow1 and Flow2 flow tests in the org with alias “scratchOrg”:\n<%= config.bin %> <%= command.id %> --target-org scratchOrg --class-names Flow1 --class-names Flow2",
5330
+ "Run specific Flow1 and Flow2 flow tests in your default org:\n<%= config.bin %> <%= command.id %> --tests Flow1.Test1 --tests Flow2.Test2 --test-level RunSpecifiedTests",
5331
+ "Run all tests synchronously in your default org; the command waits to display the test results until all tests finish:\n<%= config.bin %> <%= command.id %> –synchronous",
5332
+ "Run all local tests in the org with the username “me@my.org”; save the output to the specified directory:\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests --output-dir /Users/susan/temp/cliOutput --target-org me@my.org"
5381
5333
  ],
5382
5334
  "flags": {
5383
5335
  "json": {
@@ -5412,11 +5364,31 @@
5412
5364
  "multiple": false,
5413
5365
  "type": "option"
5414
5366
  },
5415
- "test-run-id": {
5416
- "char": "i",
5417
- "name": "test-run-id",
5418
- "required": true,
5419
- "summary": "ID of the test run.",
5367
+ "result-format": {
5368
+ "char": "r",
5369
+ "name": "result-format",
5370
+ "summary": "Format of the test results.",
5371
+ "default": "human",
5372
+ "hasDynamicHelp": false,
5373
+ "multiple": false,
5374
+ "options": [
5375
+ "human",
5376
+ "tap",
5377
+ "junit",
5378
+ "json"
5379
+ ],
5380
+ "type": "option"
5381
+ },
5382
+ "concise": {
5383
+ "name": "concise",
5384
+ "summary": "Display only failed test results; works with human-readable output only.",
5385
+ "allowNo": false,
5386
+ "type": "boolean"
5387
+ },
5388
+ "output-dir": {
5389
+ "char": "d",
5390
+ "name": "output-dir",
5391
+ "summary": "Directory in which to store test result files.",
5420
5392
  "hasDynamicHelp": false,
5421
5393
  "multiple": false,
5422
5394
  "type": "option"
@@ -5428,70 +5400,98 @@
5428
5400
  "allowNo": false,
5429
5401
  "type": "boolean"
5430
5402
  },
5431
- "detailed-coverage": {
5432
- "dependsOn": [
5433
- "code-coverage"
5434
- ],
5435
- "name": "detailed-coverage",
5436
- "summary": "Not available for flow tests.",
5403
+ "synchronous": {
5404
+ "char": "y",
5405
+ "name": "synchronous",
5406
+ "summary": "Run flow tests for one flow synchronously; if not specified, tests are run asynchronously.",
5437
5407
  "allowNo": false,
5438
5408
  "type": "boolean"
5439
5409
  },
5440
- "output-dir": {
5441
- "char": "d",
5442
- "name": "output-dir",
5443
- "summary": "Directory in which to store test result files.",
5410
+ "test-level": {
5411
+ "char": "l",
5412
+ "description": "Here's what the levels mean:\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages.\n- RunAllTestsInOrg — All tests are run. The tests include all tests in your org, including tests of managed packages.\n- RunSpecifiedTests - Only the tests that you specify with the --tests flag are run.",
5413
+ "name": "test-level",
5414
+ "summary": "Level of tests to run; default is RunLocalTests.",
5444
5415
  "hasDynamicHelp": false,
5445
5416
  "multiple": false,
5417
+ "options": [
5418
+ "RunLocalTests",
5419
+ "RunAllTestsInOrg",
5420
+ "RunSpecifiedTests"
5421
+ ],
5446
5422
  "type": "option"
5447
5423
  },
5448
- "result-format": {
5449
- "char": "r",
5450
- "name": "result-format",
5451
- "summary": "Format of the test results.",
5452
- "default": "human",
5424
+ "class-names": {
5425
+ "aliases": [
5426
+ "classnames"
5427
+ ],
5428
+ "char": "n",
5429
+ "description": "Default is all flow tests. If you select --class-names, you can't specify --tests.",
5430
+ "exclusive": [
5431
+ "suite-names",
5432
+ "tests"
5433
+ ],
5434
+ "name": "class-names",
5435
+ "summary": "Flow names that contain flow tests to run.",
5453
5436
  "hasDynamicHelp": false,
5454
- "multiple": false,
5455
- "options": [
5456
- "human",
5457
- "tap",
5458
- "junit",
5459
- "json"
5437
+ "multiple": true,
5438
+ "type": "option"
5439
+ },
5440
+ "suite-names": {
5441
+ "aliases": [
5442
+ "suitenames"
5443
+ ],
5444
+ "char": "s",
5445
+ "description": "Not available for flow tests.",
5446
+ "exclusive": [
5447
+ "class-names",
5448
+ "tests"
5460
5449
  ],
5450
+ "name": "suite-names",
5451
+ "summary": "Not available for flow tests.",
5452
+ "hasDynamicHelp": false,
5453
+ "multiple": true,
5461
5454
  "type": "option"
5462
5455
  },
5463
- "concise": {
5464
- "name": "concise",
5465
- "summary": "Display only failed test results; works with human-readable output only.",
5466
- "allowNo": false,
5467
- "type": "boolean"
5456
+ "tests": {
5457
+ "char": "t",
5458
+ "description": "Default is all flow tests. If you specify --tests, you can't specify --class-names.",
5459
+ "exclusive": [
5460
+ "class-names",
5461
+ "suite-names"
5462
+ ],
5463
+ "name": "tests",
5464
+ "summary": "Flow test names to run.",
5465
+ "hasDynamicHelp": false,
5466
+ "multiple": true,
5467
+ "type": "option"
5468
5468
  }
5469
5469
  },
5470
5470
  "hasDynamicHelp": true,
5471
5471
  "hiddenAliases": [],
5472
- "id": "flow:get:test",
5472
+ "id": "flow:run:test",
5473
5473
  "pluginAlias": "@salesforce/plugin-flow",
5474
5474
  "pluginName": "@salesforce/plugin-flow",
5475
5475
  "pluginType": "jit",
5476
5476
  "strict": true,
5477
- "summary": "Display test results for a specific asynchronous test run.",
5477
+ "summary": "Invoke flow tests in an org.",
5478
5478
  "enableJsonFlag": true,
5479
5479
  "isESM": true,
5480
5480
  "relativePath": [
5481
5481
  "lib",
5482
5482
  "commands",
5483
5483
  "flow",
5484
- "get",
5484
+ "run",
5485
5485
  "test.js"
5486
5486
  ],
5487
5487
  "aliasPermutations": [],
5488
5488
  "permutations": [
5489
- "flow:get:test",
5490
- "get:flow:test",
5491
- "get:test:flow",
5492
- "flow:test:get",
5493
- "test:flow:get",
5494
- "test:get:flow"
5489
+ "flow:run:test",
5490
+ "run:flow:test",
5491
+ "run:test:flow",
5492
+ "flow:test:run",
5493
+ "test:flow:run",
5494
+ "test:run:flow"
5495
5495
  ]
5496
5496
  },
5497
5497
  "lightning:dev:app": {
@@ -7006,5 +7006,5 @@
7006
7006
  "requiresProject": true
7007
7007
  }
7008
7008
  },
7009
- "version": "2.151.5"
7009
+ "version": "2.152.0"
7010
7010
  }