aboutsummaryrefslogtreecommitdiff
path: root/node_modules/common-path-prefix/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/common-path-prefix/README.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/common-path-prefix/README.md')
-rw-r--r--node_modules/common-path-prefix/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/node_modules/common-path-prefix/README.md b/node_modules/common-path-prefix/README.md
new file mode 100644
index 000000000..451794bbe
--- /dev/null
+++ b/node_modules/common-path-prefix/README.md
@@ -0,0 +1,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 '/'
+```