Skip to content

Commit

Permalink
docs: Add document for :antq/exclude
Browse files Browse the repository at this point in the history
cf. #190
  • Loading branch information
liquidz committed Nov 19, 2022
1 parent 74b8bfb commit 398b308
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,9 @@ E.g.

When you specified a version number, antq will report the latest version excluding only the specified version.

You could also specify dependencies to exclude with `:antq/exclude` metadata.
See link:./doc/exclusions.adoc[Exclusions] for more information.

NOTE: You must specify `groupId/artifactId` for Java dependencies.

=== --directory=DIRECTORY
Expand Down Expand Up @@ -319,6 +322,7 @@ Skip checking diff between deps' versions. Disabled by default.
* link:./doc/gradle.adoc[Work with Gradle]
* link:./doc/proxy.adoc[Run behind proxy]
* link:./doc/timeout.adoc[Timeouts]
* link:./doc/exclusions.adoc[Exclusions]

== License

Expand Down
45 changes: 45 additions & 0 deletions doc/exclusions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
= Exclusions

When you'd like to exclude specific dependencies, you could `--exclude` option as you know.

Otherwise, the following ways are available.

== Metadata in your project file

`:antq/exclude` metadata is available for excluding dependencies.

=== deps.edn
[source,clojure]
----
{:deps {foo/bar ^:antq/exclude {:mvn/version "..."}}}
----

=== shadow-cljs.edn

[source,clojure]
----
{:dependencies [^:antq/exclude [foo/bar "..."]]}
----

=== project.clj

[source,clojure]
----
(defproject foo "0.1.0-SNAPSHOT"
:dependencies [^:antq/exclude [foo/bar "..."]]
----

=== build.boot

[source,clojure]
----
(set-env!
:dependencies '[^:antq/exclude [foo/bar "..."]])
----

=== bb.edn

[source,clojure]
----
{:deps {foo/bar ^:antq/exclude {:mvn/version "..."}}}
----

0 comments on commit 398b308

Please sign in to comment.