li18nt/lib/src/types.d.ts

Locales linter, formatter, sorter and prettifier

import { Conflicts, Duplicates, DuplicatesConfig, Indentation, PatternConfig, PatternMismatch, PrettifyOptions } from '@lib';
export declare type Mode = 'off' | 'warn' | 'error';
export declare type Li18ntOption<T> = [Mode, T?];
export interface Li18ntOptions {
    prettified: Indentation | PrettifyOptions;
    duplicates: boolean | DuplicatesConfig;
    conflicts: boolean;
    naming: PatternConfig;
}
export interface Li18ntResult {
    prettified: string[];
    duplicates: Duplicates[];
    conflicts: Conflicts;
    naming: PatternMismatch[][];
}
export declare type PartialLi18ntResult<T extends Partial<Li18ntOptions>> = {
    [P in keyof T]: T[P] extends undefined ? never : P extends keyof Li18ntResult ? Li18ntResult[P] : never;
};
export declare type CLIRules = {
    prettified: Li18ntOption<PrettifyOptions>;
    duplicates: Li18ntOption<DuplicatesConfig>;
    conflicts: Li18ntOption<boolean>;
    naming: Li18ntOption<PatternConfig>;
};
export interface CLIOptions {
    rules: CLIRules;
    fix?: boolean;
    debug?: boolean;
    quiet?: boolean;
    config?: string;
    skipInvalid?: boolean;
    report?: boolean;
}
export interface SourceFile {
    content: JSONObject;
    source: string;
    filePath: string;
    name: string;
}
export interface CLIModuleArguments<Config> {
    files: SourceFile[];
    cmd: CLIOptions;
    rule: Li18ntOption<Config>;
}
export interface CLIModule<Config = undefined> {
    (args: CLIModuleArguments<Config>): boolean;
}
export declare type PropertyPath = (string | number)[];
export declare type JSONValue = string | number | boolean | null | JSONObject | JSONArray;
export declare type JSONArray = JSONValue[] | JSONObject[];
export interface JSONObject {
    [key: string]: JSONValue;
}