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

Preparing the elm-package #3

Closed
bartavelle opened this issue Dec 11, 2015 · 25 comments
Closed

Preparing the elm-package #3

bartavelle opened this issue Dec 11, 2015 · 25 comments

Comments

@bartavelle
Copy link
Collaborator

I published a formatted version of the elm package for testing, but I do not know why my code samples are truncated :(

I will keep on testing with a pair of real life projects until all of this is stable enough.

@agrafix
Copy link
Owner

agrafix commented Dec 11, 2015

What exactly do you mean by truncated? Can you show an example?

@bartavelle
Copy link
Collaborator Author

In http://package.elm-lang.org/packages/bartavelle/json-helpers/1.0.0/Json-Helpers, look at the beginning of the chapter "Encoding schemes". The sum type has 3 members in the source code ...

@bartavelle
Copy link
Collaborator Author

I mean 3 constructors.

@agrafix
Copy link
Owner

agrafix commented Dec 12, 2015

Looks like a bug in elms documentation generator... :-/

@bartavelle
Copy link
Collaborator Author

I have pushed a usable version of the elm package. I also have just pushed some changes in the elm-bridge package. I believe it is now releasable on hackage!

There are still pain points (for example I don't like how I created an ElmOptions type to account for newtype declarations, it probably should be decided during the json generation!).

What do you think ?

@agrafix
Copy link
Owner

agrafix commented Jan 12, 2016

A very important change would be to document somewhere which elm library in which version is needed to be compatible. Could you also update the example? Apart from that I think we can cut another release. Please add your self as author the license and cabal file :-)

@bartavelle
Copy link
Collaborator Author

Done!

@bartavelle
Copy link
Collaborator Author

If it's ok with you I'll add it to stackage as soon as the release is made.

@bartavelle
Copy link
Collaborator Author

Or perhaps I will not as the aeson bug isn't fixed yet :(

@agrafix
Copy link
Owner

agrafix commented Jan 13, 2016

Is our needed aeson version to high?

@bartavelle
Copy link
Collaborator Author

The currently required version is 0.9., but nightly now uses 0.10.. I am waiting for the new release because it contains a blocking bug ...

@agrafix
Copy link
Owner

agrafix commented Jan 13, 2016

Could you reference the aeson issue here?

@bartavelle
Copy link
Collaborator Author

haskell/aeson#293

@bartavelle
Copy link
Collaborator Author

I suppose the stack issue itself is : haskell/aeson#328

@agrafix
Copy link
Owner

agrafix commented Jan 13, 2016

I'll still release this to hackage and then we can make a minor release as soon as the stack issue is resolved.

@bartavelle
Copy link
Collaborator Author

Sounds good to me!

@bartavelle
Copy link
Collaborator Author

It will probably not be a minor release though, as the Options field has changed in 0.10.*!

A solution to this would be to alter the code right now, drop the ElmOptions type, and find a nice API to decide when to newtype stuff.

@agrafix
Copy link
Owner

agrafix commented Jan 13, 2016

Sadly I'm currently not using this library anymore (We switched to https://github.com/typed-wire/typed-wire ), so it's up to you what will suit you best for your usecase. It would be cool if you could provide release notes for this release? :-)

@bartavelle
Copy link
Collaborator Author

Let's wait on it a bit, I will do the refactoring in a few days and figure out a solution. I didn't realize this typed-wire project existed!

What did you have in mind for the release notes ? A changelog-like new file in the repo ?

@agrafix
Copy link
Owner

agrafix commented Jan 19, 2016

Yes, a changelog file would be great, just something so I can write up notes like this: https://github.com/agrafix/Spock/releases

@bartavelle
Copy link
Collaborator Author

I just pushed a very succint changelog. Is that what you had in mind? The way newtypes are handled is now independant of instance generation, so aeson Option type is all that is needed. This means it will be possible to upgrade to later versions with a minor version bump.

@agrafix
Copy link
Owner

agrafix commented Jan 20, 2016

Cool thank's! So we are ready for release? :-)

@bartavelle
Copy link
Collaborator Author

I sure am!

@agrafix
Copy link
Owner

agrafix commented Jan 22, 2016

Release is up on hackage :-) Do you want to make the announcement?

@bartavelle
Copy link
Collaborator Author

great!

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

No branches or pull requests

2 participants