ruins
Version:
> [!IMPORTANT] > This is in beta. Not everything is ironed out and some modules might misbehave
52 lines (51 loc) • 1.35 kB
TypeScript
export declare const getConfig: () => Promise<{
eslint: {
enabled: boolean;
/** turns ignored from error to off, instead of default warn */
preferOff: boolean;
/** identify files by filename only, not path. Inaccurate, useful only if making big directory changes */
filenameOnly: boolean;
};
todos: {
enabled: boolean;
};
gitlog: {
enabled: boolean;
months: 1 | 2 | 3 | 4 | 5 | 6;
};
dir: string;
group?: {
dirs: string[];
};
files: {
eslintIssues: string;
eslintIgnores: string;
todos: string;
gitlog: string;
};
}>;
export interface RuinsConfig {
dir: string;
eslint: {
enabled: boolean;
/** turns ignored from error to off, instead of default warn */
preferOff: boolean;
/** identify files by filename only, not path. Inaccurate, useful only if making big directory changes */
filenameOnly: boolean;
};
group?: {
dirs: string[];
};
todos: {
enabled: boolean;
};
gitlog: {
enabled: boolean;
months: 1 | 2 | 3 | 4 | 5 | 6;
};
}
type DeepPartial<T> = {
[P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
};
export type UserRuinsConfig = DeepPartial<RuinsConfig>;
export {};