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 ❤️ and support.
Install with npm:
$ npm install --save project-name
Requires Node.js >=8.
The project name is resolved in this order:
- Check for package.json, if it exists
- Check for git repository, if it exists return the
nameparsed from the remote origin URL
- Otherwise, use
const name = ;console;// orconsole;
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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:
$ npm install && npm test
To generate the readme, run the following command:
$ 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
This file was generated by verb-generate-readme, v0.8.0, on December 10, 2018.