igorskyflyer
Is Git Repo
🐸 Checks if a directory is a local Git repository. 🕶️
📃 Table of Contents
🤖 Features
- ⚡ Async & sync checks — verify Git repo status your way
- 📂 Custom directory — point to any folder, not just the current one
- 🛡 Input validation — catches invalid or missing paths early
- 🚫 Existence check — errors if the directory doesn’t exist
- 🖥 Direct Git command — uses git rev-parse for accurate detection
- ✅ Boolean result — simple true/false output for easy logic flow
- 🧩 Error-safe — gracefully handles Git errors without crashing
- 🪶 Lightweight dependency — minimal overhead, fast execution
⚠️ WARNING
This module requires that the
gitexecutable is installed and available in the system path.If not, it needs to be installed first.
🕵🏼 Usage
Install it by executing any of the following, depending on your preferred package manager:
pnpm add @igorskyflyer/is-git-repoyarn add @igorskyflyer/is-git-reponpm i @igorskyflyer/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.ts
import { isGitRepoSync } from '@igorskyflyer/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.
💖 Support
Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊
🧬 Related
@igorskyflyer/vscode-folderpicker
✨ Provides a custom Folder Picker API + UI for Visual Studio Code. 🎨
🌐 Gets the origin URL a local Git repository. 🗺️
🔼 Provides a way to check if the given path is the root drive/directory. ⛔
🧵 Provides ways of checking whether a String is present in an Array of Strings using custom Comparators. 🔍
🪐 Provides ways of testing whether an array of chars is present inside a given String. ☄
👨🏻💻 Author
Created by Igor Dimitrijević (@igorskyflyer).