project-name

project-name

Get the name of a project, from package.json, git config, basename of the current working directory or, when all else fails, module caller.

Install

Install with npm

$ npm i project-name --save

Usage

The project name is resolved in this order:

1. check for package.json, if exists name is returned
2. check for git repository, if exists return repository name
3. use the path.basename of the current working directory

var name = require('project-name');
name();
//=> project-name

Optionally specify a current working directory:

var name = require('project-name');
name('foo');

Related projects

• git-repo-name: Get the repository name from the git remote origin URL. | homepage
• git-user-email: Get the email address of the current user from git config. | homepage
• git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
• git-username: Get the username from a git remote origin URL. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on October 20, 2015.