Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/igorskyflyer/npm-is-git-repo

🐸 Checks if a directory is a local Git repository. 🕶️
https://github.com/igorskyflyer/npm-is-git-repo

back-end directory folder git github gitlab igorskyflyer javascript js node repo repository ts typescript

Last synced: 3 days ago
JSON representation

🐸 Checks if a directory is a local Git repository. 🕶️

Host: GitHub
URL: https://github.com/igorskyflyer/npm-is-git-repo
Owner: igorskyflyer
License: mit
Created: 2024-07-28T22:37:43.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-08-02T19:45:57.000Z (about 2 months ago)
Last Synced: 2024-09-02T17:57:52.763Z (25 days ago)
Topics: back-end, directory, folder, git, github, gitlab, igorskyflyer, javascript, js, node, repo, repository, ts, typescript
Language: TypeScript
Homepage: https://www.npmjs.com/package/@igor.dvlpr/is-git-repo
Size: 54.7 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        
Is Git repo?







  🐸 Checks if a directory is a local Git repository. 🕶️











  

    


    💖 Support further development

    I work hard for every project, including this one

    


    and your support means a lot to me!

    


    


    Consider buying me a coffee. ☕

    


    Thank you for supporting my efforts! 🙏😊

    


    


    

    


    


    @igorskyflyer

    


    


    


  









## 📃 Table of contents

- [Features](#-features)

- [Usage](#-usage)

- [API](#-api)

  - [isGitRepo()](#isgitrepooptions-promiseboolean)

  - [isGitRepoSync()](#isgitreposyncoptions-boolean)

- [Examples](#-examples)

- [Changelog](#-changelog)

- [License](#-license)

- [Related](#-related)

- [Author](#-author)







## 🤖 Features

- 🔍 checks if a directory is a Git repo

- ⌚ both async and sync methods supported

- 👽 cross-platform

- ⚖️ lightweight

---

## 🕵🏼 Usage

> [!WARNING]

> This module requires that the [`git`](https://git-scm.com) executable is installed and available in the system path.

>

> If not, it needs to be installed first.

>




Install the module by executing:

```shell

npm i '@igor.dvlpr/is-git-repo'

```

---

## 🤹🏼 API

### `isGitRepo(options?): Promise`

*Asynchronously checks if a local directory is a Git repository.*  

 

`options` - Optional object with options:

  - `directory` - Sets the current working directory, otherwise the current directory will be used instead.




Will throw an error if the passed directory is not valid or does not exist.  

Returns a Boolean indicating whether provided local directory is a Git repository.

---

### `isGitRepoSync(options?): boolean`

*Synchronously checks if a local directory is a Git repository.*  

 

`options` - Optional object with options:

  - `directory` - Sets the current working directory, otherwise the current directory will be used instead.




Will throw an error if the passed directory is not valid or does not exist.  

Returns a Boolean indicating whether provided local directory is a Git repository.

---

## ✨ Examples

`example.mts`

```ts

import { isGitRepoSync } from '@igor.dvlpr/is-git-repo'

console.log(isGitRepoSync({ directory: '../my-git-project' })) // true

```

---

## 📝 Changelog

📑 The changelog is available here: [CHANGELOG.md](https://github.com/igorskyflyer/npm-is-git-repo/blob/main/CHANGELOG.md).

---

## 🪪 License

Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-is-git-repo/blob/main/LICENSE).

---

## 🧬 Related

[@igor.dvlpr/vscode-folderpicker](https://www.npmjs.com/package/@igor.dvlpr/vscode-folderpicker)

> _✨ Provides a custom Folder Picker API + UI for Visual Studio Code. 🎨_




[@igor.dvlpr/git-repo-url](https://www.npmjs.com/package/@igor.dvlpr/git-repo-url)

> _🌐 Gets the origin URL a local Git repository. 🗺️_




[@igor.dvlpr/is-rootdir](https://www.npmjs.com/package/@igor.dvlpr/is-rootdir)

> _🔼 Provides a way to check if the given path is the root drive/directory. ⛔_




[@igor.dvlpr/str-is-in](https://www.npmjs.com/package/@igor.dvlpr/str-is-in)

> _🧵 Provides ways of checking whether a String is present in an Array of Strings using custom Comparators. 🔍_




[@igor.dvlpr/chars-in-string](https://www.npmjs.com/package/@igor.dvlpr/chars-in-string)

> _🪐 Provides ways of testing whether an array of chars is present inside a given String. ☄_

---

## 👨🏻‍💻 Author

Created by **Igor Dimitrijević** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).