purescript / roadmap

Long-term projects not covered by other issues lists
20 stars 1 forks source link

Style guide (code / syntax) #49

Closed paulyoung closed 7 years ago

paulyoung commented 8 years ago

Not to be confused with the guidelines for writing libraries, but something more in the style of Elm's style guide or NoRedInk's Elm Style Guide.

texastoland commented 8 years ago

@paulyoung This is on my personal todo! I have concrete ideas if you'd like to coordinate? I was thinking of publishing it with GitBook for a whirlwind syntax tour.

paulyoung commented 8 years ago

Sounds great!

I may be providing more questions than answers 😄

texastoland commented 8 years ago

Sweet I'll gather my thoughts into a repo today!!

texastoland commented 8 years ago

@paulyoung I'm starting here if you wanna follow along. I'll publish conventions first based on several Haskell and Elm guides. NB for pedagogical sake it won't follow the style of our Prelude or compiler.

paulyoung commented 8 years ago

@AppShipIt sounds good. Feel free to ping me if you make updates.

tfausak commented 8 years ago

I think this should go hand-in-hand with #23.

texastoland commented 8 years ago

I think #23 should be more flexible. At work I've pointed out the current conventions I deem awful e.g. vertical indentation. We're using recommendations based on Elm which I'll add to purescript-4humans.

garyb commented 8 years ago

What's "vertical indentation"?

natefaubion commented 8 years ago

purescript-4humans

Next: purescript-4dolphins :wink:

tfausak commented 8 years ago
data Maybe a = Nothing
             | Just a
          -- ^ Lining this up is "vertical indentation".

Edit: ... I think.

garyb commented 8 years ago

The Elm style guide is against that too I thought? Unless I'm misunderstanding @AppShipIt.

:+1: for not doing that.

texastoland commented 8 years ago

Right. Definitely planning on getting feedback!

dkoontz commented 8 years ago

👍 for this. I've also been using the Elm style guide for PS at work and it's been very nice.

ianbollinger commented 8 years ago

I started work on one here, if anyone is interested.

paf31 commented 7 years ago

Moving to the docs repo.