Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template descriptions #1985

Conversation

eriknstevenson
Copy link
Member

Hi! This is my first stab at #1571. There didn't seem to be much of a consensus on how best to implement this feature so I went off of @mgsloan's suggestion

An alternative implementation not blocked on #1595 would be to have a single file in the templates repo that associated template names with descriptions / other metadata.

Running stack templates now downloads and can display optional metadata from a .yaml file located in the stack-templates repository.

The file is setup like this:

quickcheck-test-framework:
  description: a library for random testing of program properties
servant:
  description: a set of packages for declaring web APIs at the type-level
ghcjs:
  description: Haskell to JavaScript compiler, based on GHC

Currently the data type I implemented supports description and author (not used for anything at the moment) fields, however this could be extended relatively easily.

I'm a newbie so criticism is definitely welcome and appreciated.

Thanks

@eriknstevenson
Copy link
Member Author

I'm going to clean this up and get it compiling with ghc-7.8.4.

@eriknstevenson eriknstevenson deleted the template-descriptions branch April 3, 2016 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant