@salesforce/plugin-limits - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -5,2 +5,4 @@ # Changelog
 
+### [1.0.1](https://github.com/salesforcecli/plugin-limits/compare/v1.0.0...v1.0.1) (2020-12-10)
+
 ## 1.0.0 (2020-11-16)
@@ -7,0 +9,0 @@

package.json

 {
     "name": "@salesforce/plugin-limits",
     "description": "commands to display api limits to your org",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "author": "Salesforce",
@@ -112,4 +112,4 @@ "bugs": "https://github.com/forcedotcom/cli/issues",
         "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/sfdx-cli-03032020.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/signatures/salesforce-plugin-limits-1.0.0.sig"
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/signatures/salesforce-plugin-limits-1.0.1.sig"
     }
 }

README.md

@@ -5,50 +5,70 @@ # plugin-limits
 
-## Getting Started
+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).
 
-To build the plugin locally, make sure to have yarn installed and run the following commands:
+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
+sfdx plugins:install limits@x.y.z
 ```
-Clone the repository
-  $ git clone [e-mail]:salesforcecli/plugin-user
-Install the dependencies and compile
-  $ yarn install
-  $ yarn prepack
-Link your plugin to the sfdx cli
-  $ sfdx plugins:link .
-To verify
-  $ sfdx plugins
-```
 
-## Debugging your plugin
+## Issues
 
-We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
+Please report any issues at https://github.com/forcedotcom/cli/issues
 
-To debug the `limits:api:display` command:
+## Contributing
 
-If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
+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.
 
-```sh-session
-$ sfdx limits:api:display -u [e-mail] --dev-suspend
+### 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 [e-mail]:salesforcecli/plugin-limits
+
+# Install the dependencies and compile
+yarn install
+yarn build
 ```
 
-Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
+To use your plugin, run using the local `./bin/run` or `./bin/run.cmd` file.
 
-```sh-session
-$ NODE_OPTIONS=--inspect-brk bin/run limits:api:display -u [e-mail]
+```bash
+# Run using local run file.
+./bin/run force:limits
 ```
 
-2. Set some breakpoints in your command code
-3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
-4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
-5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
-6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
-   ![how to debug](./.images/vscodeScreenshot.png)
-   Congrats, you are debugging!
+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.
 
+```bash
+# Link your plugin to the sfdx cli
+sfdx plugins:link .
+# To verify
+sfdx plugins
+```
+
 ## Commands
+<!-- commands -->
+- sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
 
-- sfdx limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+## `sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
-## `sfdx limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
-
 display current org’s limits
@@ -58,3 +78,3 @@
 USAGE
-  $ sfdx limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel
+  $ sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel
   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -81,1 +101,2 @@
 ```
+<!-- commandsstop -->

No alert changes

Improved metrics

Total package byte prevSize

14001

increased by4.83%

Number of lines in readme file

100

increased by26.58%

No dependency changes