https://github.com/stefanlogue/hydrate.nvim

Reminders to keep hydrated while you code
https://github.com/stefanlogue/hydrate.nvim

neovim neovim-lua-plugin neovim-plugin

Last synced: 17 days ago
JSON representation

Reminders to keep hydrated while you code

• Host: GitHub
• URL: https://github.com/stefanlogue/hydrate.nvim
• Owner: stefanlogue
• Created: 2023-08-30T14:39:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-12T10:22:58.000Z (4 months ago)
• Last Synced: 2024-08-01T16:44:58.226Z (4 months ago)
• Topics: neovim, neovim-lua-plugin, neovim-plugin
• Language: Lua
• Homepage:
• Size: 4.85 MB
• Stars: 60
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        


  

  


  
 💧 hydrate.nvim 💧 

  
Neovim plugin to remind you to keep hydrated while you code

  
'Water is the only drink for a wise man' - Henry David Thoreau


  [![Lua](https://img.shields.io/badge/Lua-blue.svg?style=for-the-badge&logo=lua)](http://www.lua.org)

  [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/stefanlogu4)



## Table of contents

- [Installation](#installation)

  - [Optional Requirements](#requirements)

  - [lazy.nvim](#lazy)

- [Config](#config)

- [Commands](#commands)

- [Contributing](#contributing)

## Installation

### Optional requirements

- [nvim-notify](https://github.com/rcarriga/nvim-notify)

### lazy.nvim

```lua

{

  "stefanlogue/hydrate.nvim",

  -- This installs the latest stable release.

  -- Set to false or omit to install the latest development version

  version = "*",

  opts = {

    -- See below for config options

  }

}

```

## Config

This is a list of the options that can be passed to `require("hydrate").setup()` with their default values:

```lua

{

  -- The interval between notifications in minutes

  minute_interval = 20,

  -- The render style for notifications

  -- Accepted values are "default", "minimal", "simple" or "compact"

  render_style = "compact",

  -- Loads time of last drink on startup

  -- Useful if you don't have long-running neovim instances

  -- or if you tend to have multiple instances running at a time

  persist_timer = false,

  -- Sets the reminder message after "minute_interval" minutes have 

  -- passed to the the specified message

  msg_hydrate_now = " 💧 Time for a drink ",

  -- Sets the message after acknowledging the reminder to the 

  -- specified message

  msg_hydrated = " 💧 You've had a drink, timer reset 💧",

  -- Sets text displayed before time in minutes for

  -- ":HydrateWhen" message

  msg_minutes_until = "Drink due in",

}

```

## Commands

- `HydrateWhen` - Prints minutes until next drink

- `HydrateNow` - Tell us you've had a drink so we can reset the timer

- `DrinkInterval` - Set the interval between drinks in minutes

- `HydrateDisable` - Disable hydration reminders

- `HydrateEnable` - Enable hydration reminders

## Contributing

Please read the [CONTRIBUTING](https://github.com/stefanlogue/hydrate.nvim/blob/main/.github/CONTRIBUTING.md) guide before submitting a pull request.

## Acknowledgements

[stand.nvim](https://github.com/mvllow/stand.nvim) for the general idea