https://github.com/fabiospampinato/autogit-plugin-summary

A plugin for displaying a summary of all the changes in the working tree.
https://github.com/fabiospampinato/autogit-plugin-summary

autogit plugin summary

Last synced: 3 months ago
JSON representation

A plugin for displaying a summary of all the changes in the working tree.

• Host: GitHub
• URL: https://github.com/fabiospampinato/autogit-plugin-summary
• Owner: fabiospampinato
• License: mit
• Archived: true
• Created: 2018-10-19T12:40:59.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-24T20:28:00.000Z (almost 5 years ago)
• Last Synced: 2024-05-01T12:39:09.208Z (6 months ago)
• Topics: autogit, plugin, summary
• Language: TypeScript
• Size: 10.7 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Autogit Plugin - Summary

A plugin for displaying a summary of all the changes in the working tree.

It works great in combination with [autogit-plugin-confirmation](https://github.com/fabiospampinato/autogit-plugin-confirmation). Together they allow you to check all the changes manually before performing importat work like committing or publishing.

## Install

```sh

npm install --save autogit-plugin-summary

```

## Usage

#### Options

This plugin uses the following options object:

```js

{

  onlyStaged: true, // Only show changes regarding staged files

  diff: true, // Show the diff of modified files

  content: true // Show the content of new files

}

```

#### Configuration

Add this plugin to a command:

```js

const summary = require ( 'autogit-plugin-summary' );

module.exports = {

  commands: {

    'my-command': [

      summary ({ /* YOUR OPTIONS */ })

    ]

  }

}

```

## License

MIT © Fabio Spampinato