nventive/helpdeskid

Generates identifiers that humans can exchange easily.

HelpDeskId

Generates identifiers that humans can exchange easily.

The objective for this library is to be able to generate identifiers that can be communicated to humans in case of error. Some systems generate an Operation/Error Id (a GUID-like string), but it is usually rather cumbersome to communicate either orally or via a screenshot. This allows you to generate identifiers in the form of triplets of common words (e.g. "moon-shadow-list").

Be aware though that these identifiers are not guaranteed to be unique. There are not a replacement for GUIDs.

Getting Started

Install the package:

Install-Package HelpDeskId

var generator = new HelpDeskIdGenerator();

// Generate an id using the CultureInfo.CurrentCulture if available with a fallback to english words.
var helpDeskId = generator.GenerateReadableId(); // "desk-plastic-record"

// Specify the source dictionary to use, in this case french words.
helpDeskId = generator.GenerateReadableId(CultureInfo.GetCultureInfo("fr")); // "essayer-debut-avancer"

Features

• The number of words and the separator can be customized in the constructor:

var generator = new HelpDeskIdGenerator(numberOfWords: 2, separator: "/");
var helpDeskId = generator.GenerateReadableId(); // "another/one"

• Currently, only english (default) and french ("fr") source words are supported (PR welcomed!). They represent common words in these languages, where swear words have been curated. The list can be customized by providing a IWordsProvider implementation.

Changelog

Please consult the CHANGELOG for more information about version history.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on the process for contributing to this project.

Be mindful of our Code of Conduct.

helpdeskid's Issues

Remove offensive words from generated IDs

Expected Behavior

Generated IDs do not contain words or combinations that may be deemed offensive. Our PO has identified the following 3 words for starters: stupid, worst, love. He is currently working on a complete list (including french too).

Actual Behavior

The list of words used for generating IDs contain several words that can be offensive to the user (e.g. stupid) or words who combined together could be considered as negative or inappropriate (e.g. worst-love).

Steps to Reproduce the Problem

Specifications

• Version: 1.0.0
• Platform: all
• Subsystem: