Pokedex REPL

Usage

$ ./pokedex-go
Welcome to Pokedex-CLI!

pokedex > help
...
pokedex > exit

Development

Before a PR, please run the following:

# defaults to running formatters, tests and building application
make

Formatting

Just do whatever gofmt tells you to.

# run formatters and tidy modfile
make tidy

NOTE: gofmt will sometimes provide suggestions for code simplification using the -s flag. Recommend running the following to run additional linters:

make check

Testing

100% test coverage is not required nor is it a goal. Test the important pieces of logic, but don't worry about branch coverage.

# run all tests
make test

To just run tests for a particular subpackage, run one of the following (make test is a light wrapper around go test):

# run tests for subpackage <pkg>
make test packages=./<pkg>
# OR just...
go test ./<pkg>

Unit testing is great, but also make sure the actual behavior is what you expect by running some basic manual validation:

# starts the pokedex-cli
make run

Planned

• Default region and generation (used for lookups, routes, etc.)
• Lookup command
  • Display basic info (base stats, types, etc)
  • Display weaknesses (NOTE: will require calculation from ability and types)
  • Fetch moveset (ideally, filtered by the generation)
• Lookup with level (filters moveset by level)
• Installation script

Resources

• Rough project plan courtesy of boot.dev/