undefined | Better HN

0 pointsroenxi3y ago0 comments

"Superb" is not the word for deps.edn documentation. It is certainly documented but the gap between most Clojure documentation and the deps.edn documentation page is big. I suspect Rich wrote most of it but left the deps.edn page to someone else.The deps pages have a knack for includng pages of waffle that doesn't help to solve the current problem.

If a newbie is trying to debug

    {:deps
     {ring/ring-devel {:mvn/version "1.9.6"}}
     {ring/ring-core {:mvn/version "1.9.6"}}}

=> Error building classpath. Error reading edn. Map literal must contain an even number of forms

They have to notice that while they got 80% of their maps right, the file itself if a map with 3 forms. This is compounded by the fact that there are no examples of a multi-dependency project in the getting started page! If you know Clojure, this is an easy puzzle. For rookies, they didn't use (map) so the error message will probably trick some percent of them.

I don't think the deps documentation has been validated to provide what people actually want to know. Technically it is probably thorough, but "Superb" is a high bar it does not reach.

Probably the proper approach is learning deps by copying other people. Trying to learn it from the docs didn't work for me (it did for the rest of Clojure, so that was an unpleasant change).

0 comments

puredanger3y ago

These are useful comments and issues are welcome at https://github.com/clojure/clojure-site/issues

roenxiOP3y ago

smoothly changes gears ... although of course there can be no question that the deps documentation is managed by a man of patience, talent and extreme skill to whom we are all thankful.

Sorry, I had a bad time learning deps and the frustration still haunts me.

__jem3y ago

> a multi-dependency project in the getting started page

That's because they basically don't support monorepo multi-module projects. It's incredibly tedious and makes me long for something like Maven or Gradle (tools that otherwise are often too complicated).

lvh3y ago

How do you mean? You can specify local (fs) dependencies fine, which is presumably what you want in that scenario?

(I regularly contribute to a monorepo like this, though admittedly the top-level components are relatively disjoint.)

__jem3y ago

I mean, you can hack something together with local dependencies, yes, but there's no out of the box way to build and test everything together, or to do things like pin dependency versions across projects, have projects inherit shared configuration, etc. We end up creating a bunch of pseudo-projects that contain things like single dependencies, but this blurs the line between build time concerns and actual source code. As with everything in clojure, you can write it all yourself using something like tools.build, but it's not convenient and clearly not a first class use case.

1 more reply

e12e3y ago

Out of curiosity - what is the correct form in this case?

Ed: I'm guessing a key => list of deps, maybe?

roenxiOP3y ago

It should be:

    {:deps
     {ring/ring-devel {:mvn/version "1.9.6"}
      ring/ring-core {:mvn/version "1.9.6"}}}

There was one too many map.

grumpyprole3y ago

I think you might be asking for a type :)

jdminhbg3y ago

Not really. This is a syntactic error, not a type error.

To expand, this is the equivalent of something like {"a": 1, "b":}. The type checker in something like Typescript wouldn't ever come into play, because it's not legal syntax to begin with.

1 more reply

j / k navigate · click thread line to collapse

0 pointsroenxi3y ago0 comments

If a newbie is trying to debug

    {:deps
     {ring/ring-devel {:mvn/version "1.9.6"}}
     {ring/ring-core {:mvn/version "1.9.6"}}}

=> Error building classpath. Error reading edn. Map literal must contain an even number of forms

I don't think the deps documentation has been validated to provide what people actually want to know. Technically it is probably thorough, but "Superb" is a high bar it does not reach.

Probably the proper approach is learning deps by copying other people. Trying to learn it from the docs didn't work for me (it did for the rest of Clojure, so that was an unpleasant change).

0 comments

puredanger3y ago

These are useful comments and issues are welcome at https://github.com/clojure/clojure-site/issues

roenxiOP3y ago

smoothly changes gears ... although of course there can be no question that the deps documentation is managed by a man of patience, talent and extreme skill to whom we are all thankful.

Sorry, I had a bad time learning deps and the frustration still haunts me.

__jem3y ago

> a multi-dependency project in the getting started page

lvh3y ago

How do you mean? You can specify local (fs) dependencies fine, which is presumably what you want in that scenario?

(I regularly contribute to a monorepo like this, though admittedly the top-level components are relatively disjoint.)

__jem3y ago

1 more reply

e12e3y ago

Out of curiosity - what is the correct form in this case?

Ed: I'm guessing a key => list of deps, maybe?

roenxiOP3y ago

It should be:

    {:deps
     {ring/ring-devel {:mvn/version "1.9.6"}
      ring/ring-core {:mvn/version "1.9.6"}}}

There was one too many map.

grumpyprole3y ago

I think you might be asking for a type :)

jdminhbg3y ago

Not really. This is a syntactic error, not a type error.

To expand, this is the equivalent of something like {"a": 1, "b":}. The type checker in something like Typescript wouldn't ever come into play, because it's not legal syntax to begin with.

1 more reply

j / k navigate · click thread line to collapse