biofriction-wp-theme/node_modules/lazy-debug-legacy/README.md

41 lines
1.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# lazy-debug
[![npm lazy-debug](https://nodei.co/npm/lazy-debug.png?compact=true)](https://www.npmjs.com/package/lazy-debug)
Node.js module which generates app & module names for [visionmedia´s debug](https://github.com/visionmedia/debug) using `__filename` and package.json.
Basic usage example:
```javascript
var debug = require('lazy-debug-legacy').get(__filename);
```
Depending on `__filename`, debug name will be something like packageName:dir:file. File extension is removed and if file name is `index`, its removed too. For futher customization, to fit better for project structure, you can provide filter function:
```javascript
var lazyDebug = require('lazy-debug-legacy');
lazyDebug.configure({filter: function (pathArray) {
if ( pathArray[0] === 'src' ) {
pathArray.shift();
}
return pathArray;
}});
// now, when called in packageRoot/src/module1/index.js
var debug = require('lazy-debug-legacy').get(__filename);
// debug name will be projectName:module1
```
## Install
`npm install --save debug lazy-debug`
## Tests
`npm test`
## License
[The MIT License](LICENSE.md)