https://github.com/cryptic-wizard/random-word-generator
A nuget package to generate random words
https://github.com/cryptic-wizard/random-word-generator
dotnet dotnet-core gherkin nuget specflow
Last synced: 5 months ago
JSON representation
A nuget package to generate random words
- Host: GitHub
- URL: https://github.com/cryptic-wizard/random-word-generator
- Owner: cryptic-wizard
- License: mit
- Created: 2021-07-07T03:33:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-06T16:27:54.000Z (about 3 years ago)
- Last Synced: 2025-04-22T17:21:33.396Z (6 months ago)
- Topics: dotnet, dotnet-core, gherkin, nuget, specflow
- Language: C#
- Homepage: https://www.nuget.org/packages/CrypticWizard.RandomWordGenerator/
- Size: 122 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# random-word-generator
[](https://www.nuget.org/packages/CrypticWizard.RandomWordGenerator)
## Description
* A random word generator for .NET and .NET Core
* Useful for:
* Username generation
* Random word stories
## Tests
[](https://github.com/cryptic-wizard/random-word-generator/actions/workflows/dotnet.yml)
[](https://github.com/cryptic-wizard/random-word-generator/actions/workflows/dotnetcore.yml)
[](https://github.com/cryptic-wizard/random-word-generator/actions/workflows/nugetpublish.yml)
## Usage
### Install Package:
```Text
dotnet add package CrypticWizard.RandomWordGenerator
```
```xml
```
### Include Package:
```C#
using CrypticWizard.RandomWordGenerator;
using static CrypticWizard.RandomWordGenerator.WordGenerator; //for brevity, not required
```
### GetWord( )
```C#
WordGenerator myWordGenerator = new WordGenerator();
string word = myWordGenerator.GetWord(PartOfSpeech.noun);
```
```Text
jewel
```
### GetWords( )
```C#
WordGenerator myWordGenerator = new WordGenerator();
List advs = myWordGenerator.GetWords(PartOfSpeech.adv, 5);
```
```Text
abnormally
boastfully
daintily
shakily
surprisingly
```
### IsWord ()
```C#
WordGenerator myWordGenerator = new WordGenerator();
bool isWord = myWordGenerator.IsWord("exemplary");
```
```Text
true
```
### IsPartOfSpeech( )
```C#
WordGenerator myWordGenerator = new WordGenerator();
bool isPartOfSpeech = myWordGenerator.IsPartOfSpeech("ball", PartOfSpeech.noun);
```
```Text
true
```
### GetPatterns( )
```C#
WordGenerator myWordGenerator = new WordGenerator();
List pattern = new List();
pattern.Add(PartOfSpeech.adv);
pattern.Add(PartOfSpeech.adj);
pattern.Add(PartOfSpeech.noun);
List patterns = myWordGenerator.GetPatterns(pattern, ' ', 10);
```
```Text
clearly calm bandana
doubtfully majestic pizza
faithfully acidic bat
freely bustling earthquake
hastily corrupt cake
jealously poised harmony
lively golden lizard
mechanically foolish mitten
successfully spherical scooter
upbeat salty soldier
```
### SetSeed( ) - thanks [michaldivis](https://github.com/cryptic-wizard/random-word-generator/pull/27)!
```C#
WordGenerator myWordGenerator = new WordGenerator(seed:123456);
myWordGenerator.SetSeed(654321);
```
### SetRandom( )
```C#
myWordGenerator.SetRandom(new Random(654321));
string word = myWordGenerator.GetWord(PartOfSpeech.noun);
```
## Features
### Recently Added
* v0.9.4 - SetSeed()
* v0.9.4 - SetRandom()
* v0.9.3 - package prefix
* v0.9.2 - IsWord()
#### Planned Features
* Other languages are not planned but can be added as .txt files in a folder of the language abreviation
* ES
* FR
* etc.
## Tools
* [Visual Studio](https://visualstudio.microsoft.com/vs/)
* [NUnit 3](https://nunit.org/)
* [SpecFlow](https://specflow.org/tools/specflow/)
* [SpecFlow+ LivingDoc](https://specflow.org/tools/living-doc/)
* [Run SpecFlow Tests](https://github.com/marketplace/actions/run-specflow-tests)
## License
* [MIT License](https://github.com/cryptic-wizard/random-word-generator/blob/main/LICENSE.md)