clojure / clojure/clojurescript-site

Add details on deps.cljs

Open
#224 8 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

major
Dominant language
Shell
Stars
107
Forks
130
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.