www.aleph1.co.uk Git - yaffs-website/blob - node_modules/glob2base/README.md

   1 # glob2base [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Support us][gittip-image]][gittip-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url]
   2
   3
   4 ## Information
   5
   6 <table>
   7 <tr>
   8 <td>Package</td><td>glob2base</td>
   9 </tr>
  10 <tr>
  11 <td>Description</td>
  12 <td>Extracts a base path from a node-glob instance</td>
  13 </tr>
  14 <tr>
  15 <td>Node Version</td>
  16 <td>>= 0.10</td>
  17 </tr>
  18 </table>
  19
  20 ## Usage
  21
  22 The module is a function that takes in a node-glob instance and returns a string. Basically it just gives you everything before any globbing/matching happens.
  23
  24 ```javascript
  25 var glob2base = require('glob2base');
  26 var glob = require('glob');
  27
  28 // js/
  29 glob2base(new glob.Glob('js/**/*.js'));
  30
  31 // css/test/
  32 glob2base(new glob.Glob('css/test/{a,b}/*.css'));
  33
  34 // pages/whatever/
  35 glob2base(new glob.Glob('pages/whatever/index.html'));
  36 ```
  37
  38 ## Like what we do?
  39
  40 [gittip-url]: https://www.gittip.com/WeAreFractal/
  41 [gittip-image]: http://img.shields.io/gittip/WeAreFractal.svg
  42
  43 [downloads-image]: http://img.shields.io/npm/dm/glob2base.svg
  44 [npm-url]: https://npmjs.org/package/glob2base
  45 [npm-image]: http://img.shields.io/npm/v/glob2base.svg
  46
  47 [travis-url]: https://travis-ci.org/wearefractal/glob2base
  48 [travis-image]: http://img.shields.io/travis/wearefractal/glob2base.svg
  49
  50 [coveralls-url]: https://coveralls.io/r/wearefractal/glob2base
  51 [coveralls-image]: http://img.shields.io/coveralls/wearefractal/glob2base/master.svg