common-path-prefix
v3.0.0
Published
Computes the longest prefix string that is common to each path, excluding the base component
Downloads
35,756,028
Maintainers
Readme
common-path-prefix
Computes the longest prefix string that is common to each path, excluding the base component. Tested with Node.js 8 and above.
Installation
npm install common-path-prefix
Usage
The module has one default export, the commonPathPrefix
function:
const commonPathPrefix = require('common-path-prefix')
Call commonPathPrefix()
with an array of paths (strings) and an optional separator character:
const paths = ['templates/main.handlebars', 'templates/_partial.handlebars']
commonPathPrefix(paths, '/') // returns 'templates/'
If the separator is not provided the first /
or \
found in any of the paths is used. Otherwise the platform-default value is used:
commonPathPrefix(['templates/main.handlebars', 'templates/_partial.handlebars']) // returns 'templates/'
commonPathPrefix(['templates\\main.handlebars', 'templates\\_partial.handlebars']) // returns 'templates\\'
You can provide any separator, for example:
commonPathPrefix(['foo$bar', 'foo$baz'], '$') // returns 'foo$''
An empty string is returned if no common prefix exists:
commonPathPrefix(['foo/bar', 'baz/qux']) // returns ''
commonPathPrefix(['foo/bar']) // returns ''
Note that the following does have a common prefix:
commonPathPrefix(['/foo/bar', '/baz/qux']) // returns '/'