Skip to content
Tests whether one path is inside another path
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Add optimization due to @kriskowal. Mar 1, 2014
test Fix false positives for paths starting with the same prefix. Mar 1, 2014
.gitignore Initial commit. Dec 14, 2013
.jshintrc
.travis.yml I don't care about Node 0.8 anymore. Jun 23, 2014
LICENSE.txt
README.md Document that paths are inside themselves, per #2. Jun 23, 2014
package.json Version 1.0.2 Sep 10, 2016

README.md

Is This Path Inside This Other Path?

It turns out this question isn't trivial to answer using Node's built-in path APIs. A naive indexOf-based solution will fail sometimes on Windows, which is case-insensitive (see e.g. isaacs/npm#4214). You might then think to be clever with path.resolve, but you have to be careful to account for situations whether the paths have different drive letters, or else you'll cause bugs like isaacs/npm#4313. And let's not even get started on trailing slashes.

The path-is-inside package will give you a robust, cross-platform way of detecting whether a given path is inside another path.

Usage

Pretty simple. First the path being tested; then the potential parent. Like so:

var pathIsInside = require("path-is-inside");

pathIsInside("/x/y/z", "/x/y") // true
pathIsInside("/x/y", "/x/y/z") // false

Paths are considered to be inside themselves:

pathIsInside("/x/y", "/x/y"); // true

OS-Specific Behavior

Like Node's built-in path module, path-is-inside treats all file paths on Windows as case-insensitive, whereas it treats all file paths on *-nix operating systems as case-sensitive. Keep this in mind especially when working on a Mac, where, despite Node's defaults, the OS usually treats paths case-insensitively.

In practice, this means:

// On Windows

pathIsInside("C:\\X\\Y\\Z", "C:\\x\\y") // true

// On *-nix, including Mac OS X

pathIsInside("/X/Y/Z", "/x/y") // false
You can’t perform that action at this time.