# autogit-plugin-autocommit

> A plugin for automatically making a commit when specific files change.

Latest version **1.0.3** (published 2018-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install autogit-plugin-autocommit
pnpm add autogit-plugin-autocommit
yarn add autogit-plugin-autocommit
bun add autogit-plugin-autocommit
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-12-06 |
| First published | 2018-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Fabio Spampinato |
| Maintainers | fabiospampinato |
| Keywords | autogit, plugin, autocommit |

## Links

- npm: https://www.npmjs.com/package/autogit-plugin-autocommit
- Repository: https://github.com/fabiospampinato/autogit-plugin-autocommit
- Homepage: https://github.com/fabiospampinato/autogit-plugin-autocommit#readme
- Issues: https://github.com/fabiospampinato/autogit-plugin-autocommit/issues
- npm.io page: https://npm.io/package/autogit-plugin-autocommit

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [simple-git](https://npm.io/package/simple-git.md) ^1.104.0
- [@types/node](https://npm.io/package/@types/node.md) ^10.12.8

## Recent versions

- 1.0.3 (latest) — 2018-12-06
- 1.0.2 — 2018-11-12
- 1.0.1 — 2018-10-11
- 1.0.0 — 2018-10-08

## README

# Autogit Plugin - Autocommit

A plugin for automatically making a commit when specific files change.

## Install

```sh
npm install --save autogit-plugin-autocommit
```

## Usage

#### Options

This plugin uses the following options object:

```js
{
  message: '', // Commit message
  paths: [] // When these paths change a commit will be made
}
```

#### Configuration

Add this plugin to a command:

```js
const autocommit = require ( 'autogit-plugin-autocommit' );

module.exports = {
  commands: {
    'my-command': [
      autocommit ({ message: 'Readme: updated', paths: ['README.md'] })
    ]
  }
}
```

## License

MIT © Fabio Spampinato

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