hubot-help - npm Package Compare versions

Comparing version 0.2.0 to 0.2.2

package.json

 {
   "name": "hubot-help",
   "description": "A hubot script to show available hubot commands",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "author": "Josh Nichols <[e-mail]>",
@@ -19,20 +19,27 @@ "license": "MIT",
   "peerDependencies": {
-    "hubot": "2.x"
+    "hubot": ">=2 <10 || 0.0.0-development",
+    "coffee-script": "^1.12.6"
   },
   "devDependencies": {
-    "mocha": "*",
-    "chai": "*",
-    "sinon-chai": "*",
-    "sinon": "*",
+    "chai": "~3.5.0",
+    "coffee-coverage": "~1.0.1",
+    "coffee-script": "^1.12.6",
+    "coffeelint": "^1.16.0",
+    "grunt": "~1.0.1",
+    "grunt-contrib-watch": "~1.0.0",
     "grunt-mocha-test": "~0.7.0",
-    "grunt-release": "~0.6.0",
+    "grunt-release": "~0.14.0",
+    "hubot": "2.x",
+    "hubot-mock-adapter": "~1.0.0",
+    "istanbul": "~0.4.5",
     "matchdep": "~0.1.2",
-    "grunt-contrib-watch": "~0.5.3",
-    "hubot-mock-adapter": "~1.0.0",
-    "hubot": "2.x"
+    "mocha": "~3.0.2",
+    "sinon": "~1.4.2",
+    "sinon-chai": "~2.8.0"
   },
   "main": "index.coffee",
   "scripts": {
-    "test": "grunt test"
+    "test": "mocha",
+    "posttest": "coffeelint **/*.coffee index.coffee && istanbul report text-summary lcov"
   }
 }

README.md

@@ -1,3 +0,7 @@
-# hubot-help
+Hubot Help Plugin
+==================
 
+[![Version](https://img.shields.io/npm/v/hubot-help.svg)](https://www.npmjs.com/package/hubot-help)
+[![Build Status](https://img.shields.io/travis/hubotio/hubot-help.svg)](https://travis-ci.org/hubotio/hubot-help)
+
 A hubot script to show available hubot commands
@@ -7,3 +11,4 @@
 
-## Installation
+Installation
+-----------------
 
@@ -20,9 +25,26 @@ In hubot project repo, run:
 
-## Sample Interaction
+Configuration
+-----------------
 
-```
-user1>> hubot help
-hubot>> hubot help - Displays all of the help commands that Hubot knows about.
-hubot>> hubot help <query> - Displays all help commands that match <query>.
+You can set various environment variables to tune up the behavior of thios help plugin:
 
+- `HUBOT_HELP_REPLY_IN_PRIVATE` (set to any value) will force calls to `hubot help` to be answered in private
+- `HUBOT_HELP_DISABLE_HTTP` (set to any value) will disable the web interface for help
+- `HUBOT_HELP_HIDDEN_COMMANDS` comma-separated list of commands that will not be displayed in help
+
+Development
+-----------------
+
+For tests:
+
+    npm test
+
+
+Sample Interaction
+-----------------
+
 ```
+ user> hubot help
+hubot> hubot help - Displays all of the help commands that this bot knows about.
+hubot> hubot help <query> - Displays all help commands that match <query>.
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7191

increased by31.32%

Number of lines in readme file

49

increased by81.48%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

15

increased by50%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes