Package Exports

@igor.dvlpr/is-git-repo
@igor.dvlpr/is-git-repo/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@igor.dvlpr/is-git-repo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

🤖 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 executable is installed and available in the system path.

If not, it needs to be installed first.

Install the module by executing:

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

🤹🏼 API

`isGitRepo(options?): Promise<boolean>`

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

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

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

📝 Changelog

📑 The changelog is available here: CHANGELOG.md.

🪪 License

Licensed under the MIT license which is available here, MIT license.

@igor.dvlpr/vscode-folderpicker

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

@igor.dvlpr/git-repo-url

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

@igor.dvlpr/is-rootdir

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

@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

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

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).

@igor.dvlpr/is-git-repo