blob: 451794bbe036e0f5e170801e90d5555a769991df (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
# common-path-prefix
Computes the longest prefix string that is common to each path, excluding the
base component. Tested with Node 0.10 and above.
## Installation
```
npm install --save common-path-prefix
```
## Usage
The module has one default export, the `commonPathPrefix` function:
```js
var commonPathPrefix = require('common-path-prefix')
```
Call `commonPathPrefix()` with an array of paths (strings) and an optional
separator character:
```js
var paths = ['templates/main.handlebars', 'templates/_partial.handlebars']
commonPathPrefix(paths, '/') // returns 'templates/'
```
If the separator is not provided the first `/` or `\` found in the first path
string is used. This means the module works correctly no matter the platform:
```js
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:
```js
commonPathPrefix(['foo$bar', 'foo$baz'], '$') // returns 'foo$''
```
An empty string is returned if no common prefix exists:
```js
commonPathPrefix(['foo/bar', 'baz/qux']) // returns ''
```
Note that the following *does* have a common prefix:
```js
commonPathPrefix(['/foo/bar', '/baz/qux']) // returns '/'
```
|
