project-name

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 12 Open GitHub ↗

Get the name of a project from package.json, git config, or basename of the current working directory.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# project-name [![NPM version](https://img.shields.io/npm/v/project-name.svg?style=flat)](https://www.npmjs.com/package/project-name) [![NPM monthly downloads](https://img.shields.io/npm/dm/project-name.svg?style=flat)](https://npmjs.org/package/project-name) [![NPM total downloads](https://img.shields.io/npm/dt/project-name.svg?style=flat)](https://npmjs.org/package/project-name) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/project-name.svg?style=flat&label=Travis)](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
```

Install [Type Definitions](https://www.npmjs.com/package/@types/project-name)

```sh
$ npm install --save @types/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

<details>
<summary>Contributing</summary>

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

</details>

<details>
<summary>Running Tests</summary>

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
```

</details>

<details>
<summary>Building docs</summary>

_(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
```

</details>

### 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

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on December 10, 2018._

project-name

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README