Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

atomist-skills/clj-kondo-skill

Repository files navigation

@atomist/clj-kondo-skill

"A linter for Clojure code that sparks joy."

Lint your Clojure code using clj-kondo, get GitHub CheckRuns with warnings and errors.

What it's useful for

Keep track of lint warnings and errors across your repositories.

  • Run clj-kondo with the same consistent configuration across all of your Clojure code
  • Distinguish new warnings and violations from ones that were already present
  • Share clj-kondo configurations with other teams using GitHub gists

Before you get started

The GitHub integration must be configured in order to use this skill. At least one repository must be selected.

How to configure

  1. Specify a custom configuration

    The configuration that you specify will be used across all repositories.
    To encourage the use of shared configurations, you can also reference a public URL -- for example, a gist is a great way to share configurations).

    To use a configuration from a public URL, leave the Custom configuration field blank and reference the URL in the Custom configuration URL field. Here is an example of public gist containing a sample config.edn.

    config

  2. Select repositories

    By default, this skill will be enabled for all repositories in all organizations you have connected. To restrict the organizations or specific repositories on which the skill will run, you can explicitly choose organization(s) and repositories.

    Either select all, if all your repositories should participate, or choose a subset of repositories that should stay formatted. This skill will take no action on repositories that do not contain .clj, .cljs, or cljc files.

    repo-filter

How to Use

  1. Configure the skill as described above

  2. Commit and push your code changes

  3. See clj-kondo results as Checks in your commit on GitHub!

There are already great ways to integrate clj-kondo into your local development flow. See the docs on editor integration here.

To create feature requests or bug reports, create an issue in the repository for this skill. See the code for the skill.


Created by Atomist. Need Help? Join our Slack workspace.