This is an automated email from the ASF dual-hosted git repository.
mbuenger pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new 217a0daf Clarify Dependency Scope table (#1411)
217a0daf is described below
commit 217a0daf8aab305dc0cf9d41aad3eac1c7b3373f
Author: Matthias Bünger <buk...@users.noreply.github.com>
AuthorDate: Sat Oct 4 12:53:47 2025 +0200
Clarify Dependency Scope table (#1411)
This PR improves the description and (the visualization of the) table about
what's the resulting scope of a dependency and a transitive of it.
closes: #1357
Overtakes abandoned PR #1362.
---
.../introduction-to-dependency-mechanism.md | 70 ++++++++++++++++++----
content/resources/css/site.css | 11 ++++
2 files changed, 68 insertions(+), 13 deletions(-)
diff --git
a/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md
b/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md
index ed455d85..9d62d09f 100644
---
a/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md
+++
b/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md
@@ -87,23 +87,67 @@ There are 6 scopes:
- **runtime**
This scope indicates that the dependency is not required for compilation,
but is for execution. Maven includes a dependency with this scope in the
runtime and test classpaths, but not the compile classpath.
- **test**
- This scope indicates that the dependency is not required for normal use of
the application, and is only available for the test compilation and execution
phases. This scope is not transitive. Typically this scope is used for test
libraries such as JUnit and Mockito. It is also used for non-test libraries
such as Apache Commons IO if those libraries are used in unit tests
(src/test/java) but not in the model code (src/main/java).
+ This scope indicates that the dependency is not required for normal use of
the application, and is only available for the test compilation and execution
phases. This scope is not transitive. Typically, this scope is used for test
libraries such as JUnit and Mockito. It is also used for non-test libraries
such as Apache Commons IO if those libraries are used in unit tests
(src/test/java) but not in the model code (src/main/java).
- **system**
- This scope indicates that the dependency is required for compilation and
execution. However, Maven will not download the dependency from the repository
system. Instead it looks for a jar in the local file system at a specified path.
+ This scope indicates that the dependency is required for compilation and
execution. However, Maven will not download the dependency from the repository
system. Instead, it looks for a jar in the local file system at a specified
path.
- **import**
This scope is only supported on a dependency of type `pom` in the
`<dependencyManagement>` section. It indicates the dependency is to be replaced
with the effective list of dependencies in the specified POM's
`<dependencyManagement>` section. Since they are replaced, dependencies with a
scope of `import` do not actually participate in limiting the transitivity of a
dependency.
-Each of the scopes (except for `import`) affects transitive dependencies in
different ways, as is demonstrated in the table below. If a dependency is set
to the scope in the left column, a transitive dependency of that dependency
with the scope across the top row results in a dependency in the main project
with the scope listed at the intersection. If no scope is listed, it means the
dependency is omitted.
-
-| | | | | |
-|:---------|:-----------|:---------|:---------|:-----|
-| | compile | provided | runtime | test |
-| compile | compile(*) | \- | runtime | \- |
-| provided | provided | \- | provided | \- |
-| runtime | runtime | \- | runtime | \- |
-| test | test | \- | test | \- |
-
-**(*) Note:** it is intended that this should be runtime scope instead, so
that all compile dependencies must be explicitly listed. However, if a library
you depend on extends a class from another library, both must be available at
compile time. For this reason, compile time dependencies remain as compile
scope even when they are transitive.
+Each of the scopes (except for `import`) affects transitive dependencies in a
different way.
+For a dependency A, declared in the project (left column), and its transitive
dependency B (top row), the table below shows the resulting scope of B based on
both initial scope declarations.
+If the cell is empty, it means the dependency is omitted during the build of
the project.
+
+Examples:
+* If dependency A is declared as "compile" and its transitive dependency B is
declared as "runtime", then the resulting scope of B will be "runtime".
+* If dependency A is declared as "compile" and its transitive dependency B is
declared as "provided", then B will be omitted.
+
+<div style="width: 90%; text-align: center; vertical-align: center; margin:
20px;">
+ <table class="bordered" style="table-layout: fixed; width: 100%;">
+ <thead>
+ <tr>
+ <th rowspan="2" colspan="2" class="bordered grey" style="width:
30%"> </th>
+ <th colspan="4" class="bordered grey" style="width: 70%">Scope of B
(transitive dependency of A)</th>
+ </tr>
+ <tr>
+ <th class="bordered grey">compile</th>
+ <th class="bordered grey">provided</th>
+ <th class="bordered grey">runtime</th>
+ <th class="bordered grey">test</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th rowspan="4" class="bordered grey">Scope of A (Project
dependency)</th>
+ <th class="bordered grey">compile</th>
+ <td class="bordered">compile</td>
+ <td class="bordered">-</td>
+ <td class="bordered">runtime</td>
+ <td class="bordered">-</td>
+ </tr>
+ <tr>
+ <th class="bordered grey">provided</th>
+ <td class="bordered">provided</td>
+ <td class="bordered">-</td>
+ <td class="bordered">provided</td>
+ <td class="bordered">-</td>
+ </tr>
+ <tr>
+ <th class="bordered grey">runtime</th>
+ <td class="bordered">runtime</td>
+ <td class="bordered">-</td>
+ <td class="bordered">runtime</td>
+ <td class="bordered">-</td>
+ </tr>
+ <tr>
+ <th class="bordered grey">test</th>
+ <td class="bordered">test</td>
+ <td class="bordered">-</td>
+ <td class="bordered">test</td>
+ <td class="bordered">-</td>
+ </tr>
+ </tbody>
+ </table>
+</div>
## Dependency Management
diff --git a/content/resources/css/site.css b/content/resources/css/site.css
index 41317fa2..e8f063a8 100644
--- a/content/resources/css/site.css
+++ b/content/resources/css/site.css
@@ -54,3 +54,14 @@ body ul {
text-indent: inherit;
}
+.bordered {
+ border: 1px solid black;
+ background-color: #ffffff;
+}
+
+.grey {
+ background-color: #f9f9f9;
+}
+
+
+
