cox - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

help.txt

@@ -23,2 +23,4 @@ COX - version {{version}}
 		usage: cox pull
+	merge - merge branch into the current branch
+		usage: cox merge <branch>
 	status - displays the GIT status of all repos
@@ -25,0 +27,0 @@ usage: cox status

package.json

 {
   "name": "cox",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "preferGlobal": "true",
@@ -5,0 +5,0 @@ "description": "git commander for multi-repositories",

README.md

 # cox
-CLI commander for developing with our current module system  
-Allows for running necessary tasks in the project folder and all the modules  
+CLI commander for developing with multiple submodules, each with their own Git repository.
+Cox runs both Git and NPM-related tasks on the project source folder, as well as all the versioned submodules.
+
+As such, a "cox checkout <branchName>" should be seen as : check out branch <branchName> in the project root, AS WELL
+as in all the submodules' repositories. This allows you to create a new feature (one that might affect contents in
+multiple submodules) recursively in a single command (see "cox start").
+
 All Cox commands should be run from the root of the main project.  
@@ -24,3 +29,3 @@
 ```
-Then runs `npm install` in these repositories too.
+Then runs `npm install` on these repositories too.
 
@@ -31,3 +36,3 @@ #### update
 ```
-runs npm update in the project folder and in all modules
+runs npm update in the project folder and in all submodules
 
@@ -37,14 +42,13 @@
 ```
-cox start XE-1234
+cox start <branchName>
 ```
-Start developing on a new branch <ticket>
+Start developing on a new branch with given <branchName>
 
-
 #### checkout
 ```
-cox checkout XE-1234
+cox checkout <branchName>
 //or to checkout a new branch:
-cox checkout -b XE-1234
+cox checkout -b <branchName>
 ```
-Change to another branch <ticket>
+Change to another branch <branchName>
 
@@ -55,3 +59,3 @@ #### reset
 ```
-runs 'git reset --hard' on all repos
+runs 'git reset --hard'.
 
@@ -62,3 +66,3 @@ #### pull
 ```
-GIT pulls the latest changes in the current branch
+GIT pulls the latest changes in the current branch.
 
@@ -91,12 +95,12 @@ #### status
 ```
-cox push <ticket>
+cox push <branchName>
 ```
-GIT pushes the latest changes in the current branch
+GIT pushes the latest changes in the current branch to origin
 
 #### kill
 ```
-cox kill <ticket>
+cox kill <branchName>
 ```
-checks out develop and kills the branch locally
+checks out develop, kills the branch locally and kills the branch remotely on origin (!)
 
-*Please use Cox responsibly, don't forget to use protection.*
+*Please use Cox responsibly, don't forget to use protection.*

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

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

17426

increased by7.55%

Number of package files

31

increased by3.33%

Lines of code

347

increased by4.83%

Number of lines in readme file

101

increased by5.21%

No dependency changes