Antq

Point out your outdated dependencies.

Note	Antq requires Clojure 1.8.0 or later. If you’d like to use with 1.7.0 or earlier, please see here.

Supported files

deps.edn (Clojure CLI)
shadow-cljs.edn (Shadow-cljs)
project.clj (Leiningen)
build.boot (Boot)
pom.xml (Maven)
.github/workflows/*.yml (GitHub Actions)

Usage

Clojure CLI Tool

Run the following command for trial.

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

Or add the following alias to your $HOME/.clojure/deps.edn.

{
 :aliases
 {:outdated {:extra-deps {antq/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).

Leiningen

Add the following dependency and alias to your $HOME/.lein/profiles.clj.

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

Then, run lein outdated.

GitHub Actions

Antq can work with GitHub Actions. See antq’s workflow for concrete example.

.github/workflows/dependencies.yml
To show errors as annotations, please set this option: --error-format="::error file={{file}}::{{message}}"

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

Skip version checking for specified artifacts.

E.g. --exclude=antq/antq

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.

--skip=PROJECT

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.
`{{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.

Tips

License

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.

practicalli-john / antq Goto Github PK

antq's Introduction