The true-case-path npm package is designed to provide the true case of a filesystem path on a case-insensitive filesystem. This is particularly useful when working with file systems that do not enforce case sensitivity, such as those on Windows and macOS. It helps in ensuring that the path casing matches the actual casing on the filesystem.

What are true-case-path's main functionalities?

Get true case of a file path

This feature allows you to get the true case of a file path. It returns a promise that resolves to the correctly cased path as a string. If the file does not exist, the promise is rejected with an error.

const trueCasePath = require('true-case-path');

trueCasePath('/users/guest/documents/myfile.txt').then((trueCasePath) => {
  console.log(trueCasePath);
}).catch((error) => {
  console.error(error);
});

Other packages similar to true-case-path

Changelog

Source

2.2.1 (2019-07-24)

Bug Fixes

windows: Drive letter bug (1b736b7)

Readme

Source

true-case-path

Given a possibly case-variant version of an existing filesystem path, returns the absolute, case-exact, normalized version as stored in the filesystem.

Usage

const { trueCasePath, trueCasePathSync } = require('true-case-path')

trueCasePath(<fileSystemPath>)
    .then((caseCorrectPath) => {
        // ...
    })

const caseCorrectPath = trueCasePathSync(<fileSystemPath>)

NOTE: If no matching path exists, an error with be thrown.

Optionally takes a second argument to use as the base path to begin case-correction from. This can be particularly useful within shared hosting environments since true-case-path relies on the ability to list a directory's contents in order to check the case and attempting to list the contents of / or /home will generally result in a permissions error.

const { trueCasePath } = require('true-case-path')

trueCasePath('code/my-app/sOmE-FiLe', '/home/casey')

NOTE: When specifying a basePath, the first argument is expected to be the file path relative to that basePath. If the first argument is absolute, every path segment will be checked. basePath defaults to process.cwd() if not specified and the first argument is relative.

Platforms

Windows, OSX, and Linux

Examples

const { trueCasePathSync } = require('true-case-path')

trueCasePathSync('/users/guest') // OSX: -> '/Users/Guest'

trueCasePathSync('c:\\users\\all users') // Windows: -> 'c:\Users\All Users'

FAQs

What is true-case-path?

Is true-case-path popular?

Is true-case-path well maintained?

Last updated on 24 Jul 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install