diff options
Diffstat (limited to 'node_modules/common-path-prefix/README.md')
-rw-r--r-- | node_modules/common-path-prefix/README.md | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/node_modules/common-path-prefix/README.md b/node_modules/common-path-prefix/README.md deleted file mode 100644 index 451794bbe..000000000 --- a/node_modules/common-path-prefix/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# 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 '/' -``` |