Easily generate dummy text in Neovim

use {
  'derektata/lorem.nvim',
  config = function()
    require('lorem').opts {
      sentence_length = "medium",
      comma_chance = 0.2,
      max_commas = 2,
    }
  end
}

return {
  'derektata/lorem.nvim',
  config = function()
      require('lorem').opts {
          sentence_length = "medium",
          comma_chance = 0.2,
          max_commas = 2,
      }
  end
}

The plugin is designed to be as plug-and-play as possible, and therefore no setup is needed as it is shipped with sensible defaults. It is hovewer possible to customize the behavior of the plugin in setup like this:

require('lorem').opts {
    sentence_length = "mixed",  -- using a default configuration
    comma_chance = 0.3,  -- 30% chance to insert a comma
    max_commas = 2  -- maximum 2 commas per sentence
}

-- or

require('lorem').opts {
    sentence_length = { -- custom configuration
      w_per_sentence = 8,
      s_per_paragraph = 6
    },
    comma_chance = 0.3,  -- 30% chance to insert a comma
    max_commas = 2  -- maximum 2 commas per sentence
}

This property determines the intervals for how long the sentences of latin words should be before ending them with a period. The following values are available:

This property controls the likelihood of inserting a comma after a word within a sentence. This property allows for the generation of more natural-looking text by adding occasional commas, mimicking the natural pauses in human writing.

This property sets the maximum number of commas that can be inserted in a single sentence. This property ensures that sentences do not become overly complex or cluttered with too many commas, maintaining readability and natural flow.

This property defines a list of keys that are mapped to trigger specific actions, such as generating text or handling keywords. By default, the mappings property is set to <Space>, which means pressing the spacebar will invoke the text generation logic while typing. You can customize this list to include additional keys if desired.

mappings = { "<Space>" }, -- default key mapping; add more keys if desired

This feature allows you to generate a specified number of words of placeholder text directly in the current buffer. Simply type loremX, where X is the number of words you want, and the plugin will replace the pattern with the generated text.

This feature enables the generation of placeholder text in paragraph format. Type loremXp, where X is the number of paragraphs you want, and the plugin will replace the pattern with the specified number of paragraphs.

The command features tab-completion to help streamline text generation. Start typing :LoremIpsum and press <TAB> to reveal available options for mode (words or paragraphs). After selecting a mode, pressing <TAB> again suggests the appropriate next argument (<amount>).

# defaults: 100 words, 1 paragraph
:LoremIpsum <mode> <amount>

                          ┌────────────┐
                          │            │
                          │    Menu    │
                          │depending on│
            ┌────────────┐│  previous  │
            │   words    ││ selection  │
            │ paragraphs ││            │
            └────────────┘└────────────┘
────────────────────────────────────────────────
:LoremIpsum     <TAB>         <TAB>
             └── mode ──┘ └── amount ───┘
# i.e.
:LoremIpsum words 1000
:LoremIpsum paragraphs 2

The Custom Ipsum feature offers users granular control over the generated text without needing to modify their configuration. By using the :LoremIpsum command with specific arguments, users can dynamically specify the format, amount, and structure of the generated text.

Custom usage for paragraphs:

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
     :LoremIpsum  paragraphs  1  10  5
                       ┃      ┃   ┃  ┃
           mode━━━━━━━━┛      ┃   ┃  ┃
                              ┃   ┃  ┃
         amount━━━━━━━━━━━━━━━┛   ┃  ┃
                                  ┃  ┃
 w_per_sentence━━━━━━━━━━━━━━━━━━━┛  ┃
                                     ┃
s_per_paragraph━━━━━━━━━━━━━━━━━━━━━━┛

# print lorem ipsum words to the terminal
# (default: 100)
nvim --headless -c 'lua print(require("lorem").words())' +qall | tail -n +1

# print 500 words to the terminal
nvim --headless -c 'lua print(require("lorem").words(500))' +qall | tail -n +1

# using the shell script
chmod +x lorem.sh
./lorem.sh -w 10