watskeburt
Advanced tools
Comparing version 0.11.3 to 0.11.4
@@ -1,1 +0,1 @@ | ||
export const VERSION = "0.11.3"; | ||
export const VERSION = "0.11.4"; |
{ | ||
"name": "watskeburt", | ||
"version": "0.11.3", | ||
"version": "0.11.4", | ||
"description": "List files changed since a git revision", | ||
@@ -48,8 +48,8 @@ "keywords": [ | ||
"@types/mocha": "10.0.1", | ||
"@types/node": "20.2.5", | ||
"@typescript-eslint/eslint-plugin": "5.59.7", | ||
"c8": "7.14.0", | ||
"dependency-cruiser": "13.0.2", | ||
"esbuild": "0.17.19", | ||
"eslint": "8.41.0", | ||
"@types/node": "20.3.1", | ||
"@typescript-eslint/eslint-plugin": "5.59.11", | ||
"c8": "8.0.0", | ||
"dependency-cruiser": "13.0.3", | ||
"esbuild": "0.18.4", | ||
"eslint": "8.43.0", | ||
"eslint-config-moving-meadow": "4.0.2", | ||
@@ -68,4 +68,4 @@ "eslint-config-prettier": "8.8.0", | ||
"ts-node": "10.9.1", | ||
"typescript": "5.0.4", | ||
"upem": "7.3.2" | ||
"typescript": "5.1.3", | ||
"upem": "8.0.0" | ||
}, | ||
@@ -72,0 +72,0 @@ "engines": { |
@@ -32,3 +32,3 @@ export type changeTypeType = | ||
export interface IOptions { | ||
export interface IFormatOptions { | ||
/** | ||
@@ -38,3 +38,3 @@ * The type of output to deliver. Defaults to "object" - in which case | ||
*/ | ||
outputType?: outputTypeType; | ||
outputType: "regex" | "json"; | ||
/** | ||
@@ -49,2 +49,19 @@ * When true _only_ takes already tracked files into account. | ||
export interface IInternalOptions { | ||
/** | ||
* The type of output to deliver. Defaults to "object" - in which case | ||
* the listSync function returns an IChange[] object | ||
*/ | ||
outputType?: "object"; | ||
/** | ||
* When true _only_ takes already tracked files into account. | ||
* When false also takes untracked files into account. | ||
* | ||
* Defaults to false. | ||
*/ | ||
trackedOnly?: boolean; | ||
} | ||
export type IOptions = IFormatOptions | IInternalOptions; | ||
/** | ||
@@ -65,7 +82,8 @@ * returns a list of files changed since pOldRevision. | ||
pNewRevision?: string, | ||
pOptions?: IOptions | ||
): IChange[] | string; | ||
pOptions?: IInternalOptions | ||
): IChange[]; | ||
/** | ||
* returns a list of files changed since pOldRevision. | ||
* returns a list of files changed since pOldRevision formatted into a string | ||
* as pOptions.outputType | ||
* | ||
@@ -81,9 +99,46 @@ * @param pOldRevision The revision against which to compare. E.g. a commit-hash, | ||
*/ | ||
export function listSync( | ||
pOldRevision?: string, | ||
pNewRevision?: string, | ||
pOptions?: IFormatOptions | ||
): string; | ||
/** | ||
* returns promise of a list of files changed since pOldRevision. | ||
* | ||
* @param pOldRevision The revision against which to compare. E.g. a commit-hash, | ||
* a branch or a tag. When not passed defaults to the _current_ | ||
* commit hash (if there's any) | ||
* @param pNewRevision Newer revision against which to compare. Leave out or pass | ||
* null when you want to compare against the working tree | ||
* @param pOptions Options that influence how the changes are returned and that | ||
* filter what is returned and | ||
* @throws {Error} | ||
*/ | ||
export function list( | ||
pOldRevision?: string, | ||
pNewRevision?: string, | ||
pOptions?: IOptions | ||
): Promise<IChange[] | string>; | ||
pOptions?: IInternalOptions | ||
): Promise<IChange[]>; | ||
/** | ||
* returns promise a list of files changed since pOldRevision, formatted into a | ||
* string as a pOptions.outputType | ||
* | ||
* @param pOldRevision The revision against which to compare. E.g. a commit-hash, | ||
* a branch or a tag. When not passed defaults to the _current_ | ||
* commit hash (if there's any) | ||
* @param pNewRevision Newer revision against which to compare. Leave out or pass | ||
* null when you want to compare against the working tree | ||
* @param pOptions Options that influence how the changes are returned and that | ||
* filter what is returned and | ||
* @throws {Error} | ||
*/ | ||
export function list( | ||
pOldRevision?: string, | ||
pNewRevision?: string, | ||
pOptions?: IFormatOptions | ||
): Promise<string>; | ||
/** | ||
* Returns the SHA1 of the current HEAD | ||
@@ -90,0 +145,0 @@ * |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
31345
486