https://github.com/zachflower/hyper-confirm

:no_entry: Plugin to show a confirmation dialog before quitting Hyper
https://github.com/zachflower/hyper-confirm

confirmation-dialog hacktoberfest hyper

Last synced: about 2 months ago
JSON representation

:no_entry: Plugin to show a confirmation dialog before quitting Hyper

• Host: GitHub
• URL: https://github.com/zachflower/hyper-confirm
• Owner: zachflower
• License: mit
• Archived: true
• Created: 2017-08-19T03:12:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T14:51:05.000Z (3 months ago)
• Last Synced: 2024-08-08T18:38:11.419Z (about 2 months ago)
• Topics: confirmation-dialog, hacktoberfest, hyper
• Language: JavaScript
• Homepage:
• Size: 576 KB
• Stars: 21
• Watchers: 3
• Forks: 5
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
> [!IMPORTANT]  

> hyper-confirm is no longer in active maintenance, so it is not recommended to be used and unlikely to work with the latest versions of Hyper. I am not aware of a replacement plugin, but will happily add a link here if someone wants to send one my way.

![build](https://github.com/zachflower/hyper-confirm/workflows/Node.js%20CI/badge.svg) [![npm](https://img.shields.io/npm/v/hyper-confirm.svg)](https://www.npmjs.com/package/hyper-confirm) [![npm](https://img.shields.io/npm/dt/hyper-confirm.svg)](https://www.npmjs.com/package/hyper-confirm) [![npm](https://img.shields.io/npm/l/hyper-confirm.svg)](https://www.npmjs.com/package/hyper-confirm)

# hyper-confirm

`hyper-confirm` is a plugin for [Hyper](https://hyper.is/) (formerly HyperTerm) that shows a confirmation dialog before quitting Hyper. This functionality, which is found in other terminal emulators like [iTerm2](https://www.iterm2.com/), provides a safety net against accidentally quitting Hyper (a common problem outlined in [Hyper Issue #399](https://github.com/zeit/hyper/issues/399)).

![](.github/demo.gif)

## Installation

### Via [hpm](https://github.com/zeit/hpm)

To install `hyper-confirm` via `hpm` (recommended), run the following command in your terminal:

```

hpm install hyper-confirm

```

### Manually

If you don't use `hpm`, add `hyper-confirm` to the `plugins` array in your Hyper config file (typically found at `~/.hyper.js`):

```javascript

  plugins: [

    ...

    'hyper-confirm'

  ]

```

## Configuration

As of [v1.0.0](https://github.com/zachflower/hyper-confirm/releases/tag/v1.0.0), the quit confirmation dialog is enabled by default. To disable it, add `confirmQuit: false` to the `config` object in your Hyper config file (typically found at `~/.hyper.js`):

```javascript

  module.exports = {

    config: {

      ...

      confirmQuit: false

    },

    ...

  };

```

## Credits

- [@albinekb](https://github.com/albinekb), who opened [this unmerged pull request](https://github.com/zeit/hyper/pull/403) that acted as the foundation for `hyper-confirm`

## License

`hyper-confirm` is released under the [MIT License](LICENSE.md).