git-changes-affected

Find git changes affected files

Quick start

Intalling via npm:

npm i git-changes-affected

Fnd what modules your last commit change affects by:

const gitChangesAffected = require('git-changes-affected');
gitChangesAffected();

Find impact of changes by certain commit:

gitChangesAffected({
  to: '59037780a46c5000830a7a6705ebfa82d5a30095'
});

Find impact of changes between 2 revisions:

gitChangesAffected({
  to: '59037780a46c5000830a7a6705ebfa82d5a30095',
  from: '8e0d337483f9c9db07deeb2d82d7a8b3f8515423'
});

If your repo uses special supports like JSX, flow, typescript, etc., you will need to enable @babel/parser plugins as following:

gitChangesAffected({
  parserOptions: {
    plugins: ['jsx', 'typescript']
  }
});

Index

References

Enumerations

GIT_OPERATION

Type aliases

Variables

DEFAULT_EXTENSIONS

Functions

References

Change

Re-exports Change

DEFAULT_EXTENSIONS

Re-exports DEFAULT_EXTENSIONS

Diff

Re-exports Diff

GIT_OPERATION

Re-exports GIT_OPERATION

default

Renames and re-exports gitChangesAffected

getChangedEntries

Re-exports getChangedEntries

getGitDiffs

Re-exports getGitDiffs

huntRevisionImpact

Re-exports huntRevisionImpact

Type aliases

Change

Change: { changed: Array<{ end: number; start: number }>; content: string | null; file: string }

Type declaration

changed: Array<{ end: number; start: number }>

Changed file code line ranges
content: string | null
file: string

File path relative to the repo

Diff

Diff: { operation: GIT_OPERATION; source: Change; target: Change }

Type declaration

operation: GIT_OPERATION
source: Change
target: Change

Options

Options: { alias?: undefined | {}; extensions?: string[]; modules?: string[]; parserOptions?: ParserOptions; paths?: string[] }

Type declaration

Optional alias?: undefined | {}

Module alias to a path
Optional extensions?: string[]

Filter file extensions, default value: ['.js', '.jsx', '.ts', '.tsx].
Optional modules?: string[]

Paths where to look for JS modules, if you have customised modules other than npm's node_modules.
Optional parserOptions?: ParserOptions

@babel/parser options for parsing file to AST
Optional paths?: string[]

Limit paths of tracked files to check with. By default it will check all the git tracked files.

Options

Options: HuntRevisionImpactOptions & { from?: undefined | string; to?: undefined | string }

Variables

Const DEFAULT_EXTENSIONS

DEFAULT_EXTENSIONS: string[] = ['.js', '.jsx', '.ts', '.tsx']

Functions

getAbsolutePath

getAbsolutePath(relativePath: string): string

- Defined in git-changes-affected/src/getAbsolutePath.ts:6
internal

Parameters
- relativePath: string
Returns string

getChangedEntries

getChangedEntries(changes: Change[], parserOptions?: ParserOptions | null): Entry[]

- Defined in git-changes-affected/src/getChangedEntries.ts:35
Find what declarations does the code line changes belong to.

Parameters
- changes: Change[]
- Optional parserOptions: ParserOptions | null
  
  @babel/parser options
Returns Entry[]

A list of object contains module absolute path and declaration name

getGitDiffs

getGitDiffs(to: string, from?: undefined | string): Diff[]

- Defined in git-changes-affected/src/getGitDiffs.ts:34
Compare 2 git revisions and get an object refelcting the changes.

Parameters
- to: string
  
  Git revision.
- Optional from: undefined | string
  
  Git revision.
Returns Diff[]

getRevisionFile

getRevisionFile(revision: string, file: string): string

- Defined in git-changes-affected/src/getRevisionFile.ts:11
internal

Parameters
- revision: string
- file: string
Returns string

getTrackedFiles

getTrackedFiles(revision?: string, paths?: string[]): string[]

- Defined in git-changes-affected/src/getTrackedFiles.ts:7
internal

Parameters
- Default value revision: string = "HEAD"
- Optional paths: string[]
Returns string[]