chore(release): 2.0.1 [skip ci]

svc-cli-bot · svc-cli-bot · commit 8151ea71b97d · 2023-11-21T17:51:57.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+## [2.0.1](https://github.com/salesforcecli/plugin-dev/compare/1.3.3...2.0.1) (2023-11-21)
+
+
+### Bug Fixes
+
+* dev.js ([150bee6](https://github.com/salesforcecli/plugin-dev/commit/150bee645e793acdd96f587caf5c23fe1de98b20))
+* esm and cjs command test templates ([dbb4678](https://github.com/salesforcecli/plugin-dev/commit/dbb4678dfdc2e57b2ad03bf5a9ab08bc67b6da80))
+* no windows sep in imports ([a00812c](https://github.com/salesforcecli/plugin-dev/commit/a00812c6af491420cb2c1172c11d561b7041ee1c))
+* remove all requires ([63c8b2b](https://github.com/salesforcecli/plugin-dev/commit/63c8b2b10781105e1f601517661bbb33d02306e4))
+* replace require.resolve ([00ff1cc](https://github.com/salesforcecli/plugin-dev/commit/00ff1cc0fc2b14b50848d3f3499aaba2348d5491))
+* use proper bin script for running schema generate on 2pp ([0195029](https://github.com/salesforcecli/plugin-dev/commit/019502922888aed1bfe93e45a850a5ec87b05f7a))
+* use replaceAll ([d2585f2](https://github.com/salesforcecli/plugin-dev/commit/d2585f2de6c147e4688490ffeadcec52085add60))
+
+
+
 ## [1.3.3](https://github.com/salesforcecli/plugin-dev/compare/1.3.2...1.3.3) (2023-11-11)
 
 
diff --git a/README.md b/README.md
@@ -111,113 +111,266 @@ sf plugins
 ## Commands
 
 <!-- commands -->
+* [`sf dev audit messages`](#sf-dev-audit-messages)
+* [`sf dev configure repo`](#sf-dev-configure-repo)
+* [`sf dev configure secrets`](#sf-dev-configure-secrets)
+* [`sf dev convert messages`](#sf-dev-convert-messages)
+* [`sf dev convert script`](#sf-dev-convert-script)
+* [`sf dev generate command`](#sf-dev-generate-command)
+* [`sf dev generate flag`](#sf-dev-generate-flag)
+* [`sf dev generate library`](#sf-dev-generate-library)
+* [`sf dev generate plugin`](#sf-dev-generate-plugin)
 
-- [plugin-dev](#plugin-dev)
-  - [Install](#install)
-  - [Usage](#usage)
-    - [Generate a new `sf` plugin](#generate-a-new-sf-plugin)
-    - [Generate a new `sf` command in your plugin](#generate-a-new-sf-command-in-your-plugin)
-    - [Generate a hook that will be used for existing `sf` commands](#generate-a-hook-that-will-be-used-for-existing-sf-commands)
-  - [Issues](#issues)
-  - [Contributing](#contributing)
-    - [CLA](#cla)
-    - [Build](#build)
-  - [Commands](#commands)
-  - [`sf dev generate command`](#sf-dev-generate-command)
-  - [`sf dev generate flag`](#sf-dev-generate-flag)
-  - [`sf dev generate hook`](#sf-dev-generate-hook)
-  - [`sf dev generate library`](#sf-dev-generate-library)
-  - [`sf dev generate plugin`](#sf-dev-generate-plugin)
-  - [`sf dev hook HOOK`](#sf-dev-hook-hook)
+## `sf dev audit messages`
 
-## `sf dev generate command`
+Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.
 
-Generate a new sf command.
+```
+USAGE
+  $ sf dev audit messages [--json] [-p <value>] [-m <value>] [-s <value>]
+
+FLAGS
+  -m, --messages-dir=<value>  [default: messages] Directory that contains the plugin's message files.
+  -p, --project-dir=<value>   [default: .] Location of the project where messages are to be audited.
+  -s, --source-dir=<value>    [default: src] Directory that contains the plugin's source code.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+EXAMPLES
+  Audit messages using default directories:
+
+    $ sf dev audit messages
+
+  Audit messages in the "messages" directory in the current working directory; the plugin's source directory is in
+  "src":
+
+    $ sf dev audit messages --messages-dir ./messages --source-dir ./src
+
+FLAG DESCRIPTIONS
+  -m, --messages-dir=<value>  Directory that contains the plugin's message files.
+
+    The default is the "messages" directory in the current working directory.
+
+  -s, --source-dir=<value>  Directory that contains the plugin's source code.
+
+    The default is the "src" directory in the current working directory.
+```
+
+_See code: [src/commands/dev/audit/messages.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/audit/messages.ts)_
+
+## `sf dev configure repo`
+
+Configure a GitHub repo for the GitHub Actions pipeline.
 
 ```
 USAGE
-  $ sf dev generate command -n <value> [--force] [--nuts] [--unit]
+  $ sf dev configure repo -r <value> [--json] [-d] [-b <value>]
 
 FLAGS
-  -n, --name=<value>  (required) Name of the new command. Use colons to separate the topic and command names.
-  --force             Overwrite existing files.
-  --[no-]nuts         Generate a NUT test file for the command.
-  --[no-]unit         Generate a unit test file for the command.
+  -b, --bot=<value>         [default: SF-CLI-BOT] GitHub login/username for the bot.
+  -d, --dry-run             Make no changes.
+  -r, --repository=<value>  (required) GitHub owner/repo for which you want to configure GitHub Actions.
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
-  Generate a new sf command.
+  Configure a GitHub repo for the GitHub Actions pipeline.
 
-  You must run this command from within a plugin directory, such as the directory created with the "sf generate plugin"
-  command.
+  Sets up labels and exempts the CLI bot for branch protection and PR rules.
 
-  The command updates the package.json file, so if it detects conflicts with the existing file, you're prompted whether
-  you want to overwrite the file. There are a number of package.json updates required for a new command, so we recommend
-  you answer "y" so the command takes care of them all. If you answer "n", you must update the package.json file
-  manually.
+EXAMPLES
+  Configure the repo "testPackageRelease", with owner "salesforcecli", for GitHub Actions.
+
+    $ sf dev configure repo --repository salesforcecli/testPackageRelease
+```
 
-  The command generates basic source, messages (\*.md), and test files for your command.  The Typescript files contain
-  import statements for the minimum required Salesforce libraries, and scaffold some basic code. The new type names come
-  from the value you passed to the --name flag.
+_See code: [src/commands/dev/configure/repo.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/configure/repo.ts)_
+
+## `sf dev configure secrets`
+
+Ensures a GitHub repo has correct access to secrets based on its workflows.
+
+```
+USAGE
+  $ sf dev configure secrets -r <value> [--json] [-d]
+
+FLAGS
+  -d, --dry-run             Make no changes.
+  -r, --repository=<value>  (required) Github owner/repo.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Ensures a GitHub repo has correct access to secrets based on its workflows.
+
+  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).
+
+  This command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the
+  repo secrets.
 
 EXAMPLES
-  Generate the files for a new "sf my exciting command":
+  Ensure secrets access for the repo "testPackageRelease", with owner "salesforcecli":
 
-    $ sf dev generate command --name my:exciting:command
+  $ sf dev configure secrets --repository salesforcecli/testPackageRelease
 ```
 
-## `sf dev generate flag`
+_See code: [src/commands/dev/configure/secrets.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/configure/secrets.ts)_
+
+## `sf dev convert messages`
 
-Summary of a command.
+Convert a .json messages file into Markdown.
 
 ```
 USAGE
-  $ sf dev generate flag [-d]
+  $ sf dev convert messages -f <value> [--json] [-p <value>]
 
 FLAGS
-  -d, --dry-run  Print new flag instead of adding it to the command file.
+  -f, --file-name=<value>...  (required) Filename to convert.
+  -p, --project-dir=<value>   [default: .] Location of the project whose messages are to be converted.
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
-  Summary of a command.
+  Convert a .json messages file into Markdown.
 
-  Description of a command.
+  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.
 
 EXAMPLES
-  $ sf dev generate flag
+  Convert the my-command.json message file into my-command.md with the standard messages headers:
+
+    $ sf dev convert messages --filename my-command.json
+
+  Similar to previous example, but specify the plugin project directory:
+
+  $ sf dev convert messages --project-dir ./path/to/plugin --filename my-command.json
 ```
 
-## `sf dev generate hook`
+_See code: [src/commands/dev/convert/messages.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/convert/messages.ts)_
 
-Generate a new sf hook.
+## `sf dev convert script`
+
+Convert a script file that contains deprecated sfdx-style commands to use the new sf-style commands instead.
 
 ```
 USAGE
-  $ sf dev generate hook --event sf:env:list|sf:env:display|sf:deploy|sf:logout [--force]
+  $ sf dev convert script -s <value> [--json]
 
 FLAGS
-  --event=<option>  (required) Event to run hook on. Use colons to separate topic and command names of the event.
-                    <options: sf:env:list|sf:env:display|sf:deploy|sf:logout>
-  --force           Overwrite existing files.
+  -s, --script=<value>  (required) Filepath to the script you want to convert.
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
-  Generate a new sf hook.
+  Convert a script file that contains deprecated sfdx-style commands to use the new sf-style commands instead.
 
-  You must run this command from within a plugin directory, such as the directory created with the "sf generate plugin"
-  command.
+  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.
+
+  This 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.
+
+  This 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".
+
+EXAMPLES
+  Convert the YAML file called "myScript.yml" located in the current directory; the new file that contains the
+  replacements is called "myScript-converted.yml":
+
+    $ sf dev convert script --script ./myScript.yml
+```
+
+_See code: [src/commands/dev/convert/script.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/convert/script.ts)_
+
+## `sf dev generate command`
+
+Generate a new sf command.
+
+```
+USAGE
+  $ sf dev generate command -n <value> [--force] [--nuts] [--unit]
+
+FLAGS
+  -n, --name=<value>  (required) Name of the new command. Use colons to separate the topic and command names.
+      --force         Overwrite existing files.
+      --[no-]nuts     Generate a NUT test file for the command.
+      --[no-]unit     Generate a unit test file for the command.
+
+DESCRIPTION
+  Generate a new sf command.
+
+  You must run this command from within a plugin directory, such as the directory created with the "sf dev generate
+  plugin" command.
+
+  The command generates basic source files, messages (\*.md), and test files for your new command.  The Typescript files
+  contain import statements for the minimum required Salesforce libraries, and scaffold some basic code. The new type
+  names come from the value you passed to the --name flag.
 
   The command updates the package.json file, so if it detects conflicts with the existing file, you're prompted whether
-  you want to overwrite the file. There are a number of package.json updates required for a new hook, so we recommend
+  you want to overwrite the file. There are a number of package.json updates required for a new command, so we recommend
   you answer "y" so the command takes care of them all. If you answer "n", you must update the package.json file
   manually.
 
-  The command generates a basic Typescript source file in the "src/hooks" directory to get you started. The source
-  file's name is based on the event you're hooking into, such as envList.ts for the "sf env list" command.
+EXAMPLES
+  Generate the files for a new "sf my exciting command":
+
+    $ sf dev generate command --name my:exciting:command
+```
+
+_See code: [src/commands/dev/generate/command.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/generate/command.ts)_
+
+## `sf dev generate flag`
+
+Generate a flag for an existing command.
+
+```
+USAGE
+  $ sf dev generate flag [-d]
+
+FLAGS
+  -d, --dry-run  Print new flag code instead of adding it to the command file.
+
+DESCRIPTION
+  Generate a flag for an existing command.
+
+  You must run this command from within a plugin directory, such as the directory created with the "sf dev generate
+  plugin" command.
+
+  This command is interactive. It first discovers all the commands currently implemented in the plugin, and asks you
+  which you want to create a new flag for. It then prompts for other flag properties, such as its long name, optional
+  short name, type, whether it's required, and so on. Long flag names must be kebab-case and not camelCase. The command
+  doesn't let you use an existing long or short flag name. When the command completes, the Typescript file for the
+  command is updated with the code for the new flag.
+
+  Use the --dry-run flag to review new code for the command file without actually udpating it.
 
 EXAMPLES
-  Generate source file for a hook into the "sf env display" command:
+  Generate a new flag and update the command file:
 
-    $ sf dev generate hook --event sf:env:display
+    $ sf dev generate flag
+
+  Don't actually update the command file, just view the generated code:
+
+    $ sf dev generate flag --dry-run
 ```
 
+_See code: [src/commands/dev/generate/flag.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/generate/flag.ts)_
+
 ## `sf dev generate library`
 
 Generate a new library.
@@ -240,6 +393,8 @@ EXAMPLES
   $ sf dev generate library
 ```
 
+_See code: [src/commands/dev/generate/library.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/generate/library.ts)_
+
 ## `sf dev generate plugin`
 
 Generate a new sf plugin.
@@ -259,35 +414,12 @@ DESCRIPTION
   When the command completes, your new plugin contains the source, message, and test files for a sample "sf hello world"
   command.
 
-EXAMPLES
-  $ sf dev generate plugin
-```
-
-## `sf dev hook HOOK`
-
-Run a hook. For testing purposes only.
-
-```
-USAGE
-  $ sf dev hook [HOOK] [--json] [-p <value>]
-
-ARGUMENTS
-  HOOK  Name of hook to execute.
-
-FLAGS
-  -p, --plugin=<value>  Specific plugin from which to execute hook
-
-GLOBAL FLAGS
-  --json  Format output as json.
+ALIASES
+  $ sf plugins generate
 
 EXAMPLES
-  Execute a hook by name:
-
-    $ sf dev hook sf:env:list
-
-  Execute a hook by name in a specific plugin:
-
-    $ sf dev hook sf:env:list --plugin env
+  $ sf dev generate plugin
 ```
 
+_See code: [src/commands/dev/generate/plugin.ts](https://github.com/salesforcecli/plugin-dev/blob/1.3.4/src/commands/dev/generate/plugin.ts)_
 <!-- commandsstop -->
diff --git a/package.json b/package.json
