瀏覽代碼

Tweak lint docs

Gabriel Horner 3 年之前
父節點
當前提交
8b0026f34b
共有 2 個文件被更改,包括 8 次插入9 次删除
  1. 2 8
      .github/workflows/build.yml
  2. 6 1
      docs/dev-practices.md

+ 2 - 8
.github/workflows/build.yml

@@ -12,11 +12,10 @@ on:
 
 env:
   CLOJURE_VERSION: '1.10.1.727'
-  CLJ_KONDO_VERSION: '2021.12.19'
   # setup-java@v2 dropped support for legacy Java version syntax.
   # This is the same as 1.8.
   JAVA_VERSION: '8'
-  # This is the latest node version of we can run.
+  # This is the latest node version we can run.
   NODE_VERSION: '16'
 
 jobs:
@@ -65,13 +64,8 @@ jobs:
         if: steps.clojure-deps.outputs.cache-hit != 'true'
         run: clojure -A:cljs -P
 
-      - name: Set up clj-kondo
-        uses: DeLaGuardo/setup-clj-kondo@master
-        with:
-          version: ${{ env.CLJ_KONDO_VERSION }}
-
       - name: Run clj-kondo lint
-        run: clj-kondo --lint src
+        run: clj -M:clj-kondo --lint src
 
       - name: Fetch yarn deps
         run: yarn install

+ 6 - 1
docs/dev-practices.md

@@ -4,9 +4,14 @@ This page describes development practices for this codebase.
 
 ## Linting
 
+To lint:
+```
+clojure -M:clj-kondo --lint src
+```
+
 We lint our Clojure(Script) code with https://github.com/clj-kondo/clj-kondo/. If you need to configure specific linters, see [this documentation](https://github.com/clj-kondo/clj-kondo/blob/master/doc/linters.md). Where possible, a global linting configuration is used and namespace specific configuration is avoided.
 
-Linting is a work in progress as this is a large Clojure codebase with some areas to refactor. There are outstanding linting items that are currently ignored in order to allow full linting of the codebase to run in CI. These outstanding linting items should be addressed at some point:
+There are outstanding linting items that are currently ignored in order to allow full linting of the codebase to run in CI. These outstanding linting items should be addressed at some point:
 
 * Comments starting with `TODO:lint`
 * Code marked with `#_:clj-kondo/ignore` require a good understanding of the context to address as they usually involve something with a side effect or require changing multiple fns up the call stack.