Functionutilsv0.8.17

formatFilePath

Formats a file path relative to the current working directory.

A path outside the working directory, or any path on a runtime without process, is returned unchanged.

formatFilePath(
    filePath: string,
    options?: FormatFileOptions
): string

// cwd is /repo
formatFilePath('/repo/src/Bot.ts'); // './src/Bot.ts'
formatFilePath('/repo/src/Bot.ts', { onlyDir: true }); // './src'
formatFilePath('/repo/src/Bot.ts', { prefix: '' }); // 'src/Bot.ts'

filePath

filePath: string

options?

options?: FormatFileOptions