tools-deps

Discuss tools.deps.alpha, tools.build, and the clj/clojure command-line scripts! See also #depstar #clj-new
cfleming 2020-09-08T02:11:42.033300Z

Is there any way with deps to manage source artifacts for non-Clojure dependencies?

cfleming 2020-09-08T02:12:25.034Z

Or rather, how could I specify that I would like them to be downloaded, and how would they be distinguishable from binary jars in the output?

cfleming 2020-09-08T02:25:00.034400Z

This seems to be the answer:

{:deps {junit/junit {:mvn/version "4.13"}
        junit/junit$sources {:mvn/version "4.13"}}}

cfleming 2020-09-08T02:30:05.034900Z

They do end up on the classpath, which is unfortunate. I guess they could go in an alias.

cfleming 2020-09-08T03:15:05.035900Z

When using :local/root, the doc says: > If the jar has been packaged with a pom.xml file, the pom will be read and used to find transitive deps Is there a way to prevent this from happening? I would just like it to use the jar I give it and not look for transitive deps.

cfleming 2020-09-08T03:22:01.037800Z

Looking at the code, it seems like not. My use case here is trying to use deps to manage the dependencies for Cursive. I need to depend on the IntelliJ framework, so I have a script which downloads and unpacks that, and I’m trying to create a deps.edn which refers to the jars within it. However a bunch of those are third party jars which include poms.

alexmiller 2020-09-08T03:22:26.038400Z

you could use :local/root to a directory which has a deps.edn that includes the jar on the :paths

cfleming 2020-09-08T03:23:06.039200Z

Oh, I can just put jar paths directly in :paths? That’s even better.

alexmiller 2020-09-08T03:23:16.039600Z

kind of a hack, but it works

cfleming 2020-09-08T03:23:24.039900Z

I guess that makes total sense, but never occurred to me.

alexmiller 2020-09-08T03:23:30.040100Z

:paths are just things that get added to the classpath

alexmiller 2020-09-08T03:23:51.041Z

on the source stuff, tools.deps is about making classpaths so that's what you're going to get

cfleming 2020-09-08T03:24:02.041400Z

Right. It’s actually much better for this use case since I don’t need to create a bunch of bogus dep symbols.

cfleming 2020-09-08T03:24:38.042400Z

Ok. Using $sources works fine, so I’ll support that in Cursive, document how to do it and suggest putting them in an alias.

practicalli-john 2020-09-08T10:24:36.057800Z

@alexmiller I'm confused about using -M with a project rather than a specific alias. In this example I use the hello-world example from https://clojure.org/guides/deps_and_cli#_writing_a_program A project deps.edn file was created containing the dependency for clojure.java-time and the source code from that page copied into src/hello.clj clojure -m hello runs the project and returns the time from running the -main function. However this gives a warning:

WARNING: When invoking clojure.main, use -M
clojure -M runs a REPL clojure -M -m hello runs the project and returns the time. But then I ask myself what is the purpose of -M Creating an alias to run the project seems an interesting idea, as I could also set default arguments. I can only get this to work with :main-opts and not :exec-fn This version of the alias works when calling clojure -M
:aliases
 {:run-project {:main-opts ["-m" "hello"]}} 
This version of the alias simply runs the REPL
:aliases
 {:run-project {:exec-fn hello]}}
Am I missing something from :exec-fn ? Edit: yes I am. The -X option is for running :exec-fn and not the -M function, oops. So clojure -X:run-project should work... except the hello-world project has an unqualified function and cannot be resolved. Moving the source code to src/practicalli/hello.clj and calling clojure -X:run-project gives an execution error, (ArityException) as the -main function does not take any arguments (defn -main [] ,,,) . Changing the -main function to (defn -main [& args] ,,,) fixes that and calling clojure -X:run-project works. From a user point of view, that seems quite a lot to extrapolate from the original warning message when running a project with clojure -m hello

practicalli-john 2020-09-08T11:57:50.065600Z

Thinking about this further, it does feel that the -X flag would be the most important flag in the long term, especially with :exec-arg allowing default arguments that can be over-written on the command line. -M seems to be more of a (very useful) convenience function for the specific case of running -main-opts configurations. This does remove the need for command line args and bash quoting, so that is valuable. -M is also useful for those aliases that dont work with -X , eg rebel-readline I could only get working with -M . As more maintainers adopt the new version of Clojure CLI, there is scope to configure all projects and tools to work with -X and eventually make -M redundant. Using the -M flag seems to help a little when making the change from Leiningen to CLI tools, as setting the main namespace is a familiar concept. I am sure I am over-simplifying this and probably missing out on a lot of understanding as of yet.

2020-09-08T12:42:42.070200Z

Would -M not continue to be useful for utilities that you expect to be invokable from the shell? How would you allow passing glob’ed files for example?

2020-09-08T12:43:33.070600Z

Hi, I have a couple questions about deps API. There is there a complement function to slurp-deps that also merges the 'user wide' deps.edn and the 'system wide' one ? Also the docs says that resolve-deps and make-classpath are supported. Then the question is: is make-classpath-map to be considered private api ? (and so subject to change?)

practicalli-john 2020-09-08T12:48:57.073500Z

Yes, it seems the -M option is valuable when the :main-opts data is more intricate. Interesting to see what can be done with :exec-args verses :main-opts . I do like :exec-args as a means of using edn over strings. I dont believe I've have any use cases for using glob'ed files, so cant comment on that without specific examples. I assume something like *.jpg would just be a command line argument after the -X:alias-name and passed to the function.

2020-09-08T13:04:53.075700Z

iuuc, -X expects arguments to be key-path edn-value pairs, so clojure -X:my-alias :x "1 2 3" ends up passing {:x 1} to the exec-fn.

2020-09-08T13:18:13.076Z

In general, if you want something that can be be composed with output from tools that don’t produce edn, I think -M is the easier (only?) option.

practicalli-john 2020-09-08T13:18:31.076200Z

Ah, so I assume clojure -X:alias :x '["1 2 3"]' is required for :exec-fn , which fits in the concept stucture over strings. Although more specific options seem preferable. clojure -X:alias :x 1 :y 2 z: 3 . This is less ambiguous and ties into the general approach I use for Clojure arguments.

practicalli-john 2020-09-08T13:18:57.076400Z

Still lots to learn, so interesting to hear these thoughts. Thanks.

2020-09-08T13:19:43.076600Z

I’m still trying to grasp the implication of the changes too.

alexmiller 2020-09-08T14:11:29.077600Z

You can use find-edn-maps to read and merge-edns function to merge edn maps once they’ve been read

alexmiller 2020-09-08T14:12:29.079Z

make-classpath-map is public but some details of the make-classpath details are going to change, probably this week

alexmiller 2020-09-08T14:13:06.079700Z

(Regarding path ordering)

alexmiller 2020-09-08T14:16:02.080600Z

The whole make-classpath area is in a bit of transition

alexmiller 2020-09-08T14:18:52.084300Z

@jr0cket I think mostly what you’ve gleaned is correct. -M is for pass through to clojure.main. (And originally that’s the only thing clj did.) Calling with no exec opt is for repl. Right now that’s done with clojure.main but you should consider that an implementation detail. -X is for the new function execution style invocation.

alexmiller 2020-09-08T14:20:46.085300Z

We expect most tools are better off with -X, but totally possible to support both of course

alexmiller 2020-09-08T14:23:18.088300Z

For your own app, not sure yet how this will be taken up. Using -X means you are at least somewhat bound to using clj as your launcher (as the exec stub code is not available anywhere else (yet)). Rich seems to think that’s fine, I’m a little less sure about it. :)

alexmiller 2020-09-08T14:25:20.091Z

My biggest issue with the -X arg passing is that passing a string path as the v requires wrapping in multiple quotes which kind of ruins - expansion and other glob and auto completion stuff. I’d say that’s not totally finalized

2020-09-08T14:25:26.091200Z

Ok Alex, thanks a lot! I have been foolishly experimenting with the idea of making https://github.com/JeremS/mbt based on tools deps and I ran into those questions today. If I may I have one more concerning tools.gitlibs. Right now it uses jgit v4. Do you plan to use v5?

alexmiller 2020-09-08T14:31:12.093100Z

Yeah, I’ve spent some time on it but not enough to get it over the line. It also plays into the jsch ssh stuff and look at their newer impl with Apache Mina.

alexmiller 2020-09-08T14:31:46.094200Z

Just FYI, I have built a tools.build tool that will hopefully be making its way toward release soon

2020-09-08T14:43:11.094700Z

Oh man... my rationale was that tools.deps begs a tools.build... A proper tools.build is very good! The jgit question was because the clj-git project uses the v5 making it, I believe, incompatible with tools deps (breakage between jgit 4 and 5) Thank you again for the info.

practicalli-john 2020-09-08T14:43:58.094900Z

Thanks for confirming Alex. I am far more confident in my understanding of the changes. Apart from updating practicalli/clojure-deps-edn with either -M or -X variants instead of -A, there seems no impact on my development projects. My notes from a project developer are shared on this gist: https://gist.github.com/jr0cket/ae7dd745eb45870109ace59fe835ce80

practicalli-john 2020-09-08T14:47:22.095100Z

Updating the Practicalli books with the new approach is pretty easy and can run with the 'new' and 'classic' options for a while. I've planned screencasts of using Clojure CLI tools for Clojurists Together over the next 2 months. I would rather not re-do them as high quality screencasts are time intensive. I will need to decide when to do these videos, so any thoughts on a release date for the new features would help my own planning (I appreciate any comments on dates are no guarantee). If a release is not planned until December, I'll opt for some lower quality screencasts and recreate them running up to a release.

alexmiller 2020-09-08T14:48:31.095800Z

I’m hoping to get to a new stable release in the next week or two

alexmiller 2020-09-08T14:49:26.096700Z

The guide hasn’t been updated for the new stuff yet - I’ll do that with the stable release of it

practicalli-john 2020-09-08T14:57:41.096900Z

Great. That time frame wont impact me at all. Thanks If you want help with the docs, let me know (although you are the expert here)

borkdude 2020-09-08T15:04:34.097400Z

Maybe aliases should also become fully qualified?

borkdude 2020-09-08T15:04:56.097800Z

Then we can have a global (worldwide) alias registry =)

1
borkdude 2020-09-08T15:05:45.098500Z

I wasn't trolling (at least, not consciously)

mpenet 2020-09-08T15:05:58.098800Z

I didn't mean it that way 🙂

borkdude 2020-09-08T15:07:44.099600Z

e.g. want to use seancorfield's aliases -A:org.seancorfield/rebl

borkdude 2020-09-08T15:14:43.100700Z

I guess the problem with that is that aliases can change over time and effectively become a dep. Importing aliases from libs might be an idea, but maybe a bit too much.

alexmiller 2020-09-08T15:44:51.101500Z

I didn't see this go by before but order matters here - the exec opt should be last (same thing you mention later with -X) because in both cases you are passing arbitrary args to another program

alexmiller 2020-09-08T15:45:04.102Z

I understand why that's particularly confusing in this example

alexmiller 2020-09-08T15:52:20.102200Z

fwiw, I don't see this as an issue - the documented behavior is what it does and what I expect it to do in the future

1
alexmiller 2020-09-08T16:02:26.102600Z

aliases can be fully qualified now

alexmiller 2020-09-08T16:02:58.103100Z

people typically don't because more typing, but that's fully supported

2020-09-09T08:39:51.136100Z

I’ve been doing this for a while with local overrides, e.g. :local/libname will be defined in ~/.clojure/deps.edn for when I have a local checkout of it. I think it works quite well, also to distinguish user wide aliases from project ones. cc @borkdude

borkdude 2020-09-09T08:41:29.136400Z

yes, doing something something similar

alexmiller 2020-09-08T16:04:04.103800Z

one thing we've done a bit of thinking about is - how could I specify a tool to use and have it automatically pulled from github without needing to declare an alias at all

borkdude 2020-09-08T16:04:54.104800Z

yes, that was a bit was I was thinking with this

borkdude 2020-09-08T16:05:08.105300Z

bit like lein new does maybe

borkdude 2020-09-08T16:05:52.106500Z

Aliases can be fully qualified now, but will it ever be deprecated that they aren't - as with deps

dominicm 2020-09-08T16:05:55.106800Z

Need some aliases procurers

alexmiller 2020-09-08T16:06:03.107Z

probably not going to fully tackle that for a bit, but I think it would be pretty useful. you need some kind of naming convention that takes you to a gh repo, that can be a deps.edn with deps etc

alexmiller 2020-09-08T16:06:20.107400Z

I think just github support would take you pretty far, but yes all that needs to be thought about

alexmiller 2020-09-08T16:06:37.107900Z

there is also some open space I've been working in around discovery with -X

borkdude 2020-09-08T16:06:38.108Z

this can probably be solved in a tool which you can put in your aliases

1
alexmiller 2020-09-08T16:07:17.108800Z

like could -X have support for listing the functions available to call

borkdude 2020-09-08T16:07:27.109300Z

I wasn't trolling! geez, what is it with people today ;)

alexmiller 2020-09-08T16:07:42.109600Z

how can you support automatic documentation of a -X compatible function

borkdude 2020-09-08T16:08:00.109900Z

maybe metadata?

borkdude 2020-09-08T16:08:07.110100Z

^:x-callable

alexmiller 2020-09-08T16:08:56.111100Z

all tbd, but with combination of mapping from alias to tool repo, and support for :ns-default (to find the default tool namespace), and ability to discover the -X functions, and help for each option....

alexmiller 2020-09-08T16:09:11.111500Z

that's an ecosystem

borkdude 2020-09-08T16:09:31.112Z

yes, the mapping from alias to tool repo was what I was getting at earlier

alexmiller 2020-09-08T16:09:36.112200Z

and then if only had a build system that could make use of those functions...

borkdude 2020-09-08T16:10:25.112600Z

build system?

borkdude 2020-09-08T16:10:35.112900Z

:troll:

alexmiller 2020-09-08T16:10:41.113100Z

:)

dominicm 2020-09-08T16:11:04.113900Z

Metadata wouldn't work by itself, you'd have to require every namespace.

alexmiller 2020-09-08T16:11:05.114Z

anyhow, I'm on "vacation", so back to vacating...

borkdude 2020-09-08T16:11:13.114400Z

enjoy!

dominicm 2020-09-08T16:11:18.114600Z

Yes. Begone!

borkdude 2020-09-08T16:14:18.116Z

Maybe aliases aren't the right fit for name -> github repo and some other concept/option should be invented for that.

seancorfield 2020-09-08T16:53:15.116200Z

clojure -Spath -A:test:runner -- works on stable; works on prerelease but produces a warning (use -M) clojure -Spath -M:test:runner -- works on prerelease (so switching -A to -M per the warning behaves "as expected") clojure -A:test:runner -Spath -- works on stable; works on prerelease but produces a warning (use -M) clojure -M:test:runner -Spath -- does not work on prerelease (so switching -A to -M per the warning "stops working") It's probably not going to be obvious to a user why prerelease is more sensitive to order than stable.

seancorfield 2020-09-08T16:53:21.116400Z

If -Spath implied -P, I think that would provide fewer surprises.

seancorfield 2020-09-08T17:24:58.117100Z

@jeremys If it helps you, take a look at https://github.com/seancorfield/clj-new/blob/develop/src/clj_new/helpers.clj#L60-L71 -- This uses the latest tools.deps.alpha (0.9.782) but still works with both CLI stable and CLI prerelease.

seancorfield 2020-09-08T17:25:48.117500Z

Re: find/read/merge

alexmiller 2020-09-08T17:26:10.117800Z

Yeah

alexmiller 2020-09-08T17:26:18.118200Z

I took a note of that

1
seancorfield 2020-09-08T17:27:56.119500Z

Sort of related to this line of thinking: clj-new supports templates on GitHub via naming conventions, so maybe have a look at the readme for the usage and see if it is close to what you are thinking @borkdude?

borkdude 2020-09-08T17:31:19.120100Z

@seancorfield You mean:

clj -A:new -M:new <https://github.com/somename/someapp@c>...
?

borkdude 2020-09-08T17:33:49.120500Z

or do you have some short form where you only mention the org + repo name, with automatically resolving the newest sha?

seancorfield 2020-09-08T17:43:25.122200Z

Currently, you need the full URL but that's really only to detect what type of template you're using. If you know it's GH, you could take just the org/repo-name and build the rest. And my dot-clojure file has an example of using tools.gitlib to figure out the HEAD of master SHA.

2020-09-08T19:38:06.122600Z

Thank you @seancorfield the last 2 lines are almost exactly what I need!