replacer-util
Version:
Find and replace strings or template outputs in text files (CLI tool designed for use in npm package.json scripts)
42 lines (40 loc) • 1.13 kB
TypeScript
//! replacer-util v1.6.3 ~~ https://github.com/center-key/replacer-util ~~ MIT License
export type Settings = {
cd: string | null;
concat: string | null;
content: string | null;
exclude: string | null;
extensions: string[];
filename: string | null;
find: string | null;
header: string | null;
nonRecursive: boolean;
noSourceMap: boolean;
regex: RegExp | null;
rename: string | null;
replacement: string | null;
templatingOn: boolean;
titleSort: boolean;
virtualInput: boolean;
};
export type Results = {
source: string;
target: string;
count: number;
duration: number;
files: {
origin: string;
dest: string;
}[];
};
export type ResultsFile = Results['files'][number];
export type ReporterSettings = {
summaryOnly: boolean;
};
declare const replacer: {
assert(ok: unknown, message: string | null): void;
cli(): void;
transform(sourceFolder: string, targetFolder: string, options?: Partial<Settings>): Results;
reporter(results: Results, options?: Partial<ReporterSettings>): Results;
};
export { replacer };