@aurahelper/git-manager - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

package.json

@@ -5,3 +5,3 @@ {
   "displayName": "Aura Helper Framework Git Manager",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Aura Helper Git Manager Module its a module to handle and manage all git operations and commands.",
@@ -8,0 +8,0 @@ "main": "index.js",

README.md

 # **Aura Helper Git Manager Module**
+
+[![Version](https://img.shields.io/npm/v/@aurahelper/git-manager?logo=npm)](https://www.npmjs.com/package/@aurahelper/git-manager)
+[![Total Downloads](https://img.shields.io/npm/dt/@aurahelper/git-manager?logo=npm)](https://www.npmjs.com/package/@aurahelper/git-manager)
+[![Downloads/Month](https://img.shields.io/npm/dm/@aurahelper/git-manager?logo=npm)](https://www.npmjs.com/package/@aurahelper/git-manager)
+[![Issues](https://img.shields.io/github/issues/jjlongoria/aura-helper-git-manager)](https://github.com/JJLongoria/aura-helper-git-manager/issues)
+[![Known Vulnerabilities](https://snyk.io/test/github/JJLongoria/aura-helper-git-manager/badge.svg)](https://snyk.io/test/github/JJLongoria/aura-helper-git-manager)
+[![Code Size](https://img.shields.io/github/languages/code-size/jjlongoria/aura-helper-git-manager)](https://github.com/JJLongoria/aura-helper-git-manager)
+[![License](https://img.shields.io/github/license/jjlongoria/aura-helper-git-manager?logo=github)](https://github.com/JJLongoria/aura-helper-git-manager/blob/master/LICENSE)
+
 The Git Manager Module has an util methods to handle and manage git repository and has features to use in Aura Helper Framework. Yo can fetch data, list branches, get commits or get diffs from two branches, tags, commits...
@@ -26,3 +35,3 @@
 Path to the project under a git repository 
-- String
+- `String`
 
@@ -38,3 +47,3 @@ </br>
   - **projectFolder**: Path to the ignore file
-    - String
+    - `String`
 
@@ -100,7 +109,7 @@ </br>
 Return the GitManager instance
-- GitManager
+- `GitManager`
 
 ### **Examples:**
 **Set Project folder**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -110,3 +119,3 @@
     gitManager.setProjectFolder('path/to/project/root');
-
+```
 ---
@@ -119,3 +128,3 @@
 Return a String promise with the Git User Name
-- Promise\<String\>
+- `Promise<String>`
 
@@ -125,10 +134,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get git user name**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -143,2 +152,3 @@
     });
+```
 ---
@@ -151,3 +161,3 @@
 Return a String promise with the Git User Email
-- Promise\<String\>
+- `Promise<String>`
 
@@ -157,10 +167,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get git user email**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -175,2 +185,3 @@
     });
+```
 ---
@@ -183,3 +194,3 @@
 Return a String promise with the Git Author Name
-- Promise\<String\>
+- `Promise<String>`
 
@@ -189,10 +200,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get git author name**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -207,2 +218,3 @@
     });
+```
 ---
@@ -215,3 +227,3 @@
 Return a String promise with the Git Author Email
-- Promise\<String\>
+- `Promise<String>`
 
@@ -221,10 +233,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get git author email**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -239,2 +251,3 @@
     });
+```
 ---
@@ -247,3 +260,3 @@
 Return a String promise with the Git Committer Name
-- Promise\<String\>
+- `Promise<String>`
 
@@ -253,10 +266,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get git committer name**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -271,2 +284,3 @@
     });
+```
 ---
@@ -279,3 +293,3 @@
 Return a String promise with the Git Committer Email
-- Promise\<String\>
+- `Promise<String>`
 
@@ -285,10 +299,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get git committer email**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -303,2 +317,3 @@
     });
+```
 ---
@@ -312,3 +327,3 @@
 Return an empty promise when finish fetch process
-- Promise\<any\>
+- `Promise<any>`
 
@@ -318,10 +333,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Fetch data to the local project**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -336,2 +351,3 @@
     });
+```
 ---
@@ -344,3 +360,3 @@
 Returns a promise with an object list with branch name and active status
-- Promise\<Array\<Object\>\>
+- `Promise<Array<Object>>`
 
@@ -350,10 +366,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get branches from git project**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -369,2 +385,3 @@
     });
+```
 ---
@@ -381,3 +398,3 @@
 Returns a promise with a list of tags
-- Promise\<Array\<Object\>\>
+- `Promise<Array<Object>>`
 
@@ -387,10 +404,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get tags from git project**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -406,3 +423,3 @@
     });
-
+```
 ---
@@ -414,3 +431,3 @@ ## [**getCommits()**](#getcommits)
 Returns a promise with list of Commit objects
-- Promise\<Array\<Commit\>\>
+- `Promise<Array<Commit>>`
 
@@ -420,10 +437,10 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
 
 ### **Examples:**
 **Get commits data from git project**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -451,2 +468,3 @@
     });
+```
 ---
@@ -459,9 +477,9 @@
   - **source**: Source branch name, tag or commit for get diffs
-    - String
+    - `String`
   - **target**: Target branch name, tag or commit for get diffs
-    - String
+    - `String`
 
 ### **Return:**
 Returns a promise with GitDiffs objects list with the difference data
-- Promise\<Array\<GitDiff\>\>
+- `Promise<Array<GitDiff>>`
 
@@ -471,11 +489,11 @@ ### **Throws:**
 
-- **WrongDirectoryPathException**: If the project folder is not a String or can't convert to absolute path
-- **DirectoryNotFoundException**: If the project folder not exists or not have access to it
-- **InvalidDirectoryPathException**: If the project folder is not a directory
-- **OSNotSupportedException**: When run this processes with not supported operative system
-- **DataRequiredException**: If source is not provided
+- **`WrongDirectoryPathException`**: If the project folder is not a String or can't convert to absolute path
+- **`DirectoryNotFoundException`**: If the project folder not exists or not have access to it
+- **`InvalidDirectoryPathException`**: If the project folder is not a directory
+- **`OSNotSupportedException`**: When run this processes with not supported operative system
+- **`DataRequiredException`**: If source is not provided
 
 ### **Examples:**
 **Get diffs from two branches**
-
+```javascript
     const GitManager = require('@aurahelper/git-manager');
@@ -494,2 +512,3 @@
         // handle error
-    });
+    });
+```

No alert changes

Improved metrics

Total package byte prevSize

121014

increased by61.89%

Number of package files

8

increased by60%

Lines of code

1050

increased by146.48%

Number of lines in readme file

477

increased by4.15%

No dependency changes