Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/fwdekker/intellij-randomness

IntelliJ plugin for inserting random numbers, UUIDs, names, IP addresses, and much more
https://github.com/fwdekker/intellij-randomness

idea intellij intellij-platform intellij-plugin jetbrains random random-generation random-number-generator

Last synced: over 1 year ago
JSON representation

IntelliJ plugin for inserting random numbers, UUIDs, names, IP addresses, and much more

Awesome Lists containing this project

README 

          


    

    


    Randomness






    Downloads

    Rating

    Release

    


    CI status

    Coverage

    Documentation




Rather than going to [random.org](https://www.random.org/) or making up your own random data, you can now insert random numbers, UUIDs, names, IP addresses, and much more using an IntelliJ action!



This plugin is also available on the [plugin repository](https://plugins.jetbrains.com/plugin/9836-randomness)!



## 📖 How to use

To insert random data, press Alt + R (or ⌥R) to open the list of available templates and choose one that suits your task.

By default, a different value is inserted at each caret.



You can modify this behavior by holding a key while selecting the type of data to insert:

* **Array**: Hold Shift to insert a customisable array of values.

* **Repeat**: Hold Alt (or ⌥) to insert the same value at each caret.

* **Settings**: Hold Ctrl to open the settings of that data type.



You can hold multiple modifier keys to combine their effects.



Randomness can also be found in the main menu under Tools or in Code > Generate.



Animation of how to insert data



## ✨ Features

* 🕸 **Data Types**


  There are six basic data types that can be inserted and customised:

    1. **Integers**, such as `7,826,922`, from a custom range, in any base from binary to hexatrigesimal.

    2. **Decimals**, such as `8,816,573.10`, using customisable separators.

    3. **Strings**, such as `"PaQDQqSBEH"`, with support for reverse regex.

    4. **Words**, such as `"Bridge"`, with predefined or custom word lists.

    5. **UUIDs**, such as `0caa7b28-fe58-4ba6-a25a-9e5beaaf8f4b`, with or without dashes.

    6. **Date-times**, such as `2022-02-03 19:03`, or any other format you want.

* 🧬 **Templates**


  For complex kinds of data, you can use templates.

  A template is a list of data types that should be concatenated to create random data.

  Insert **phone numbers**, **email addresses**, **URLs**, **IP addresses**, or any **custom data type** you can think of.

  Of course, Randomness comes bundled with a whole array of predefined templates to help you out.

  If needed, you can reuse a template by including it in another template using a **reference**.



  Animation of how to configure templates

* 🗃️ **Arrays**


  Need a lot of data?

  Insert an **entire array** of any template you want.

  For example, an array of integers might look like `[978, 881, 118, 286, 288]`.

  You can customise the brackets, delimiter, and number of elements to your liking every time you insert an array, because no two arrays are the same.



  Animation of how to insert arrays

* ⌨️ **Shortcuts**


  Instead of using up all your shortcuts, Randomness only uses the Alt + R (or ⌥R) shortcut by default.

  However, to **streamline your workflow**, you can assign shortcuts to any template under your IDE's Keymap settings.



  Shortcut settings for Randomness

* 💨 **Fast insertion**


  The insertion popup (shown when you press Alt + R (or ⌥R) by default) is **searchable**:

  Just type something in the popup and relevant templates will be filtered out.

  Or use the **hotkeys** that are assigned to the first 10 templates in the list:

  Press any digit to directly insert the corresponding template.

  **Reorder templates** in the settings menu to change which template uses which hotkey.



  Insertion popup

* 👀 **Previews**


  To **help you decide** what settings to choose, a preview of the template is shown while you're editing.



  Preview window in Randomness



## 💻 Development

This section contains instructions in case you want to build the plugin from source or want to help with development.

Please also check the [contribution guidelines](.github/CONTRIBUTING.md).



### 🔨 Build/run

```bash

$ gradlew runIde                       # Open a sandbox IntelliJ instance running the plugin

$ gradlew buildPlugin                  # Build an installable zip of the plugin

$ gradlew buildPlugin -Pbuild.hotswap  # Same as above, but allow hot-swapping the plugin during development

$ gradlew signPlugin                   # Sign built plugin

```



Signing the plugin requires specific environment variables to be set to refer to appropriate key files.

See [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html) for more information.



### 🧪 Quality assurance

```bash

$ gradlew test                    # Run tests (and collect coverage)

$ gradlew test --tests X          # Run tests in class X (package name optional)

$ gradlew test -Pkotest.tags="X"  # Run tests matching tag(s) X (also supports not (!), and (&), or (|))

$ gradlew koverHtmlReport         # Create HTML coverage report for previous test run

$ gradlew detekt                  # Run static analysis

$ gradlew check                   # Run all tests and static analysis

$ gradlew verifyPlugin            # Check for compatibility issues

```



#### 🏷️ Tagging and filtering tests

[Kotest tests can be tagged](https://kotest.io/docs/framework/tags.html) to allow selectively running tests.

Simply run Gradle with argument `-Pkotest.tags="X"` to run only tests tagged with tag `X`.

The tags for Randomness are statically defined in [`Tags`](https://github.com/FWDekker/intellij-randomness/blob/main/src/test/kotlin/com/fwdekker/randomness/testhelpers/Tags.kt).

If you want to debug a test, you can tag it with the `Focus` tag to ensure only those tests run.

Alternatively, prefix the description with the string `f:`.

Make sure you remove the tag afterwards!



You can tag an entire test class by adding `tags(...)` to the class definition, or tag an individual test `context` by writing `context("foo").config(tags = setOf(...)) {`.

Due to limitations in Kotest, you can only tag the outer level of `context`s; you cannot tag a nested `context` or an individual `test`.

This is also true for prefixing with `f:`.



### 📚 Documentation

```bash

$ gradlew dokkaHtml                        # Generate documentation

$ gradlew dokkaHtml -Pdokka.pagesDir=/foo  # Generate linked documentation

```



Whenever a release is created on GitHub, [GitHub Actions generates new documentation](https://github.com/FWDekker/intellij-randomness/actions/workflows/cd.yml), after which this is deployed to [GitHub Pages](https://fwdekker.github.io/intellij-randomness/).



Documentation pages link to each other using a version dropdown menu.

Simply running `gradlew dokkaHtml` does not generate a dropdown menu, because Dokka is not automatically aware of all previous versions.

To link the versions together, check out the `gh-branch` of this repository in a separate directory, and point `dokka.pagesDir` to that directory.



### 🖼 Icons

The icons used by the plugin are found in [the file `icons.sketch`](.github/img/icons.sketch).

You can open this file with [Sketch](https://www.sketch.com/) (macOS), [Lunacy](https://icons8.com/lunacy) (Windows), or [Figma](https://github.com/Figma-Linux/figma-linux) (Linux).



## 🙏 Acknowledgements

I want to thank everyone who contributed something to Randomness, no matter the size of that contribution.



In chronological order of contribution:

* Thanks to [Casper Boone](https://github.com/casperboone) for [reporting a bug](https://github.com/FWDekker/intellij-randomness/issues/25) and for [suggesting emoji support](https://github.com/FWDekker/intellij-randomness/issues/192)!

* Thanks to [Victor Tyazhelnikov](https://github.com/zenwarr) for [suggesting the array data type](https://github.com/FWDekker/intellij-randomness/issues/54)!

* Thanks to [Georgios Andreadis](https://github.com/gandreadis) for the [original logo](https://github.com/FWDekker/intellij-randomness/pull/86)!

* Thanks to [Oleksii](https://github.com/ok3141) for [suggesting the UUID data type](https://github.com/FWDekker/intellij-randomness/issues/88) and for [suggesting the hex symbol set](https://github.com/FWDekker/intellij-randomness/issues/89)!

* Thanks to [Meilina Reksoprodjo](https://github.com/meilinar) for help with macOS user testing!

* Thanks to [Wouter van Vliet](https://github.com/woutervanvliet) for [helping me clarify the "repeat" action](https://github.com/FWDekker/intellij-randomness/issues/307)!

* Thanks to [Paweł Lipski](https://github.com/PawelLipski) for [reporting two](https://github.com/FWDekker/intellij-randomness/issues/328) [bugs in the verification script](https://github.com/FWDekker/intellij-randomness/issues/332)!

* Thanks to [opticyclic](https://github.com/opticyclic) for [suggesting two](https://github.com/FWDekker/intellij-randomness/issues/338) [improvements to the verification script](https://github.com/FWDekker/intellij-randomness/issues/339)!

* Thanks to [Niraj Jadhav](https://github.com/niraj-toad) for [reporting a bug and demonstrating that the error reporter works](https://github.com/FWDekker/intellij-randomness/issues/343)!

* Thanks to [jrborases](https://github.com/jrborases) for [suggesting a configurable popup](https://github.com/FWDekker/intellij-randomness/issues/305#issuecomment-661530711)!

* Thanks to [Alex Pernot](https://github.com/AlexPernot) for [participating in the data type discussion](https://github.com/FWDekker/intellij-randomness/issues/305#issuecomment-662499058)!

* Thanks to [solo](https://github.com/solonovamax) for [his contributions](https://github.com/FWDekker/intellij-randomness/issues/305#issuecomment-804415489) [to the data type discussion](https://github.com/FWDekker/intellij-randomness/issues/363#issuecomment-804976008) [in several places](https://github.com/FWDekker/intellij-randomness/issues/365#issuecomment-805052007), [suggesting the removal of the integer range limit](https://github.com/FWDekker/intellij-randomness/issues/367), and [suggesting the byte preset](https://github.com/FWDekker/intellij-randomness/issues/368)!

* Thanks to [Martin Kaspar van Laak](https://github.com/MartinKvL) for [reporting that symbol sets didn't get saved](https://github.com/FWDekker/intellij-randomness/issues/382)!

* Thanks to [Aleksey Bobyr](https://github.com/Alexsey) for [reporting a critical UI bug in WebStorm EAP](https://github.com/FWDekker/intellij-randomness/issues/418)!

* Thanks to [Lukas](https://github.com/LukasAppleFan) for [helping me find a bug in IntelliJ](https://github.com/FWDekker/intellij-randomness/issues/421)!

* Thanks to [Pascal](https://github.com/theMunichDev) for [reporting a bug with custom shortcuts](https://github.com/FWDekker/intellij-randomness/issues/423)!

* Thanks to [Rishi Maharaj](https://github.com/rshmhrj) for [suggesting to add prefix and postfix options to strings](https://github.com/FWDekker/intellij-randomness/issues/431)!

* Thanks to [Christian Baune](https://github.com/programaths) for [reporting recurring issues](https://github.com/FWDekker/intellij-randomness/issues/441) [with load](https://github.com/FWDekker/intellij-randomness/issues/442) [corrupted settings](https://github.com/FWDekker/intellij-randomness/issues/444)!

* Thanks to [Vladislav Rassokhin](https://github.com/VladRassokhin) for [reporting an issue with slow actions during indexing](https://github.com/FWDekker/intellij-randomness/issues/445)!

* Thanks to [Luc Everse](https://github.com/cmpsb) for [suggesting generating non-matching strings](https://github.com/FWDekker/intellij-randomness/issues/447)!

* Thanks to [ForNeVeR](https://github.com/ForNeVeR) for [reporting a compatibility issue with the IntelliJ EAP](https://github.com/FWDekker/intellij-randomness/issues/459)!

* Thanks to [Vitaly Provodin](https://github.com/vprovodin) for [also reporting that compatibility issue](https://github.com/FWDekker/intellij-randomness/issues/460)!

* Thanks to [Juraj Jurčo](https://github.com/JiangHongTiao) for [suggesting adding support for newer UUID versions](https://github.com/FWDekker/intellij-randomness/issues/513)!

* Thanks to [iKa1ns](https://github.com/iKa1ns) for [reporting a bug with resetting settings](https://github.com/FWDekker/intellij-randomness/issues/549)!

* Thanks to [everyone who clicked "see details and submit report" and sent an anonymous bug report](https://github.com/FWDekkerBot/intellij-randomness-issues/issues)!



If I should add, remove, or change anything here, just open an issue or email me!