Package Exports
- project-name
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (project-name) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
project-name 
Get the name of a project, from package.json, git config, or basename of the current working directory.
Install
Install with npm:
$ npm install project-name --saveUsage
The project name is resolved in this order:
- check for package.json, if exists
nameis returned - check for git repository, if exists return repository
name - use the
path.basenameof the current working directory
var name = require('project-name');
name();
//=> project-nameOptionally specify a current working directory:
var name = require('project-name');
name('foo');Related projects
You might also be interested in these 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
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 docsOr, if verb is installed globally:
$ verbRunning tests
Install dev dependencies:
$ npm install -d && npm testAuthor
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on May 12, 2016.