eslint-plugin-path
Version:
An ESLint plugin for enforcing consistent imports across project. In other words, it helps to replace all relatives import with absolutes dependinng on settings.
30 lines • 1 kB
TypeScript
import { ConfigSettings } from "./types";
/**
* Alias item structure
*/
export interface AliasItem {
path: string;
alias: string | null;
aliases?: AliasItem[];
}
/**
* Helps to clear matchers' key or value
* @param value - The value to clear
* @returns The cleared tsconfig path matcher value
*/
export declare function clearMatcher(value: string): string;
/**
* Helps to create alias item creator based on package dir
* @param packageDir - The package directory
* @returns Returns alias item creator
*/
export declare function getAliasItemCreator(packageDir: string): (path: string, alias?: string) => AliasItem;
/**
* Creates alias items that were described in tsconfig.json
*
* @param {string} packagePath - The package path
* @param {ConfigSettings} settings - The config settings
* @returns Returns array of alias items
*/
export declare function getConfigSettings(packagePath: string, settings: ConfigSettings): Array<AliasItem>;
//# sourceMappingURL=config.d.ts.map