@aurahelper/git-manager
Advanced tools
Comparing version 2.0.1 to 2.0.2
# Change Log | ||
All notable changes to this project will be documented in this file. | ||
## [2.0.0 - 2021-12-13] | ||
### Added | ||
- Changed to Typescript | ||
- Added support to API 53.0 | ||
### Fixed | ||
- Fix all minor errors | ||
## [1.0.0 - 2021-09-18] | ||
@@ -4,0 +14,0 @@ ### Added |
@@ -5,3 +5,3 @@ { | ||
"displayName": "Aura Helper Framework Git Manager", | ||
"version": "2.0.1", | ||
"version": "2.0.2", | ||
"description": "Aura Helper Git Manager Module its a module to handle and manage all git operations and commands.", | ||
@@ -56,4 +56,10 @@ "main": "./dist/index.js", | ||
"devDependencies": { | ||
"@types/jest": "^26.0.20", | ||
"jest": "^26.6.3" | ||
"@types/jest": "^27.0.3", | ||
"@types/node": "^12.12.47", | ||
"@typescript-eslint/eslint-plugin": "^5.4.0", | ||
"@typescript-eslint/parser": "^5.4.0", | ||
"eslint": "^8.3.0", | ||
"jest": "^27.4.3", | ||
"ts-jest": "^27.0.7", | ||
"typescript": "^3.9.6" | ||
}, | ||
@@ -60,0 +66,0 @@ "dependencies": { |
@@ -35,3 +35,3 @@ # **Aura Helper Git Manager Module** | ||
Path to the project under a git repository | ||
- `String` | ||
- `string` | ||
@@ -47,3 +47,3 @@ </br> | ||
- **projectFolder**: Path to the ignore file | ||
- `String` | ||
- `string` | ||
@@ -114,3 +114,3 @@ </br> | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -127,3 +127,3 @@ const gitManager = new GitManager(); | ||
Return a String promise with the Git User Name | ||
- `Promise<String>` | ||
- `Promise<string>` | ||
@@ -141,3 +141,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -159,3 +159,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Return a String promise with the Git User Email | ||
- `Promise<String>` | ||
- `Promise<string>` | ||
@@ -173,3 +173,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -191,3 +191,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Return a String promise with the Git Author Name | ||
- `Promise<String>` | ||
- `Promise<string>` | ||
@@ -205,3 +205,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -223,3 +223,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Return a String promise with the Git Author Email | ||
- `Promise<String>` | ||
- `Promise<string>` | ||
@@ -237,3 +237,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -255,3 +255,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Return a String promise with the Git Committer Name | ||
- `Promise<String>` | ||
- `Promise<string>` | ||
@@ -269,3 +269,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -287,3 +287,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Return a String promise with the Git Committer Email | ||
- `Promise<String>` | ||
- `Promise<string>` | ||
@@ -301,3 +301,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -320,3 +320,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Return an empty promise when finish fetch process | ||
- `Promise<any>` | ||
- `Promise<void>` | ||
@@ -334,3 +334,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -352,3 +352,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Returns a promise with an object list with branch name and active status | ||
- `Promise<Array<Object>>` | ||
- `Promise<GitBranch[]>` | ||
@@ -366,3 +366,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -389,3 +389,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Returns a promise with a list of tags | ||
- `Promise<Array<Object>>` | ||
- `Promise<GitTag[]>` | ||
@@ -403,3 +403,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -421,3 +421,3 @@ const gitManager = new GitManager('path/to/project/root'); | ||
Returns a promise with list of Commit objects | ||
- `Promise<Array<Commit>>` | ||
- `Promise<Commit[]>` | ||
@@ -435,3 +435,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -466,9 +466,9 @@ const gitManager = new GitManager('path/to/project/root'); | ||
- **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<GitDiff[]>` | ||
@@ -487,3 +487,3 @@ ### **Throws:** | ||
```javascript | ||
const GitManager = require('@aurahelper/git-manager'); | ||
import { GitManager } from '@aurahelper/git-manager'; | ||
@@ -490,0 +490,0 @@ const gitManager = new GitManager('path/to/project/root'); |
Major refactor
Supply chain riskPackage 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
101395
9
662
8
1