New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details → →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

@types/git-parse

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/git-parse - npm Package Compare versions

Comparing version
1.0.1
 to
2.1.1
+8
-20
git-parse/package.json
{
"name": "@types/git-parse",
"version": "1.0.1",
"description": "TypeScript definitions for git-parse",
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-parse",
"license": "MIT",
"contributors": [
{
"name": "Piotr Błażejewicz",
"url": "https://github.com/peterblazejewicz",
"githubUsername": "peterblazejewicz"
}
],
"version": "2.1.1",
"typings": null,
"description": "Stub TypeScript definitions entry for git-parse, which provides its own types definitions",
"main": "",
"types": "index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
"directory": "types/git-parse"
},
"scripts": {},
"dependencies": {},
"typesPublisherContentHash": "8d794d601315b6e2681f834890811c0a06dc4beb9a23838c171e1b404789e477",
"typeScriptVersion": "3.6"
"author": "",
"license": "MIT",
"dependencies": {
"git-parse": "*"
}
}
+2
-83
git-parse/README.md

@@ -1,84 +0,3 @@

# Installation
> `npm install --save @types/git-parse`
This is a stub types definition for @types/git-parse (https://github.com/wayfair/git-parse#readme).
# Summary
This package contains type definitions for git-parse (https://github.com/wayfair/git-parse#readme).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-parse.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-parse/index.d.ts)
````ts
// Type definitions for git-parse 1.0
// Project: https://github.com/wayfair/git-parse#readme
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* A utility which generates an array of javascript objects representing the current branch of a local git repository's commit history.
* Returns a promise which resolves with a list of objects describing git commits on the current branch.
*/
export function gitToJs(repoPath: string, options?: GitToJsOptions): Promise<GitCommit[]>;
/**
* Checks out a commit given its repo and hash.
* @async
*/
export function checkoutCommit(pathToRepo: string, hash: string, options?: CheckoutCommmitOptions): Promise<void>;
/**
* Pulls a repo given its path.
* @async
*/
export function gitPull(pathToRepo: string): Promise<void>;
/**
* Returns a git diff given a path to the repo, a commit,
* an optional second commit, and an optional file.
*/
export function gitDiff(pathToRepo: string, commitHash1: string, commitHash2?: string, file?: string): Promise<string>;
// types
export interface FileModification {
path: string;
linesAdded?: number | undefined;
linesDeleted?: number | undefined;
}
export interface FileRename {
oldPath: string;
newPath: string;
}
/**
* Object representing the current branch of a local git repository's commit history
*/
export interface GitCommit {
hash: string;
authorName: string;
authorEmail: string;
date: string;
message: string;
filesAdded: FileModification[];
filesDeleted: FileModification[];
filesModified: FileModification[];
filesRenamed: FileRename[];
}
export interface GitToJsOptions {
sinceCommit?: string | undefined;
}
export interface CheckoutCommmitOptions {
force?: boolean | undefined;
}
````
### Additional Details
* Last updated: Thu, 08 Jul 2021 12:02:07 GMT
* Dependencies: none
* Global values: none
# Credits
These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).
git-parse provides its own type definitions, so you don't need @types/git-parse installed!
-64
git-parse/index.d.ts
// Type definitions for git-parse 1.0
// Project: https://github.com/wayfair/git-parse#readme
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* A utility which generates an array of javascript objects representing the current branch of a local git repository's commit history.
* Returns a promise which resolves with a list of objects describing git commits on the current branch.
*/
export function gitToJs(repoPath: string, options?: GitToJsOptions): Promise<GitCommit[]>;
/**
* Checks out a commit given its repo and hash.
* @async
*/
export function checkoutCommit(pathToRepo: string, hash: string, options?: CheckoutCommmitOptions): Promise<void>;
/**
* Pulls a repo given its path.
* @async
*/
export function gitPull(pathToRepo: string): Promise<void>;
/**
* Returns a git diff given a path to the repo, a commit,
* an optional second commit, and an optional file.
*/
export function gitDiff(pathToRepo: string, commitHash1: string, commitHash2?: string, file?: string): Promise<string>;
// types
export interface FileModification {
path: string;
linesAdded?: number | undefined;
linesDeleted?: number | undefined;
}
export interface FileRename {
oldPath: string;
newPath: string;
}
/**
* Object representing the current branch of a local git repository's commit history
*/
export interface GitCommit {
hash: string;
authorName: string;
authorEmail: string;
date: string;
message: string;
filesAdded: FileModification[];
filesDeleted: FileModification[];
filesModified: FileModification[];
filesRenamed: FileRename[];
}
export interface GitToJsOptions {
sinceCommit?: string | undefined;
}
export interface CheckoutCommmitOptions {
force?: boolean | undefined;
}