Add details on deps.cljs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by comparing the existing dependency and packaging documentation at the three linked URLs, then verify how deps.cljs relates to a Leiningen dependency declaration. Document the filename, supported locations and keys, handling of multiple files, and the download-versus-compiler behavior, with examples that answer each question.
Written by the indexing model from the issue text.
Description
The deps.cljs file is discussed by example in a couple of places:
- https://clojurescript.org/reference/dependencies
- https://clojurescript.org/reference/packaging-foreign-deps
- https://cljs.github.io/news/0.0-2719
I'd really like to see a slightly more formal description of how this file works. Questions:
- Is the
deps.cljsfilename 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-libskey?
(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
- Dominant language
- Shell
- Stars
- 107
- Forks
- 130
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from clojure/clojurescript-site
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
clojure/clojurescript-site#413 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
clojure/clojurescript-site#392 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 20/100
clojure/clojurescript-site#390 · 1 comment ·
-
contributing page: jbake download link times outMay be free again @puredanger claimed this 1909 days ago, and no pull request is open. Open
clojure/clojurescript-site#388 · 4 comments · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
clojure/clojurescript-site#387 · 3 comments ·
All issues in clojure/clojurescript-site
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nolabs-ai/nono-packs#44 ·
Maintainers usually reply within 1 day
-
easy low
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
open-nudge/opentemplate#185 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
omacom/omarchy#14030 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
vercel-labs/skills#2360 ·
Maintainers usually reply within 2 days