node-sloc/lib/utils.d.ts

A small tool for counting SLOC.

import { FileSLOC, Options, SLOCResult } from './types';
/**
 * Walks the directory dir async and returns a promise which
 * resolves to an array of the filepaths.
 *
 * @param  {string}   dir        The directory to walk
 * @param  {function} [logger]   The function outputs extra information to this function if specified.
 * @return {Promise}             Resolves to an array of filepaths
 */
declare const walk: (options: Options) => Promise<string[]>;
/**
 * Counts the source lines of code in the given file, specified by the filepath.
 *
 * @param  {string}  file  The filepath of the file to be read.
 * @return {Promise}       Resolves to an object containing the SLOC count.
 */
declare const countSloc: (file: string) => Promise<FileSLOC>;
declare const fileExtensionAllowed: (file: string, extensions: string[]) => boolean;
declare const filterFiles: (files: string[], extensions: string[]) => string[];
declare const prettyPrint: (obj: SLOCResult) => string;
export { walk, countSloc, filterFiles, fileExtensionAllowed, prettyPrint };