# project-name
> Get the name of a project, from package.json, git config, or basename of the current working directory.
Latest version **1.0.0** (published 2018-12-10) · MIT license · 0 weekly downloads
## Install
```sh
npm install project-name
pnpm add project-name
yarn add project-name
bun add project-name
```
## Health
**Score 23/100 (F)** — status: abandoned.
Positive: has types package; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-12-10 |
| First published | 2015-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/project-name) |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | app, detect, dir, directory, dirname, match, name, project, resolve, root |
## Links
- npm: https://www.npmjs.com/package/project-name
- Repository: https://github.com/jonschlinkert/project-name
- Issues: https://github.com/jonschlinkert/project-name/issues
- npm.io page: https://npm.io/package/project-name
## Dependencies (1)
- [git-repo-name](https://npm.io/package/git-repo-name.md) ^1.0.1
## 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
- 1.0.0 (latest) — 2018-12-10
- 0.2.6 — 2016-07-13
- 0.2.5 — 2016-05-12
- 0.2.4 — 2016-01-10
- 0.2.3 — 2015-11-28
- 0.2.2 — 2015-11-28
- 0.2.1 — 2015-11-04
- 0.2.0 — 2015-10-20
## README
# project-name [](https://www.npmjs.com/package/project-name) [](https://npmjs.org/package/project-name) [](https://npmjs.org/package/project-name) [](https://travis-ci.org/jonschlinkert/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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save project-name
```
## Usage
Requires [Node.js](https://nodejs.org/en/) >=8.
**Project name**
The project name is resolved in this order:
1. Check for package.json, if it exists `name` is returned
2. Check for git repository, if it exists return the `name` parsed from the remote origin URL
3. Otherwise, use `path.basename(process.cwd())`
```js
const name = require('project-name');
console.log(name());
// or
console.log(name('some/file/path'));
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
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](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [git-repo-name](https://www.npmjs.com/package/git-repo-name): Get the repository name from the git remote origin URL. | [homepage](https://github.com/jonschlinkert/git-repo-name "Get the repository name from the git remote origin URL.")
* [git-user-email](https://www.npmjs.com/package/git-user-email): Get the email address of the current user from git config. | [homepage](https://github.com/jonschlinkert/git-user-email "Get the email address of the current user from git config.")
* [git-user-name](https://www.npmjs.com/package/git-user-name): Get a user's name from git config at the project or global scope, depending on… [more](https://github.com/jonschlinkert/git-user-name) | [homepage](https://github.com/jonschlinkert/git-user-name "Get a user's name from git config at the project or global scope, depending on what git uses in the current context.")
* [git-username](https://www.npmjs.com/package/git-username): Get the username (or 'owner' name) from a git/GitHub remote origin URL. | [homepage](https://github.com/jonschlinkert/git-username "Get the username (or 'owner' name) from a git/GitHub remote origin URL.")
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on December 10, 2018._
---
_Source: https://npm.io/package/project-name · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._