# is-git-sync

> determines if a git repository exists within a directory

Latest version **1.0.2** (published 2019-07-14) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install is-git-sync
pnpm add is-git-sync
yarn add is-git-sync
bun add is-git-sync
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-07-14 |
| First published | 2019-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dj0nny |
| Maintainers | dj0nny |
| Keywords | node.js, git, folder, git repository, local, directory, git directory |

## Links

- npm: https://www.npmjs.com/package/is-git-sync
- Repository: https://github.com/dj0nny/is-git-sync
- Homepage: https://github.com/dj0nny/is-git-sync#readme
- Issues: https://github.com/dj0nny/is-git-sync/issues
- npm.io page: https://npm.io/package/is-git-sync

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2019-07-14
- 1.0.1 — 2019-07-13
- 1.0.0 — 2019-07-13

## README

# is-git-sync

[![npm version](https://badge.fury.io/js/is-git-sync.svg)](https://badge.fury.io/js/is-git-sync)
![npm](https://img.shields.io/npm/dm/is-git-sync.svg)

> Determines if a git repository exists within a directory

## Getting Started

### Prerequisites

For this project you need [__Node__](https://nodejs.org/en/) installed on your machine with [__Npm__](https://www.npmjs.com/) or [__Yarn__](https://yarnpkg.com)

### Installing

Open a terminal and type, inside the directory:
```bash
npm i is-git-sync
# OR
yarn add is-git-sync
```

### Usage

```javascript
if(isGitSync(process.cwd())) {
  console.log('Yes dude, there is a git repository')
} else {
  console.log('Sorry dude, there is no git repository is this folder')
}
```

## Built with ❤️ using:

* [Node.js](https://nodejs.org) - JavaScript runtime built on Chrome's V8 JavaScript engine.

## Contributing

Pull Requests for adding features ⇄ and ★ are welcome 😎

---
_Source: https://npm.io/package/is-git-sync · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
