npm-is-git-repo

📃 Table of contents

• Features
• Usage
• API
  • isGitRepo()
  • isGitRepoSync()
• Examples
• Changelog
• License
• Related
• 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 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.

🧬 Related

@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).