precise-commits

Install

npm i precise-commits

yarn add precise-commits

pnpm add precise-commits

precise-commits

main: (
    workingDirectory: string,
    additionalOptions: AdditionalOptions,
    callbacks?: Callbacks
) => void;

interface AdditionalOptions {}

base: string | null;

checkOnly: boolean;

filesWhitelist: string[] | null;

head: string | null;

interface Callbacks {}

onBegunProcessingFile: (
    filename: string,
    index: number,
    totalFiles: number
) => void;

onComplete: (totalFiles: number) => void;

onError: (err: Error) => void;

onFinishedProcessingFile: (
    filename: string,
    index: number,
    status: ProcessingStatus
) => void;

onInit: (workingDirectory: string) => void;

onModifiedFilesDetected: (modifiedFilenames: string[]) => void;

type ProcessingStatus = 'NOT_UPDATED' | 'UPDATED' | 'INVALID_FORMATTING';

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/precise-commits.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/precise-commits)

HTML

<a href="https://www.jsdocs.io/package/precise-commits"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>