code-jam-f-sharp's Introduction

My solutions to Code Jam problems

This repo contains my solutions to a few Google Code Jam problems. I first wrote these solutions in 2016, and then ported them to F# and wrapped them in a CLI. They aren't optimal solutions--in fact, one of them is quite slow--but they are my solutions.

Usage

To run a Code Jam solution, type

CodeJam --problem <problem-name>
rem Waits for input.
rem Outputs "Case #1:..."

Like any other Code Jam solution, the input will be taken from stdin, and output will go to stdout.

To get a usage message, run any of the following

CodeJam
CodeJam -h
CodeJam help
CodeJam --help

goto EndExampleOutput
This program can take a single argument --problem which can take the following values
rank-and-file : run a solution to the 2016 Round 1a 'Rank and File' problem
the-last-word : run a solution to the 2016 Round 1a 'The Last Word' problem
coin-jam : run a solution to the 2016 Qualification Round 'Coin Jam' problem

If no arguments are given, or the --help/help/-h argument is given, then this help message is printed.
If the --version/version/-V/-v argument is given, the version of this program is printed.

Input, just like in the real CodeJam, is fed through standard input.
:EndExampleOutput

A usage message is displayed when the arguments are invalid, too.

To find out what version of CodeJam you're using, run any of the following

CodeJam -v
CodeJam -V
CodeJam version
CodeJam --version

rem Outputs "Version #.#.#"

Available solutions

Name	Link to problem statement
`rank-and-file`	https://code.google.com/codejam/contest/4304486/dashboard#s=p1
`coin-jam`	https://code.google.com/codejam/contest/6254486/dashboard#s=p2
`the-last-word`	https://code.google.com/codejam/contest/4304486/dashboard

Possible errors

Error code	Description
`EARGS`	The program received an invalid combination of arguments.

Reporting issues

Report issues on GitHub.

Code of Conduct

Contributing guidelines

Development

Acknowledgements

If you want to learn more about F#, I suggest reading F# for fun and profit.

code-jam-f-sharp's People

Contributors

Watchers

code-jam-f-sharp's Issues

Show version when running CodeJam version/--version/-V/-v

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (3.)

Add README

Add development/build instructions to contribution guidelines

Redesign Input module and solution interface

Separate the concerns more and make them more testable.

Write up contribution guidelines and a code of conduct

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (10.)

Show help when using CodeJam [--help/help/-h]

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (1.)

Add tests for 'Rank and File' solution

Add GIF/terminal recording to README

Add style guide

Include a style guide for F# code. Perhaps, include a style guide for prose too.

An example F# style guide: https://docs.microsoft.com/en-us/dotnet/fsharp/style-guide/

An example prose style guide: https://plainlanguage.gov/guidelines/

Currently, there is no style guide being followed (except for Visual F#'s suggestions). There should be an F# style guide to follow and prose guidelines to follow. This will help make the code easier to read, better designed, and more maintainable. A prose guide will help improve documentation making it clear and easier to read.

These enhancements would be useful in maintaining the consistency of code and prose.

Add system tests

Test end-user-facing behavior, like:

Displaying a usage message in stdout when there are no arguments/invalid arguments
Sending error messages to stderr when there no arguments/invalid arguments
Running a solution denoted with the arguments --problem <name>
Exit with zero upon success
Exit with 1 when there are no or invalid arguments

Automate builds, release process, linting, testing

Add a code linter to enforce the F# code style
Tools to enforce/monitor the prose style guidelines
Automate the build process with some CI system that supports MSTest
Try automating the release process

Example: DocToc uses Travis CI

Currently, no tools like this are being used. I want to use these tools to make the development process less error-prone and to spend more time writing actual code.

The enhancement would be useful because it would codify various development processes and guidelines that I want to use.