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

Add details on deps.cljs #224

Open
jmlsf opened this issue Apr 18, 2018 · 8 comments
Open

Add details on deps.cljs #224

jmlsf opened this issue Apr 18, 2018 · 8 comments
Labels

Comments

@jmlsf
Copy link
Contributor

@jmlsf jmlsf commented Apr 18, 2018

The deps.cljs file is discussed by example in a couple of places:

I'd really like to see a slightly more formal description of how this file works. Questions:

  • Is the deps.cljs filename hardcoded?
  • Does it only work inside jars? (Only at the top level directory?)
  • Can there be more than one in a project? How do they interact if so?
  • Can it contain anything other than a :foreign-libs key?

(I think part of my confusion lies from the fact that I'm a bit fuzzy on the mechanics of what happens when you add a dependency string to a lein project file. I always thought that the dependency strings only affected the downloading of dependencies to disk--not compiler options. I think the answer is that the dependency vector downloads the jars to disk and the presence of a deps.cljs file on disk affects the compiler, but it'd be great to have this spelled out.)

CC: @johnmn3

@johnmn3
Copy link
Contributor

@johnmn3 johnmn3 commented Apr 19, 2018

More info:

Other optional keys include :externs and :npm-deps.

:npm-deps also allows for 'upstream' deps.cljs files.

See more info here: clojure/clojurescript@21da03e

@swannodette
Copy link
Member

@swannodette swannodette commented Apr 12, 2020

I think we probably need a new guide about developing ClojureScript libraries. However I would like any such guide to give recommendations aligned with :target :bundle.

@cap10morgan
Copy link
Contributor

@cap10morgan cap10morgan commented Jul 10, 2020

@swannodette How do you envision :target :bundle libraries working when consumed by another :target :bundle project? It seems like there needs to be a way to tell the downstream consumer project how to compile the library; and those compilation instructions should land in the library's JAR? Or just look for build.edn and use that? Or should the :target :bundle tooling auto-generate a deps.cljs for downstream consumers to use? Something else entirely?

@swannodette
Copy link
Member

@swannodette swannodette commented Jul 10, 2020

There's nothing more to do it, as what you're talking about is already supported. You can transitively depend on some CLJS lib that depends on node modules and it will work.

@cap10morgan
Copy link
Contributor

@cap10morgan cap10morgan commented Jul 10, 2020

@swannodette Oh interesting! I must be doing something wrong then because the transitive npm deps in my library aren’t found when a consuming project tries to build its CLJS. Both are :target :bundle based.

@swannodette
Copy link
Member

@swannodette swannodette commented Jul 10, 2020

You need declare those :npm-deps, put them in deps.cljs and this file needs to be at the root of the classpath of the project that you're going to depend on. Pretty sure there's a blogpost in the wild now about these details that you can maybe Google for. We definitely need to update the official docs.

@cap10morgan
Copy link
Contributor

@cap10morgan cap10morgan commented Jul 10, 2020

@swannodette Ah, OK. I think I’ve read the blog post in question. I was hoping for a solution where I didn’t need to redundantly specify my npm deps (which are already in package.json for :target :bundle).

I’m also hoping to avoid having two different approaches to specifying npm deps in libraries vs. apps. I’d like to just use :target :bundle everywhere. And it feels really close to just working if the library consumers could be told how to build the library too.

I just had a conversation about this in the clojurescript channel in Clojurians Slack if you’d like to take this out of this issue. Thanks for your help!

@henryw374
Copy link
Contributor

@henryw374 henryw374 commented Jul 17, 2020

This is my blog post on the topic: http://widdindustries.com/cljs-npm-libraries/

I can submit the text as a PR if you might use it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants