git-flush

Commits and pushes if repository is dirty. Does nothing otherwise.

Installation

npm install --save git-flush@^2.0.3

yarn add git-flush@^2.0.3

Reference

• git-flush
  • ~_default([message], [options]) ⇒ Promise.<(null|number)>
    • ~normalizedOptions : Options
  • ~Options : Object

git-flush~_default([message], [options]) ⇒ Promise.<(null|number)>

If repository is dirty, the changes will be stashed, committed and optionally pushed. If repository is clean, does nothing.

Kind: inner method of git-flush
Returns: Promise.<(null|number)> - null if directory is not a git repository, number of commit changes if directory is a git repository

Param	Type	Default
[message]	string	"Commit from script"
[options]	Options	{}

Example

import gitFlush from "git-flush"
const result = await gitFlush("Commit message")

_default~normalizedOptions : Options

Kind: inner constant of _default

git-flush~Options : Object

Kind: inner typedef of git-flush
Properties

Name	Type	Description
directory	string	Path to the git repository
push	boolean	If true, pushes after committing
pull	boolean	If true, pulls before committing

Development

Setting up:

git clone [e-mail]:Jaid/git-flush.git
cd git-flush
npm install

Testing:

npm run test:dev

Testing in production environment:

npm run test

License

MIT License
 
Copyright © 2020, Jaid <[e-mail]> (github.com/jaid)
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.