Skip to content

Base plugin that adds a `project` getter to the instance for getting the name of a project. Gets the project name for new (empty) projects, projects with only a .git repository, and/or projects with a package.json.

License

base/base-project

Repository files navigation

base-project NPM version NPM downloads Build Status

Base plugin that adds a project getter to the instance for getting the name of a project. Gets the project name for new (empty) projects, projects with only a .git repository, and/or projects with a package.json.

Install

Install with npm:

$ npm install base-project --save

Usage

var project = require('base-project');
var Base = require('base');
var base = new Base();

base.use(project());

Related projects

You might also be interested in these projects:

  • base-cwd: Base plugin that adds a getter/setter for the current working directory. | homepage
  • base-data: adds a data method to base-methods. | homepage
  • base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage
  • base-pkg: Plugin for adding a pkg method that exposes pkg-store to your base application. | 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

License

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


This file was generated by verb, v0.9.0, on May 15, 2016.

About

Base plugin that adds a `project` getter to the instance for getting the name of a project. Gets the project name for new (empty) projects, projects with only a .git repository, and/or projects with a package.json.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  
  •  

Packages

No packages published