fix: updating documentation, README and messages

Author: pcon

README.md

@@ -1,116 +1,38 @@
-# pubsub
+# @pcon/pubsub
 
-[![NPM](https://img.shields.io/npm/v/pubsub.svg?label=pubsub)](https://www.npmjs.com/package/pubsub) [![Downloads/week](https://img.shields.io/npm/dw/pubsub.svg)](https://npmjs.org/package/pubsub) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/pubsub/main/LICENSE.txt)
+[![NPM](https://img.shields.io/npm/v/@pcon/pubsub.svg?label=sf-cli-pubsub)](https://www.npmjs.com/package/@pcon/sf-cli-pubsub) [![Downloads/week](https://img.shields.io/npm/dw/@pcon/sf-cli-pubsub.svg)](https://npmjs.org/package/@pcon/sf-cli-pubsub)
 
-## Using the template
+## Setup
 
-This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
+### Install Latest
 
-1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
-2. Generate your plugin:
-
-   ```
-   sf plugins install dev
-   sf dev generate plugin
-
-   git init -b main
-   git add . && git commit -m "chore: initial commit"
-   ```
-
-3. Create your plugin's repo in the salesforcecli github org
-4. When you're ready, replace the contents of this README with the information you want.
-
-## Learn about `sf` plugins
-
-Salesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
-
-This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce.
-
-Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.
-
-### Tooling
-
-- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
-- [@salesforce/kit](https://github.com/forcedotcom/kit)
-- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
-- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
-- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
-- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
-- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
-
-### Hooks
-
-For cross clouds commands, e.g. `sf env list`, we utilize [oclif hooks](https://oclif.io/docs/hooks) to get the relevant information from installed plugins.
-
-This plugin includes sample hooks in the [src/hooks directory](src/hooks). You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.
-
-# Everything past here is only a suggestion as to what should be in your specific plugin's description
-
-This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
-
-We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
-
-## Install
-
-```bash
-sf plugins install pubsub@x.y.z
+```
+sf plugins install @pcon/sf-cli-pubsub
 ```
 
-## Issues
-
-Please report any issues at https://github.com/forcedotcom/cli/issues
-
-## Contributing
-
-1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
-2. Create a new issue before starting your project so that we can keep track of
-   what you are trying to add/fix. That way, we can also offer suggestions or
-   let you know if there is already an effort in progress.
-3. Fork this repository.
-4. [Build the plugin locally](#build)
-5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
-6. Edit the code in your fork.
-7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
-8. Sign CLA (see [CLA](#cla) below).
-9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
-
-### CLA
-
-External contributors will be required to sign a Contributor's License
-Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
-
-### Build
-
-To build the plugin locally, make sure to have yarn installed and run the following commands:
-
-```bash
-# Clone the repository
-git clone git@github.com:salesforcecli/pubsub
+You will be prompted to confirm that you want to install an unsigned plugin. Choose "yes"
 
-# Install the dependencies and compile
-yarn && yarn build
+```
+This plugin is not digitally signed and its authenticity cannot be verified. Continue installation y/n?: y
 ```
 
-To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+To allowlist this plugin, [add an entry for it in $HOME/.config/sfdx/unsignedPluginAllowList.json](https://developer.salesforce.com/blogs/2017/10/salesforce-dx-cli-plugin-update.html).
+
+### Install Older Version
 
 ```bash
-# Run using local run file.
-./bin/dev hello world
+sf plugins install @pcon/sf-cli-pubsub@x.y.z
 ```
 
-There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
+## Issues
 
-```bash
-# Link your plugin to the sf cli
-sf plugins link .
-# To verify
-sf plugins
-```
+Please report any issues at https://github.com/pcon/sf-cli-pubsub/issues
 
 ## Commands
 
 <!-- commands -->
-* [`sf pubsub subscribe`](#sf-pubsub-subscribe)
+
+- [`sf pubsub subscribe`](#sf-pubsub-subscribe)
 
 ## `sf pubsub subscribe`
 
@@ -146,4 +68,5 @@ FLAG DESCRIPTIONS
 
     More information about a flag. Don't repeat the summary.
 ```
+
 <!-- commandsstop -->

messages/pubsub.subscribe.md

@@ -1,27 +1,27 @@
 # summary
 
-Summary of a command.
+Subscribes to one or more topics.
 
 # description
 
-More information about a command. Don't repeat the summary.
+Connects to a pub / sub endpoint and logs the message to the console.
 
-# flags.name.summary
+# flags.count.summary
 
-Description of a flag.
+The number of messages to watch for.
 
-# flags.name.description
+# flags.count.description
 
-More information about a flag. Don't repeat the summary.
+The number of messages to wait for before exiting. Defaults to 100.
 
-# examples
+# flags.topic.summary
 
-- <%= config.bin %> <%= command.id %>
+The topic to subscribe to.
 
-# flags.count.summary
+# flags.topic.description
 
-The number of messages to watch for.
+The path to the topic to subscribe too. Typically starts with either "/data/" or "/event/"
 
-# flags.topic.summary
+# examples
 
-The topic to subscribe to.
+- <%= config.bin %> <%= command.id %> --target-org myTargetOrg --topic "/data/CaseChangeEvent" --topic "/event/My_Event**e" --topic "/data/My_Object**ChangeEvent"

package.json

@@ -47,7 +47,12 @@
     ],
     "topics": {
       "pubsub": {
-        "description": "description for pubsub"
+        "description": "A toolchain to help with pubsub related tasks",
+        "subtopics": {
+          "subscribe": {
+            "description": "Subscribe to topics"
+          }
+        }
       }
     },
     "flexibleTaxonomy": true
@@ -184,5 +189,7 @@
   },
   "exports": "./lib/index.js",
   "type": "module",
-  "author": "Patrick Connelly"
+  "author": "Patrick Connelly",
+  "bugs": "https://github.com/pcon/sf-cli-pubsub/issues",
+  "repository": "github:pcon/sf-cli-pubsub"
 }

src/commands/pubsub/subscribe.ts

@@ -30,12 +30,6 @@ export default class PubsubSubscribe extends SfCommand<undefined> {
   public static readonly examples = messages.getMessages('examples');
 
   public static readonly flags = {
-    name: Flags.string({
-      summary: messages.getMessage('flags.name.summary'),
-      description: messages.getMessage('flags.name.description'),
-      char: 'n',
-      required: false,
-    }),
     'target-org': Flags.requiredOrg(),
     count: Flags.integer({
       summary: messages.getMessage('flags.count.summary'),