https://github.com/bukinoshita/is-github-repo
Checks if string is a git repository
https://github.com/bukinoshita/is-github-repo
checker git github javascript node nodejs repository
Last synced: 3 months ago
JSON representation
Checks if string is a git repository
- Host: GitHub
- URL: https://github.com/bukinoshita/is-github-repo
- Owner: bukinoshita
- License: mit
- Created: 2017-06-22T20:08:35.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T23:22:58.000Z (almost 3 years ago)
- Last Synced: 2025-03-07T21:17:31.182Z (8 months ago)
- Topics: checker, git, github, javascript, node, nodejs, repository
- Language: TypeScript
- Homepage:
- Size: 711 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# is-github-repo [](https://travis-ci.org/bukinoshita/is-github-repo)
> Checks if string is a git repository
## Install
```
$ yarn add is-github-repo
```
## Usage
```js
const isGithubRepo = require('is-github-repo')
/* with HTTPS */
isGithubRepo('https://github.com/bukinoshita/is-github-repo.git')
// => true
/* with SSH */
isGithubRepo('git@github.com:bukinoshita/is-github-repo.git')
// => true
/* with owner/repo */
isGithubRepo('bukinoshita/is-github-repo')
// => true
```
## API
### isGithubRepo(repo)
returns a `boolean`.
#### repo
Type: `string`
Required
## Related
- [git-synced](https://github.com/bukinoshita/git-synced) — 🎐 Keep a fork up to date
- [del-git-index](https://github.com/bukinoshita/del-git-index) — Safely delete index.lock of the current project
- [repo-exist](https://github.com/bukinoshita/repo-exist) — Checks if GitHub repository exist
- [gopn](https://github.com/bukinoshita/gopn) — Open GitHub repositories
- [is-github-rify](https://github.com/bukinoshita/git-url-uglify) — Uglify git url
- [git-url-prettify](https://github.com/bukinoshita/git-url-prettify) — Prettify git url
## License
MIT © [Bu Kinoshita](https://bukinoshita.io)