diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b8ec9f44..45dd7dcbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Compiling / testing via the command-line tool -The [command-line tool](https://github.com/alexarchambault/coursier#command-line-1) of coursier allows to quickly test changes in the `core`, `cache`, and `cli` modules. To get a freshly compiled launcher for it, type +The [command-line tool](https://github.com/coursier/coursier#command-line-1) of coursier allows to quickly test changes in the `core`, `cache`, and `cli` modules. To get a freshly compiled launcher for it, type ``` $ sbt ++2.11.8 cli/pack ``` @@ -96,7 +96,7 @@ and tweaked a bit more depending on what should be tested. ## coursier build matrix -The CI(s) of coursier (Linux and Mac with [Travis](https://travis-ci.org/alexarchambault/coursier/), Windows with [Appveyor](https://ci.appveyor.com/project/alexarchambault/coursier)) test a variety of things. Testing all of those locally can be quite cumbersome. Each of those is susceptible to make the CI fail - often for good reasons, sometimes for less good ones: +The CI(s) of coursier (Linux and Mac with [Travis](https://travis-ci.org/coursier/coursier/), Windows with [Appveyor](https://ci.appveyor.com/project/alexarchambault/coursier)) test a variety of things. Testing all of those locally can be quite cumbersome. Each of those is susceptible to make the CI fail - often for good reasons, sometimes for less good ones: - 3 Scala versions (currently, `2.10.6`, `2.11.8`, and `2.12.1`), - 2 sbt plugins (`sbt-coursier` and `sbt-shading`), each with its own test suite, diff --git a/INTERNALS.md b/INTERNALS.md index 4cc41461c..cb90226e3 100644 --- a/INTERNALS.md +++ b/INTERNALS.md @@ -2,11 +2,11 @@ ## The model -Mainly in [Definitions.scala](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala), [Resolution.scala](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Resolution.scala), and [ResolutionProcess.scala](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/ResolutionProcess.scala). +Mainly in [Definitions.scala](https://github.com/coursier/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala), [Resolution.scala](https://github.com/coursier/coursier/blob/master/core/shared/src/main/scala/coursier/core/Resolution.scala), and [ResolutionProcess.scala](https://github.com/coursier/coursier/blob/master/core/shared/src/main/scala/coursier/core/ResolutionProcess.scala). ### Module -[definition](https://github.com/alexarchambault/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Definitions.scala#L12-L16) +[definition](https://github.com/coursier/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Definitions.scala#L12-L16) Uniquely designates a... module. Typically, just an organisation (`org.scala-lang`) and a name (`scala-library`). At times, can also contains so called attributes: (unordered) key-value pairs. E.g. the SBT plugins usually have some, like `scalaVersion` with value `2.10` and `sbtVersion` with value `0.13`. @@ -16,7 +16,7 @@ During resolution, all dependencies with the same module have their versions rec ### Dependency -[definition](https://github.com/alexarchambault/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Definitions.scala#L43-L54) +[definition](https://github.com/coursier/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Definitions.scala#L43-L54) A dependency towards a given module, with a given version (can be a version interval too, like `[2.2,2.3)` - TODO add support for `last.revision`). @@ -24,7 +24,7 @@ TODO Add a word about the various fields of `Dependency` ### Project -[definition](https://github.com/alexarchambault/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Definitions.scala#L69-L96) +[definition](https://github.com/coursier/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Definitions.scala#L69-L96) Metadata about a given version of a module. @@ -34,7 +34,7 @@ TODO Describe the various fields of `Project` ### Resolution -[definition](https://github.com/alexarchambault/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Resolution.scala#L477-L487) +[definition](https://github.com/coursier/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/Resolution.scala#L477-L487) State of the resolution. @@ -45,7 +45,7 @@ Properties of Resolution: TODO describe the most important methods of `Resolutio ### ResolutionProcess -[definition](https://github.com/alexarchambault/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/ResolutionProcess.scala) +[definition](https://github.com/coursier/coursier/blob/462c16d6db98d35e180a25b0f87aa47083ad98aa/core/shared/src/main/scala/coursier/core/ResolutionProcess.scala) Proceeds with the resolution per se, starting from an initial state (a `Resolution` instance), until the final one. diff --git a/core/shared/src/main/scala/coursier/core/Activation.scala b/core/shared/src/main/scala/coursier/core/Activation.scala index 1b98abc2d..535e7cf2d 100644 --- a/core/shared/src/main/scala/coursier/core/Activation.scala +++ b/core/shared/src/main/scala/coursier/core/Activation.scala @@ -78,7 +78,7 @@ object Activation { val empty = Os(None, Set(), None, None) // below logic adapted from https://github.com/sonatype/plexus-utils/blob/f2beca21c75084986b49b3ab7b5f0f988021dcea/src/main/java/org/codehaus/plexus/util/Os.java - // brought in https://github.com/alexarchambault/coursier/issues/341 by @eboto + // brought in https://github.com/coursier/coursier/issues/341 by @eboto private val standardFamilies = Set( "windows", @@ -134,4 +134,4 @@ object Activation { } val empty = Activation(Nil, Os.empty, None) -} \ No newline at end of file +} diff --git a/core/shared/src/main/scala/coursier/maven/MavenSource.scala b/core/shared/src/main/scala/coursier/maven/MavenSource.scala index 05a1495fd..8a56db052 100644 --- a/core/shared/src/main/scala/coursier/maven/MavenSource.scala +++ b/core/shared/src/main/scala/coursier/maven/MavenSource.scala @@ -261,7 +261,7 @@ object MavenSource { typeExtensions.getOrElse(`type`, `type`) // see https://github.com/apache/maven/blob/c023e58104b71e27def0caa034d39ab0fa0373b6/maven-core/src/main/resources/META-INF/plexus/artifact-handlers.xml - // discussed in https://github.com/alexarchambault/coursier/issues/298 + // discussed in https://github.com/coursier/coursier/issues/298 val typeDefaultClassifiers: Map[String, String] = Map( "test-jar" -> "tests", "javadoc" -> "javadoc", diff --git a/notes/about.markdown b/notes/about.markdown index 61716498d..97bb52067 100644 --- a/notes/about.markdown +++ b/notes/about.markdown @@ -1,4 +1,4 @@ -[coursier](http://github.com/alexarchambault/coursier) is a dependency resolver / fetcher *à la* Maven / Ivy, entirely +[coursier](http://github.com/coursier/coursier) is a dependency resolver / fetcher *à la* Maven / Ivy, entirely rewritten from scratch in Scala. It aims at being fast and easy to embed in other contexts. Its very core (`core` module) aims at being extremely pure, and only requires to be fed external data (Ivy / Maven metadata) via a monad. @@ -21,7 +21,7 @@ Compared to the default dependency resolution of SBT, it adds: * no global lock (no "Waiting for ~/.ivy2/.sbt.ivy.lock to be available"). From the command-line, it also has: -* a [launcher](https://github.com/alexarchambault/coursier#launch), able to launch apps distributed via Maven / Ivy repositories, -* a [bootstrap](https://github.com/alexarchambault/coursier#bootstrap) generator, able to generate stripped launchers of these apps. +* a [launcher](https://github.com/coursier/coursier#launch), able to launch apps distributed via Maven / Ivy repositories, +* a [bootstrap](https://github.com/coursier/coursier#bootstrap) generator, able to generate stripped launchers of these apps. -Lastly, it can be used programmatically via its [API](https://github.com/alexarchambault/coursier#api) and has a Scala JS [demo](https://github.com/alexarchambault/coursier#scala-js-demo). +Lastly, it can be used programmatically via its [API](https://github.com/coursier/coursier#api) and has a Scala JS [demo](https://github.com/coursier/coursier#scala-js-demo).