Get the name of a project, from package.json, git config, or basename of the current working directory.
npm install project-name> Get the name of a project, from package.json, git config, or basename of the current working directory.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install with npm:
``sh`
$ npm install --save project-name
Requires Node.js >=8.
Project name
The project name is resolved in this order:
1. Check for package.json, if it exists name is returnedname
2. Check for git repository, if it exists return the parsed from the remote origin URLpath.basename(process.cwd())
3. Otherwise, use
`js`
const name = require('project-name');
console.log(name());
// or
console.log(name('some/file/path'));
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
`sh`
$ npm install && npm test
Building docs
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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 (or 'owner' name) from a git/GitHub remote origin URL. | homepage from a git/GitHub remote origin URL.")
Jon Schlinkert
* GitHub Profile
* Twitter Profile
* LinkedIn Profile
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.8.0, on December 10, 2018._