wdhowe

Emacs Cheatsheet

A cheatsheet inspired by the book "Clojure for the Brave and True".

Shortcut Keys Used

• C = Control Key
• M = Meta Key (Alt on PCs, Option on Macs)

Examples:

wdhowe

Clojure Development with VScode

Clojure development environment in Microsoft VScode.

Software Install

• Install Microsoft Visual Studio Code via download or your package manager.

Ubuntu

wdhowe

# Export a sensitive environment variable, hiding it from command history and the terminal.
read -rs my_var ; export my_var

# Don't forget to unset it later, when done
unset my_var

wdhowe

Install Clojure

Official site: https://www.clojure.org/index

• Install Clojure dependencies. (Ubuntu)

  sudo apt install openjdk-11-jdk rlwrap
  java -version

wdhowe

Clojure REPL Help

Commands that can be entered in the REPL for finding help, documentation, and more.

Load clojure REPL helper functions

(require '[clojure.repl :refer :all])

wdhowe

Clojure CLI/deps Projects

Clojure CLI tools (with deps.edn) allow for a built in way to create projects.

Official CLI/deps guide: https://clojure.org/guides/deps_and_cli

• Pre-reqs: Clojure and dependencies installed.

• Install a project creation Tool.

wdhowe

Leiningen Projects

Leiningen is another method for managing Clojure projects. It is similar to pipenv in the Python world, in that it manages project space and dependent packages.

Offical Site: https://leiningen.org/

Install Leiningen

• Download the installer

wdhowe

Leiningen Plugins

Lein can be extended via plugins.

Some useful plugins are:

• lein-ancient -> Check your project for outdated dependencies and plugins, as well as upgrade them if desired.
• lein-exec -> Allows single clojure files to be executed and their requirements resolved.
• lein-localrepo -> Work with local Maven repository.
• lein-pprint -> Pretty-print a representation of the project map.

wdhowe

Docker Image Running/Building Examples

The docker images can all be run/built similar to the following.

Variables

Setup the variables per image.

GitHub Example

wdhowe

.PHONY: build test deploy

##-- Environment Variables --#

# Image and container registry
IMAGE_NAME := my-image-name
IMAGE_PATH := mygroup/myproject
REGISTRY   := registry-url:port
IMAGE      := $(REGISTRY)/$(IMAGE_PATH)/$(IMAGE_NAME)