shpun817 / help-me-decide

A simple tool to help deciding things

Why?

Sometimes I can't decide how to spend a holiday or a night.

How to Use

1. Create a plain text file with your options, one per line.
2. Run ./help-me-decide <PATH_TO_FILE> [NUM_RESULTS] at root. If NUM_RESULTS is not specified, 3 is the default value.
3. Cosmic magic shall give what thou seek.

Example

$ printf "McDonald's\nKFC\nBurger King\nWendy's\nShake Shack\n" >| what-to-eat.txt
$ ./help-me-decide what-to-eat.txt 3
🥇 Shake Shack
🥈 Wendy's
🥉 Burger King

help-me-decide's Issues

Specify a file extension for the input file type

Currently, the input file can be in any format. Ideally, it should be restricted to be a certain file type for semantics.

Cross compile the executable to Windows

Currently, the executable is compiled on WSL and doesn't run on Windows. Ideally, there should be different executables released for different platforms. Also, the executable should be tested on MacOS.

Separate main.rs into several modules

Currently, all the code has been written in one big main.rs file. Ideally, the different steps should be done in different modules to achieve better isolation and maintainability.

Ignore empty lines in input file

Currently, empty lines in the input file are regarded as options. Ideally, empty lines in the file should be ignore, so that the user may put their options in groups.

A command line argument can be added to explicitly disable this behavior, although it is unlikely anyone would want that.

Change the name of the project

Come up with a better name.

Support comments in the input file

It would be nice if the tool can ignore certain lines in the input file, so that the user can add comments to describe the options.

Both single-lined (# ...) and multi-lined comments (/* ... */) should be supported.

Add tests

Depends on Issue #2

Currently, there are no tests due to the simple nature of the program. However, (unit and system) tests are required to assure quality in the long term.

Use environment variables to provide default parameters

Currently, the program can only receive parameters via the command line arguments. Ideally, all parameters should be optionally provided in a .env file, serving as defaults when they are absent in the arguments.