expose component linting api

[roman01la]

Exposes UIx component linter

Usage

(ns app.code
  ;; have to require .clj ns with a linter so that it gets registered
  (:require-macros [app.my-linter]))

;; app/my-linter.clj
(ns app.my-linter
  (:require
    [cljs.analyzer :as ana]
    [uix.linter]))

(defn lint-a11y-button [[_ el attrs & children :as form]]
  (cond
    ;; no attrs
    (not (map? attrs))
    ;; points to an element since there's no attrs map
    (uix.linter/add-error! form :a11y/aria-label (uix.linter/form->loc form))

    ;; no :aria-label in attrs
    (nil? (:aria-label attrs))
    ;; points to attrs map
    (uix.linter/add-error! form :a11y/aria-label (uix.linter/form->loc attrs))))

(defn lint-element [form]
  (let [[_ el attrs & children] form]
    (case el
      :button (lint-a11y-button form) ;; lints a `button` element
      nil)))

(defn lint-aria [expr]
  ;; walks component's body
  (clojure.walk/prewalk
    (fn [form]
      (when (uix.linter/uix-element? form)
        (lint-element form)) ;; lints `($ ...)` element
      form)
    expr))

;; register your linter
(defmethod uix.linter/lint-component :a11y/element [_ sym body env]
  ;; `body` is a seq of top level expressions in a `defui` component
  (run! lint-aria body))

;; register error printers
(defmethod ana/error-message :a11y/aria-label [_ {:keys [source] :as v}]
  (let [[_ el] source]
    (str "The " el " is missing aria-label attribute")))

An example of the error message