You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.1KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. # path-root-regex [![NPM version](https://img.shields.io/npm/v/path-root-regex.svg?style=flat)](https://www.npmjs.com/package/path-root-regex) [![NPM downloads](https://img.shields.io/npm/dm/path-root-regex.svg?style=flat)](https://npmjs.org/package/path-root-regex) [![Build Status](https://img.shields.io/travis/regexhq/path-root-regex.svg?style=flat)](https://travis-ci.org/regexhq/path-root-regex)
  2. > Regular expression for getting the root of a posix or windows filepath.
  3. You might also be interested in [path-root](https://github.com/jonschlinkert/path-root).
  4. ## Usage
  5. The module exposes a function that must be called to get the regex (modified from the split device regex in the node.js path module);
  6. ```js
  7. var pathRootRegex = require('path-root-regex');
  8. console.log(pathRootRegex() instanceof RegExp);
  9. //=> true
  10. ```
  11. See the [path-root](https://github.com/jonschlinkert/path-root) module for examples.
  12. ## Related projects
  13. You might also be interested in these projects:
  14. * [is-absolute](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute)
  15. * [parse-filepath](https://www.npmjs.com/package/parse-filepath): Parse a filepath into an object. Falls back on the native node.js `path.parse` method if… [more](https://www.npmjs.com/package/parse-filepath) | [homepage](https://github.com/jonschlinkert/parse-filepath)
  16. ## Contributing
  17. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/path-root-regex/issues/new).
  18. ## Running tests
  19. Install dev dependencies:
  20. ```sh
  21. $ npm install -d && npm test
  22. ```
  23. ## Author
  24. **Jon Schlinkert**
  25. * [github/jonschlinkert](https://github.com/jonschlinkert)
  26. * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  27. ## License
  28. Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
  29. Released under the [MIT license](https://github.com/regexhq/path-root-regex/blob/master/LICENSE).
  30. ***
  31. _This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._