Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

🌐 Gets the origin URL of a local Git repository. 🗺️
https://github.com/igorskyflyer/npm-git-repo-url

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

Last synced: 3 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/igorskyflyer/npm-git-repo-url
Owner: igorskyflyer
License: mit
Created: 2024-07-28T22:31:13.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-08-02T19:55:26.000Z (about 2 months ago)
Last Synced: 2024-09-02T18:07:36.621Z (25 days ago)
Topics: back-end, directory, folder, git, github, gitlab, igorskyflyer, javascript, js, node, repo, repository, ts, typescript, url
Language: TypeScript
Homepage: https://www.npmjs.com/package/@igor.dvlpr/git-repo-url
Size: 71.3 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

        
Git Repo URL







  🌐 Gets the origin URL of 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)

  - [getRepoUrl()](#getrepourloptions-promisestring)

  - [getRepoUrlSync()](#getrepourlsyncoptions-string)

- [Examples](#-examples)

- [Changelog](#-changelog)

- [License](#-license)

- [Related](#-related)

- [Author](#-author)







## 🤖 Features

- 🔍 gets the URL of a local 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/git-repo-url'

```

---

## 🤹🏼 API

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

*Asynchronously gets the URL of a local directory if it 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 the URL if the directory is a Git repository, otherwise an empty string.

---

### `getRepoUrlSync(options?): string`

*Synchronously gets the URL of a local directory if it 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 the URL if the directory is a Git repository, otherwise an empty string.

---

## ✨ Examples

`example.mts`

```ts

import { getRepoUrlSync } from '@igor.dvlpr/git-repo-url'

console.log(getRepoUrlSync()) // prints e.g. 'https://github.com/igorskyflyer/npm-duoscribi'

```

---

## 📝 Changelog

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

---

## 🪪 License

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

---

## 🧬 Related

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

> _📖 Provides recursive readdir() and readdirSync() functions. 📁_




[@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/vscode-folderpicker](https://www.npmjs.com/package/@igor.dvlpr/vscode-folderpicker)

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




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

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




[@igor.dvlpr/regkeys](https://www.npmjs.com/package/@igor.dvlpr/regkeys)

> _📚 An npm package for fetching Windows registry keys. 🗝_

---

## 👨🏻‍💻 Author

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