Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/olical/clojure-giants-shoulders

Tools and scripts I reach for every time I start a new Clojure project
https://github.com/olical/clojure-giants-shoulders

Last synced: about 2 months ago
JSON representation

Tools and scripts I reach for every time I start a new Clojure project

Awesome Lists containing this project

README 

        
= https://clojure.org/[Clojure] Giant's Shoulders



This repo is a bundle of tools and scripts I tend to reach for every time I start a new Clojure project. I hope you find it useful as a starting point for your projects too! Please feel free to delete any parts you don't need or want, it's just a suggestion and a place to begin.



I want to get you into a REPL as quickly as possible so you can start solving problems without worrying about the colour of the bike shed.



You can use any https://nrepl.org/nrepl/index.html[nREPL] based Clojure editor plugins to talk to the REPL but I of course recommend my own, https://github.com/Olical/conjure[Conjure], if you're not sure where to start. If you're really new to Clojure and don't fancy diving into https://neovim.io/[Neovim] then I'd probably recommend https://calva.io/[Calva].



Fork, copy, clone, borrow, read or browse. Do whatever you want with this repository and use it how you see fit.



Good luck, have fun!



== LSP



Make sure you have a https://microsoft.github.io/language-server-protocol/[LSP] client set up for your editor of choice and https://clojure-lsp.io/[clojure-lsp] installed for the best experience. This will enable extra tooling like linting, in editor formatting, completion and integration with function instrumentation schemas. You can have in editor _type checking_ as you write your Clojure code if you set this up correctly.



== Scripts



=== `scripts/repl`



Starts an interactive REPL with history, highlighting, completion and automatic documentation lookup as you type. Before you start working with the project you should run this in a terminal that you can keep safe in the background somewhere.



You can type code directly into this REPL but I'd recommend using a plugin for an editor of your choosing. It should connect to the REPL automatically when you open a Clojure file in this project thanks to the `.nrepl-port` file.



You may also enable a https://github.com/djblue/portal[portal] window like so:



[source,bash]

----

./scripts/repl :portal true

----



This will open a window alongside your REPL (or in your current browser window if you don't have a Chrome / Chromium installed) that will allow you to visually inspect any values you wrap in `(tap> ...)`. Try it out by evaluating `(tap> (range 10))` in the REPL with the portal window open.



This development REPL also enables the https://github.com/tolitius/mount[mount] system management and https://github.com/metosin/malli[malli] function instrumentation.



=== `scripts/kaocha`



Run the test suite with https://github.com/lambdaisland/kaocha[kaocha]. Append `--watch` to execute your tests as you change files.



I highly recommend keeping a `./scripts/kaocha --watch` window open beside your `scripts/repl` window while you work.



=== `scripts/format`



Format all of your code with https://github.com/weavejester/cljfmt[cljfmt].



=== `scripts/outdated`



Find and update dependencies with https://github.com/liquidz/antq[antq].



[source,bash]

----

# Check for updates

./scripts/outdated



# Actually perform updates

./scripts/outdated --upgrade

----



== Unlicenced



Find the full http://unlicense.org/[unlicense] in the `UNLICENSE` file, but here's a snippet.



____

This is free and unencumbered software released into the public domain.



Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

____