Awesome

Support Neovim version

0.10 or higher

Installation

lazy.nvim

return {
  "tadashi-aikawa/ghostwriter.nvim",
  dependencies = {
    "nvim-lua/plenary.nvim",
  },
  keys = {
    { "<C-j>w", ":GhostwriterWrite<CR>", silent = true },
    { "<C-j>p", ":GhostwriterPost times<CR>", mode = { "v" }, silent = true },
    { "<C-j>y", ":GhostwriterCopy<CR>", mode = { "v" }, silent = true },
  },
  config = function()
    require("ghostwriter").setup({
      -- Set options
    })
  end,
}

Requirements

You should create a "Slack user token" with the chat:write scope and set it to the GHOSTWRITER_SLACK_TOKEN environment variable.

Quick start

1. Create a markdown file (ex: task.md)
2. In the first line, write one of the following a. the URL of the reference Slack post b. the URL of the channel c. the channel ID and ts separated by a comma d. the channel ID
3. List the tasks from the third line onwards
4. Execute the GhostwriterWrite command
5. Let's check the relevant Slack channel! 👻

Ex a: Delete the relevant message and repost it in the channel as a new message.

https://minerva.slack.com/archives/C2J10C5MF/p1722259290076499

- [x] task1
- [x] task2
  - [x] task2-1
  - [~] task2-2
- [ ] task3

Ex b: Post a new message in the channel.

https://app.slack.com/client/TKY180702/C2J10C5MF

- [x] task1
- [x] task2
  - [x] task2-1
  - [ ] task2-2
- [ ] task3

Ex c: Delete the relevant message and repost it in the channel as a new message.

C2J10C5MF,1722347931.398509

- [x] task1
- [x] task2
  - [x] task2-1
  - [ ] task2-2
- [ ] task3

Ex d: Post a new message in the channel.

C2J10C5MF

## section1

- [x] task1
  - note1
  - note2

## section2

- [ ] task2

---
This line and below are excluded.

- hoge
- hoge

Commands

GhostwriterWrite

Notify the first section of the current buffer to Slack.

GhostwriterWrite

GhostwriterPost

Notify the selected range in visual mode to a specified Slack channel.

GhostwriterPost <channel_name> [header]

Examples

GhostwriterPost times
GhostwriterPost times I like *Neovim!!!*
GhostwriterPost task walking

GhostwriterCopy

Copy the selected range in visual mode to the clipboard as Slack post format

GhostwriterCopy

Configration

  config = function()
    -- Default configration
    require("ghostwriter").setup({
      -- If true, the buffer will be automatically saved when the post is successful
      autosave = true,
      -- Defines the replacers in Slack notification messages
      replacers = {
        { pattern = "202%d+_", replaced = " " },
        { pattern = " %d%d:%d%d ", replaced = " " },
      },
      -- Defines the checkboxes converted to emojis in Slack notification messages
      check = {
        { mark = "x", emoji = "large_green_circle" },
        { mark = " ", emoji = "white_circle" },
      },
      bullet = {
        -- The emoji that bullets are converted to in Slack notification messages
        emoji = "small_blue_diamond",
      },
      indent = {
        -- How many times the Markdown indentation is multiplied in Slack notification messages
        ratio = 2,
      },
      header = {
        -- Number of visual line breaks before headers
        before_blank_lines = 1,
      },
      link = {
        -- Convert Markdown links to plaintext (ex: [hoge](http://hoge) -> hoge) 
        disabled = false,
      },
      -- Mapping of channel names and channel IDs specified by command arguments
      channel = {
        { name = "times", id = "C1C5MJ80F" },
        { name = "task", id = "C06JRG10V2L" },
      },
    })
  end,

Restrictions

[!WARNING] If the body exceeds 4000 characters, an error will occur. Please keep each post under 4000 characters.

[!IMPORTANT] This plugin is newly created and its specifications are likely to change soon, so please use it with that in mind.

Recommended plugins to use together

• MeanderingProgrammer/markdown.nvim
• roodolv/markdown-toggle.nvim

For developers

Setup

git config core.hooksPath hooks

Release

Run Release Action manually.