English Dictionary CLI

TL;DR {#tl-dr}

This CLI tool give you the english definition of a word base, also use a Trie to give you predictions as you type your word.

Table of Contents

Table of Contents

1. TL;DR
2. Project Structure
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

CLI App {#cli-app}

Normal Funtionality:

Pipe Functionality:

Project Structure {#project-structure}

This project return the definition of a word in english and use a Trie to give you predictions as you type your word.

The project is divided in two parts:

• cli: The CLI tool
• cli.test: The test project

The CLI tool is divide in two files Program.cs and Trie.cs. The Program.cs is the main file that run the CLI tool and the Trie.cs is the data structure that hold the dictionary.

The projecr is structure as follow:

.
├── CliApp.sln
├── LICENSE
├── README.md
├── data
│   └── dictionary_compact.json -- Dictionary
├── cli
│   ├── CliApp.csproj
│   ├── Program.cs -- Program
│   └── Trie.cs -- Data Structure
└── cli.test
    ├── GlobalUsings.cs
    ├── UnitTest1.cs
    └── cli.test.csproj -- Test Project

Prerequisites {#prerequisites}

• .NET 8.0

Settings {#settings}

dotnet run --project cli

Testing {#testing}

dotnet test

Acknowledgements {#acknowledgements}

• Trie wiki
• Dictionary

Acknowledgments

• https://github.com/matthewreagan/WebstersEnglishDictionary?tab=readme-ov-file