Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sophilabs/gilp-util
Utils for gilp.
https://github.com/sophilabs/gilp-util
gilp
Last synced: 18 days ago
JSON representation
Utils for gilp.
- Host: GitHub
- URL: https://github.com/sophilabs/gilp-util
- Owner: sophilabs
- License: mit
- Created: 2016-06-27T23:46:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T15:19:05.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T16:44:25.383Z (8 months ago)
- Topics: gilp
- Language: JavaScript
- Homepage: https://sophilabs.co/open-source
- Size: 623 KB
- Stars: 3
- Watchers: 12
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gilp Util
[![travis][travis-image]][travis-url]
[![coverage][coveralls-image]][coveralls-url]
[![npm][npm-image]][npm-url]
[![downloads][downloads-image]][downloads-url]
[![js-semistandard-style][semi-image]][semi-url]
[![license][license-image]][license-url]
[![dependencies][dependencies-image]][dependencies-url]
[![dev-dependencies][dev-dependencies-image]][dev-dependencies-url]
Utils for gilp.
## Installation
```bash
npm install gilp-util
```
or
```bash
yarn add gilp-util
```
## Usage
### getArgs()
Read git hook's parameters.
```javascript
const gilpUtil = require('gilp-util');
gilpUtil.getArgs();
```
### getBranchName()
Get current branch
```javascript
const gilpUtil = require('gilp-util');
gilpUtil.getBranchName();
```
### getGitDirectory()
Return full path to git directory.
### getBaseDirectory()
Return full path to base directory.
### isInMerge()
Return `true` if a merge is in progress.
## getCommitMessage()
Return commit message.
## License
Gilp Util is Copyright (c) 2020 sophilabs, inc. It is free software, and may be
redistributed under the terms specified in the [license] file.
## About
[![sophilabs][sophilabs-image]][sophilabs-url]
Gilp Util is maintained and funded by sophilabs, inc. The names and logos for
sophilabs are trademarks of sophilabs, inc.
[license]: /LICENSE
[sophilabs-image]: https://s3.amazonaws.com/sophilabs-assets/logo/logo_300x66.gif
[sophilabs-url]: https://sophilabs.co
[travis-image]: https://img.shields.io/travis/sophilabs/gilp-util.svg?style=flat-square
[travis-url]: https://travis-ci.org/sophilabs/gilp-util
[npm-image]: https://img.shields.io/npm/v/gilp-util.svg?style=flat-square
[npm-url]: https://npmjs.org/package/gilp-util
[downloads-image]: https://img.shields.io/npm/dm/gilp-util.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/gilp-util
[semi-image]: https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square
[semi-url]: https://github.com/Flet/semistandard
[coveralls-image]: https://img.shields.io/coveralls/sophilabs/gilp-util.svg?style=flat-square
[coveralls-url]: https://coveralls.io/github/sophilabs/gilp-util?branch=master
[license-image]: https://img.shields.io/github/license/sophilabs/gilp-util.svg?style=flat-square
[license-url]: /LICENSE
[dependencies-image]: https://david-dm.org/sophilabs/gilp-util.svg?style=flat-square
[dependencies-url]: https://david-dm.org/sophilabs/gilp-util
[dev-dependencies-image]: https://david-dm.org/sophilabs/gilp-util/dev-status.svg?style=flat-square
[dev-dependencies-url]: https://david-dm.org/sophilabs/gilp-util#info=devDependencies