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

Support Clojure / deps.edn projects #97

Open
devurandom opened this Issue Sep 18, 2018 · 7 comments

Comments

Projects
None yet
3 participants
@devurandom
Contributor

devurandom commented Sep 18, 2018

It would be great if BackYourStack could support Clojure projects that use deps.edn.

The file you want to be looking at is a Clojure / EDN file (parser implemented in JavaScript), the same format as relevant for #96. A sample that should be sufficient for the purposes of BackYourStack is given in the deps and CLI guide, with a full reference / extensive documentation being available in the Clojure reference sections about deps.edn and dependencies. These files contain exactly one map {} of :keyword value pairs. You are searching for the value associated with the :deps keyword, which in turn will be a map {} of symbol value pairs, with the symbol being the name of the dependency and the value again being a map {} of :keyword value pairs. In this final map, the only keyword interesting to you is :mvn/version whose value will be a "string".

Sample taken from the Clojure reference on dependencies:

{:deps
 {org.clojure/tools.reader {:mvn/version "1.1.1"}}}

The dependencies with their descriptions, home page, source repo, versions, dependencies, licenses are usually to be found on Clojars (HTTP REST API documentation) and in some rare cases on Maven. This is the same as for #96.

@martinklepsch

This comment has been minimized.

martinklepsch commented Sep 20, 2018

I think the easiest and most reliable way to deal with this is by looking at projects pom.xml. This means an implementation of this does not have to deal with build tool specific files and the implementation will likely be very similar to a Java implementation.

Is there a guide to implement support for new languages? What is needed, etc?

This also applies to #96 so maybe these issues can be considered duplicates.

Edit: some more context on pom.xml: these files are used in maven repositories to declare dependencies and other project metadata. Clojars provides them in easily accessible places, e.g. https://repo.clojars.org/lambdaisland/kaocha/0.0-153/kaocha-0.0-153.pom

@znarf

This comment has been minimized.

Collaborator

znarf commented Sep 20, 2018

@martinklepsch If pom.xml files are committed to the repositories, it does sound like a reasonable implementation. Can you point to example repositories that use Clojure and have a pom.xml file?

We don't have a guide yet to support new languages. But:

@devurandom

This comment has been minimized.

Contributor

devurandom commented Sep 20, 2018

@martinklepsch Do you plan on implementing this or are you merely gathering information for the one who will?

Re: pom.xml: I see how they can be used to learn about the dependencies' dependencies, but we are not guaranteed that also the initial project is available on Clojars. Thus I think there is no way around parsing EDN.

@martinklepsch

This comment has been minimized.

martinklepsch commented Sep 20, 2018

@devurandom you’re right, I assumed you would run BYS on a dependency but really most people are going to run it on their project that may not even have a pom.xml or jar packaging.

With that in mind we’ll need something that

  1. parses some local project file (project.clj, build.boot, deps.edn) to get the set of dependencies used by the application / project
  2. retrieves dependencies of those dependencies (i.e. transitive dependencies)

Just for my understanding, does backyourstack mostly run on the users computer or on a server in some way? (On mobile right now so can’t look it up easily but don’t worry if there’s no quick answer.)

@devurandom

This comment has been minimized.

Contributor

devurandom commented Sep 20, 2018

Until now I only knew about https://backyourstack.com/ i.e. examining people's stacks online -- I did not even know you could (conveniently) run it on your local computer.

@znarf

This comment has been minimized.

Collaborator

znarf commented Sep 20, 2018

As of today, BackYourStack is effectively only a website that is available at https://backyourstack.com/

It does make sense to make it available as a CLI too, but that's absolutely not there. Would be happy to help if someone wants to work on that.

@martinklepsch

This comment has been minimized.

martinklepsch commented Sep 20, 2018

Ah, I think I confused it with @ferossthanks project, sorry 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment