clubhouse-cli - npm Package Compare versions

Comparing version 1.17.0 to 2.0.0

CHANGELOG.md

@@ -10,2 +10,4 @@ # Changelog
 ### Changed
+- Converted the code base to Typescript.
+- Fix formatting
 ### Deprecated
@@ -18,2 +20,10 @@ ### Removed
 
+## [2.0.0] - 2019-08-15
+### Added
+- Support Iterations filtering/assignment on stories.
+
+### Changed
+- Convert to TypeScript.
+- New formatting/argument syntax for Epic and story ID.
+
 ## [1.17.0] - 2019-03-19
@@ -20,0 +30,0 @@ ### Added

package.json

 {
   "name": "clubhouse-cli",
-  "version": "1.17.0",
+  "version": "2.0.0",
   "description": "A command line tool for viewing, creating and updating clubhouse.io stories",
@@ -9,9 +9,16 @@ "main": "index.js",
   },
+  "files": [
+    "build"
+  ],
   "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "start": "node -r source-map-support/register build/bin/club.js",
     "test": "npm run test:format",
-    "test:format": "prettier --list-different 'src/**/{club*,*.js}'",
-    "format": "prettier --write 'src/**/{club*,*.js}'"
+    "test:format": "prettier --list-different src/**/*.ts",
+    "format": "prettier --write src/**/*.ts",
+    "ci": "npm run build && npm run test"
   },
   "bin": {
-    "club": "./src/bin/club"
+    "club": "./build/bin/club.js"
   },
@@ -33,6 +40,6 @@ "repository": {
   "dependencies": {
-    "chalk": "^2.1.0",
+    "chalk": "^2.2.0",
     "cli-spinner": "^0.2.6",
-    "clubhouse-lib": "0.5.0",
-    "commander": "^2.11.0",
+    "clubhouse-lib": "0.7.0",
+    "commander": "^2.12.0",
     "debug": "^3.1.0",
@@ -42,2 +49,7 @@ "prompt": "^1.0.0"
   "devDependencies": {
+    "@types/chalk": "^2.2.0",
+    "@types/cli-spinner": "^0.2.0",
+    "@types/debug": "^4.1.2",
+    "@types/node": "^11.11.4",
+    "@types/node-fetch": "^2.1.7",
     "babel-eslint": "^8.0.1",
@@ -51,4 +63,6 @@ "eslint": "^4.10.0",
     "eslint-plugin-standard": "^3.0.1",
-    "prettier": "^1.16.4"
+    "prettier": "^1.18.2",
+    "source-map-support": "^0.5.11",
+    "typescript": "^3.4.5"
   }
 }

README.md

@@ -18,2 +18,3 @@ # clubhouse-cli
     - [Install](#install)
+    - [Developement](#developement)
 - [Acknowledgments](#acknowledgments)
@@ -72,3 +73,4 @@
     -s, --state [id|name]           Stories in workflow state id/name, by regex
-    -E, --epic [id|name]            Stories in epic id/name, by regex
+    --epic [id|name]                Stories in epic id/name, by regex
+    -i, --iteration [id|name]       Stories in iteration id/name, by regex
     -S, --save [name]               Save search configuration as workspace
@@ -88,9 +90,10 @@ -t, --text [name]               Stories with text in name, by regex
 #1480 Create Thinga-ma-bob
-  Type:    feature/3
-  Label:   #512 client_web
-  Epic:    #5 Things to do
-  Project: #14 Customers
-  Owners:  Josh (josh)
-  State:   #500000020 Code Review
-  URL:     https://app.clubhouse.io/story/1480
+  Type:      feature/3
+  Label:     #512 client_web
+  Epic:      #5 Things to do
+  Iteration: #52 Spaghetti
+  Project:   #14 Customers
+  Owners:    Josh (josh)
+  State:     #500000020 Code Review
+  URL:       https://app.clubhouse.io/story/1480
 
@@ -108,3 +111,3 @@ # Custom formatting is an option
 ~~~
-%i      Print ID of story
+%id     Print ID of story
 %t      Print title/name of story
@@ -115,3 +118,4 @@ %a      Print archived status of story
 %u      Print URL of story
-%E      Print epic of story
+%epic   Print epic of story
+%i      Print iteration of story
 %p      Print project of story
@@ -148,3 +152,4 @@ %y      Print story type
     --download-dir [path]     Directory to download files to
-    -E, --epic [id|name]      Update epic of story
+    --epic [id|name]          Update epic of story
+    -i, --iteration [id|name] Update iteration of story
     -f, --format [template]   Format story output by template
@@ -199,3 +204,4 @@ --from-git                Fetch story parsed by ID in current git branch
     -e, --estimate [number]   Set estimate of story
-    -E, --epic [id|name]      Set epic of story
+    --epic [id|name]          Set epic of story
+    -i, --iteration [id|name] Set iteration of story
     -I, --idonly              Print only ID of story result
@@ -321,2 +327,16 @@ -l, --label [id|name]     Stories with label id/name, by regex
 
+### Developement
+
+You can use typescript watcher which will recompile your code automatically:
+
+~~~sh
+$ npm run build:watch
+~~~
+
+You can run clubhouse-cli with typescript map enabled:
+
+~~~sh
+$ npm start -- story 1234
+~~~
+
 ## Acknowledgments
@@ -323,0 +343,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

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

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

274452

increased by343.82%

Lines of code

1675

increased by292.27%

Number of lines in readme file

344

increased by6.17%

Worsened metrics

Dev dependency count

16

increased by77.78%

Number of package files

20

decreased by-23.08%

Number of low supply chain risk alerts

3

increased by50%

Number of medium supply chain risk alerts

4

increased by300%

Dependency changes

• + Addedclubhouse-lib@0.7.0(transitive)

• - Removedclubhouse-lib@0.5.0(transitive)

• Updatedchalk@^2.2.0

• Updatedclubhouse-lib@0.7.0

• Updatedcommander@^2.12.0