Need help with antq?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

liquidz
220 Stars 14 Forks Other 612 Commits 4 Opened issues

Description

Point out your outdated dependencies.

Services available

!
?

Need anything else?

Contributors list

# 166,900
Clojure
CSS
nrepl
leining...
538 commits
# 203,675
Clojure
Clojure...
Rails
reactjs
6 commits
# 1,058
Clojure
hydrati...
postgre...
sql-edi...
3 commits
# 284,045
Clojure
C++
JavaFX
leining...
2 commits
# 78,191
Clojure
Clojure...
Lisp
repl
2 commits
# 590,935
Clojure
HTML
cider
Clojure...
1 commit
# 346,154
leining...
github-...
cloudfl...
Go
1 commit
# 38,812
Clojure
Emacs
mathema...
dl
1 commit
# 482,825
Clojure
React
Clojure...
cljs
1 commit
# 299,309
Clojure...
Clojure
HTML
cider
1 commit

= Antq

Point out your outdated dependencies.

image:https://github.com/liquidz/antq/workflows/test/badge.svg["GitHub Actions for test workflow", link="https://github.com/liquidz/antq/actions?query=workflow%3Atest"] image:https://github.com/liquidz/antq/workflows/lint/badge.svg["GitHub Actions for lint workflow", link="https://github.com/liquidz/antq/actions?query=workflow%3Alint"] image:https://github.com/liquidz/antq/workflows/dependencies/badge.svg["GitHub Actions for dependencies workflow", link="https://github.com/liquidz/antq/actions?query=workflow%3Adependencies"] image:https://codecov.io/gh/liquidz/antq/branch/master/graph/badge.svg["codecov", link="https://codecov.io/gh/liquidz/antq"]

image:https://img.shields.io/clojars/v/com.github.liquidz/antq["Clojars Project", link="https://clojars.org/com.github.liquidz/antq"] image:https://img.shields.io/badge/docker-automated-blue["GitHub Container Registry", link="https://github.com/users/liquidz/packages/container/package/antq"]

[NOTE]

Antq requires Clojure 1.9.0 or later. +

If you'd like to use with 1.8.0 or earlier, please see link:./doc/clojure-1.8.adoc[here].

== Supported files

|=== | File | Tool/Service | Note

| deps.edn | https://clojure.org/guides/depsandcli[Clojure CLI] |

| shadow-cljs.edn | http://shadow-cljs.org[Shadow-cljs] |

| project.clj | https://leiningen.org[Leiningen] | Provides 2 ways of program and plug-in.

| build.boot | https://boot-clj.com[Boot] |

| pom.xml | https://maven.apache.org[Maven] |

| .github/workflows/*.yml | https://github.com/features/actions[GitHub Actions] |

| bb.edn | https://book.babashka.org/index.html#bbedn[Babashka] |

| build.gradle | https://gradle.org[Gradle] | Experimental.

gradle
command must be installed.

|===

== Usage

=== Clojure CLI (deps.edn)

Run the following command for trial.

[source,sh]

clojure -Sdeps '{:deps {com.github.liquidz/antq {:mvn/version "RELEASE"}}}' -M -m antq.core

Or add the following alias to your

$HOME/.clojure/deps.edn
.

[source,clojure]

{ :aliases {:outdated {:extra-deps {com.github.liquidz/antq {:mvn/version "RELEASE"}} :main-opts ["-m" "antq.core"]}}

}

Then, run

clojure -M:outdated
. (run
clojure -A:outdated
for Clojure CLI Tool 1.10.1.645 or earlier).

=== Clojure CLI Tools (

1.10.3.933
or later)

From Clojure CLI ver

1.10.3.933
, https://clojure.org/reference/depsandcli#tool_install[tool] installation is supported.

[source,sh]

install

clojure -Ttools install com.github.liquidz/antq '{:git/tag "1.1.0"}' :as antq

uninstall

clojure -Ttools remove :tool antq

execute

clojure -Tantq outdated

help

clojure -A:deps -Tantq help/doc

=== Leiningen (as a

main
program)

Add the following dependency and alias to your

$HOME/.lein/profiles.clj
.

[source,clojure]

{ :user {:dependencies [[com.github.liquidz/antq "RELEASE"]] :aliases {"outdated" ["run" "-m" "antq.core"]} }

}

Then, run

lein outdated
.

=== Leiningen (as a plugin)

The Leiningen plugin is a newer offering. It tends to be more accurate (since it won't parse your project.clj, having it evaluated by Leiningen instead). However the

:upgrade
option will not be supported (since the plugin cannot always know if a given dependency came from a specific profile, middleware, etc).

In order to use it, add the following plugin to your

project.clj
(or
$HOME/.lein/profiles.clj
):

[source,clojure]

:plugins [[com.github.liquidz/antq "RELEASE"]] ;; optional - you can add antq options here:

:antq {}

Then, run

lein antq
.

=== GitHub Actions

Antq can work with https://github.com/features/actions[GitHub Actions]. See antq's workflow for concrete example.

  • https://github.com/liquidz/antq/blob/master/.github/workflows/dependencies.yml[.github/workflows/dependencies.yml]
  • To show errors as annotations, please set this option:
    --error-format="::error file={{file}}::{{message}}"

In another way, you can use the following action.

  • https://github.com/liquidz/antq-action

=== Gradle

Antq experimentally supports https://gradle.org[Gradle]. See link:./doc/gradle.adoc[here] for details.

== Options === --upgrade Upgrade outdated versions interactively. You can use

--force
option for upgrading without confirmation.

[WARNING]

For now,

--upgrade
option only supports following files.
  • deps.edn
  • shadow-cljs.edn
  • project.clj
  • build.boot

* pom.xml

=== --exclude=ARTIFACT_NAME[@VERSION] Skip version checking for specified artifacts or versions.

E.g.

[source,sh]

Exclude all versions of specified artifact

--exclude=com.github.liquidz/antq

Exclude specific version of specified artifact

--exclude=com.github.liquidz/[email protected]

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

NOTE: You must specify

groupId/artifactId
for Java dependencies.

=== --directory=DIRECTORY Add search path for projects. Current directory(

.
) is added by default.

E.g.

-d foo --directory=bar:baz
will search "foo", "baz" and "bar" directories.

=== --focus=ARTIFACT_NAME

Focus version checking for specified artifacts.

E.g.

--focus=com.github.liquidz/antq

NOTE: You must specify

groupId/artifactId
for Java dependencies.

WARNING:

focus
option is prefer than
exclude
option.

=== --skip=PROJECT_TYPE Skip to search specified project files. Must be one of

boot
,
clojure-cli
,
github-action
,
pom
,
shadow-cljs
and
leiningen
.

E.g.

--skip=pom

=== --error-format=ERROR_FORMAT Customize outputs for outdated dependencies.

E.g.

--error-format="::error file={{file}}::{{message}}"

You can use following variables:

|=== | Variable Name | Description

|

{{file}}
| A filename containing outdated dependencies.

|

{{name}}
| The artifact name.

|

{{version}}
| The current version.

|

{{latest-version}}
| The latest version.

|

{{latest-name}}
| The latest artifact name. See details: https://github.com/clojars/clojars-web/wiki/Verified-Group-Names[Clojars Verified Group Names policy].

|

{{diff-url}}
| The diff URL for Version Control System. (Nullable)

|

{{message}}
| Default error message.

|===

=== --reporter=REPORTER

|=== | Reporter Name | Description

|

table
(default) | Report results in a table.

|

format
| Report results with a custom format. When you use
--error-format
option, this reporter will be used automatically.

|

json
| Report results as a JSON format.

|

edn
| Report results as a EDN format.

|===

== Projects using antq

  • https://github.com/nnichols/clojure-dependency-update-action[clojure-dependency-update-action]: A simple GitHub Actions to create Pull Requests for outdated tools.deps dependencies

== Tips

  • link:./doc/maven-s3-repos.adoc[Maven S3 reposhere].
  • link:./doc/avoid-slf4j-warnings.adoc[Avoid SLF4J warnings]
  • link:./doc/latest-version-of-a-specific-library.adoc[Latest version of a specific library]
  • link:./doc/clojure-1.8.adoc[Antq with Clojure 1.8.0 or earlier]
  • link:./doc/gradle.adoc[Work with Gradle]

== License

Copyright © 2020-2021 https://twitter.com/uochan[Masashi Iizuka]

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.