Skip to content
/ base-cwd Public

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

License

Notifications You must be signed in to change notification settings

base/base-cwd

Repository files navigation

base-cwd NPM version NPM downloads Build Status

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

Table of Contents

Install

Install with npm:

$ npm install --save base-cwd

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.

About

Related projects

Contributing

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

Building docs

(This document was generated by [verb-generate-readme][] (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

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


This file was generated by verb, v0.9.0, on July 13, 2016.

About

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

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  
  •  

Packages

No packages published