precise-commits

  • Version 1.0.2
  • Published
  • 34.1 kB
  • 7 dependencies
  • MIT license

Install

npm i precise-commits
yarn add precise-commits
pnpm add precise-commits

Overview

precise-commits

Index

Functions

function main

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

    Interfaces

    interface AdditionalOptions

    interface AdditionalOptions {}

      property base

      base: string | null;

        property checkOnly

        checkOnly: boolean;

          property filesWhitelist

          filesWhitelist: string[] | null;

            property head

            head: string | null;

              interface Callbacks

              interface Callbacks {}

                method onBegunProcessingFile

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

                  method onComplete

                  onComplete: (totalFiles: number) => void;

                    method onError

                    onError: (err: Error) => void;

                      method onFinishedProcessingFile

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

                        method onInit

                        onInit: (workingDirectory: string) => void;

                          method onModifiedFilesDetected

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

                            Type Aliases

                            type ProcessingStatus

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

                              Package Files (1)

                              Dependencies (7)

                              Dev Dependencies (12)

                              Peer Dependencies (1)

                              Badge

                              To add a badge like this onejsDocs.io badgeto 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>