base-cwd

base-cwd

Base plugin that adds a getter/setter for the current working directory.

Install

Install with npm:

$ npm install base-cwd --save

Usage

var cwd = require('base-cwd');
var Base = require('base');
var app = new Base();
app.use(cwd());

Adds a cwd getter/setter to app:

console.log(app.cwd);
//=> /Users/jonschlinkert/dev/base/base-cwd
console.log(app.cwd === process.cwd());
//=> true

If app.options.cwd is defined it will used by app.cwd:

app.options.cwd = 'foo/bar';
console.log(app.cwd);
//=> /Users/jonschlinkert/dev/base/base-cwd/foo/bar
console.log(app.cwd === process.cwd());
//=> false

If app.cwd is set, it will also set the value to app.cache.cwd, to ensure that the user-defined value is used on the next get.

Related projects

You might also be interested in these projects:

• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
• base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage
• base-pipeline: base-methods plugin that adds pipeline and plugin methods for dynamically composing streaming plugin pipelines. | homepage
• base-plugins: Upgrade's plugin support in base applications to allow plugins to be called any time after… more | homepage
• base-task: base plugin that provides a very thin wrapper around https://github.com/doowb/composer for adding task methods to… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with [verb][]:

$ npm install verb && npm run docs

Or, if [verb][] is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v, on March 25, 2016.