# base-project

> 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.

Latest version **0.2.1** (published 2016-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install base-project
pnpm add base-project
yarn add base-project
bun add base-project
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2016-05-21 |
| First published | 2016-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | base, base-plugin, baseplugin, create, empty, generator, init, name, plugin, project, repository |

## Links

- npm: https://www.npmjs.com/package/base-project
- Repository: https://github.com/node-base/base-project
- Issues: https://github.com/node-base/base-project/issues
- npm.io page: https://npm.io/package/base-project

## Dependencies (3)

- [project-name](https://npm.io/package/project-name.md) ^0.2.5
- [is-registered](https://npm.io/package/is-registered.md) ^0.1.3
- [is-valid-instance](https://npm.io/package/is-valid-instance.md) ^0.1.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.2.1 (latest) — 2016-05-21
- 0.2.0 — 2016-05-15
- 0.1.3 — 2016-03-17
- 0.1.2 — 2016-03-17
- 0.1.1 — 2016-02-20
- 0.1.0 — 2016-02-04

## README

# base-project [![NPM version](https://img.shields.io/npm/v/base-project.svg?style=flat)](https://www.npmjs.com/package/base-project) [![NPM downloads](https://img.shields.io/npm/dm/base-project.svg?style=flat)](https://npmjs.org/package/base-project) [![Build Status](https://img.shields.io/travis/node-base/base-project.svg?style=flat)](https://travis-ci.org/node-base/base-project)

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](https://www.npmjs.com/):

```sh
$ npm install base-project --save
```

## Usage

```js
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](https://www.npmjs.com/package/base-cwd): Base plugin that adds a getter/setter for the current working directory. | [homepage](https://github.com/node-base/base-cwd)
* [base-data](https://www.npmjs.com/package/base-data): adds a `data` method to base-methods. | [homepage](https://github.com/node-base/base-data)
* [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://www.npmjs.com/package/base-option) | [homepage](https://github.com/node-base/base-option)
* [base-pkg](https://www.npmjs.com/package/base-pkg): Plugin for adding a `pkg` method that exposes pkg-store to your base application. | [homepage](https://github.com/node-base/base-pkg)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/node-base/base-project/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/node-base/base-project/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 20, 2016._

---
_Source: https://npm.io/package/base-project · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._