linguist-js/dist/types.d.ts

Analyse languages used in a folder. Powered by GitHub Linguist, although it doesn't need to be installed.

export type LanguageResult = string | null;
export type Language = string;
export type Category = 'data' | 'markup' | 'programming' | 'prose';
export type FilePath = string;
export type Bytes = Integer;
export type Integer = number;
export type RelFile = string & {};
export type AbsFile = string & {};
export type AbsFolder = string & {};
export type FileGlob = string & {};
export interface Options {
    fileContent?: string | string[];
    ignoredFiles?: string[];
    ignoredLanguages?: Language[];
    categories?: Category[];
    keepVendored?: boolean;
    keepBinary?: boolean;
    relativePaths?: boolean;
    childLanguages?: boolean;
    quick?: boolean;
    offline?: boolean;
    calculateLines?: boolean;
    checkIgnored?: boolean;
    checkDetected?: boolean;
    checkAttributes?: boolean;
    checkHeuristics?: boolean;
    checkShebang?: boolean;
    checkModeline?: boolean;
}
export interface Results {
    files: {
        count: Integer;
        bytes: Bytes;
        lines: {
            total: Integer;
            content: Integer;
            code: Integer;
        };
        /** Note: Results use slashes as delimiters even on Windows. */
        results: Record<FilePath, LanguageResult>;
        alternatives: Record<FilePath, LanguageResult[]>;
    };
    languages: {
        count: Integer;
        bytes: Bytes;
        lines: {
            total: Integer;
            content: Integer;
            code: Integer;
        };
        results: Record<Language, {
            bytes: Bytes;
            lines: {
                total: Integer;
                content: Integer;
                code: Integer;
            };
            type: Category;
            parent?: Language;
            color?: `#${string}`;
        }>;
    };
    unknown: {
        count: Integer;
        bytes: Bytes;
        lines: {
            total: Integer;
            content: Integer;
            code: Integer;
        };
        extensions: Record<string, Bytes>;
        filenames: Record<string, Bytes>;
    };
}