ensure-git

0.1.0 • Public • Published

ensure-git

NPM version NPM downloads Build Status donate

Why?

You always need to ensure that git working tree is clean and no conficts in your repo before publishing your package.

Install

yarn add ensure-git

Usage

const ensureGit = require('ensure-git')
 
ensureGit()
  .then(() => {
    console.log('All good! you can now run npm publish ;)')
  })
  .catch(err => {
    console.error(err.message)
    process.exit(1)
  })

API

ensureGit([options])

options

cwd

Type: string
Default: process.cwd()

The path to check.

anyBranch

Type: boolean
Default: undefined

By default if it's not on master branch the program will throw an error, use this option to disable the behavior.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

ensure-git © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin

Readme

Keywords

none

Package Sidebar

Install

npm i ensure-git

Weekly Downloads

6

Version

0.1.0

License

MIT

Last publish

Collaborators

  • rem