Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Integrations

GitHub Actions

The repository ships a composite action that runs the structural lint and canonical-format gates:

- uses: takeokunn/paredit-cli@main
  with:
    mode: lint        # lint | format | fix
    paths: src tests  # files or directories, scanned recursively
InputDefaultMeaning
modelintlint fails on structural parse errors; format fails when a source is not in canonical format; fix rewrites sources in place.
paths.Space-separated files or directories to scan.
versionpinned refparedit-cli git ref to run; defaults to the ref the action is pinned to.
cachix-nametakeokunn-paredit-cliPublic Cachix cache for prebuilt binaries.

For ad-hoc use, invoke the Nix flake directly with canonical command paths:

- name: Check Lisp source
  run: nix run github:takeokunn/paredit-cli -- inspect check --file source.lisp

Nix flake

The flake exposes packages, apps, and reusable check helpers:

nix run github:takeokunn/paredit-cli -- inspect check --file source.lisp
nix run github:takeokunn/paredit-cli#lint -- .
nix run github:takeokunn/paredit-cli#format -- --check .

Downstream flakes can reuse the gates and the formatter:

  • lib.<system>.mkLintCheck { src = ./.; } — a derivation that fails on structural parse errors, suitable for checks.
  • lib.<system>.mkFormatCheck { src = ./.; } — the canonical-format gate as a derivation.
  • lib.<system>.treefmtFormatter — a treefmt formatter entry covering .lisp, .asd, .el, .scm, .clj, .cljc, .cljs, .janet, and .fnl sources.
  • overlays.default — adds paredit-cli, paredit-lint, paredit-format, and paredit-format-files to nixpkgs.

Nix development shell

nix develop
cargo test
paredit inspect check --file source.lisp

AI coding agents

The skills/paredit-cli/ directory packages the agent-facing skill contract: when to reach for paredit instead of hand-editing delimiters, and which plan/preview/verify sequences are safe to automate.

GitHub Pages

This site is built from docs/src with mdBook via the Nix flake (nix build .#docs) and published by the Publish documentation workflow. The same derivation runs as checks.documentation in nix flake check, so a broken book fails CI before it can reach the site.