Home > @rushstack/node-core-library > Path > formatFileLocation

Path.formatFileLocation() method

Formats a file location to look nice for reporting purposes.

Signature:

static formatFileLocation(options: IPathFormatFileLocationOptions): string;

Parameters

Parameter	Type	Description
options	IPathFormatFileLocationOptions

Returns:

string

Remarks

If pathToFormat is under the baseFolder, then it will be converted to a relative with the ./ prefix. Otherwise, it will be converted to an absolute path.

Backslashes will be converted to slashes, unless the path starts with an OS-specific string like C:\.