Functionutilsv0.9.0

formatFilePath

Formats a file path relative to the current working directory, with forward slashes on every OS.

It returns the full path when the path is outside the working directory or the runtime has no process.

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