Skip to content

Latest commit

 

History

History
144 lines (99 loc) · 4.46 KB

README.md

File metadata and controls

144 lines (99 loc) · 4.46 KB
Raw

reloaded

A Leiningen 2 template to generate project skeletons using tools.namespace, Component, and component.repl.

This template is based on the blog article My Clojure Workflow, Reloaded.

Releases and Dependency Information

This template requires Leiningen 2.

I publish releases to Clojars.

Current release is 0.5.0

No installation is necessary; Leiningen should automatically discover and download the template.

Quick Start

In your shell:

lein new reloaded com.example/my-project cd my-project lein repl

At the REPL prompt:

(go)

This will load and switch to the dev namespace.

As you work, reload/restart your system from the dev namespace:

(reset)

Edit dev/dev.clj. Define a constructor for your application in the placeholder in dev-system.

Details

Run lein new reloaded com.example/new-project to generate a new project skeleton in the new-project directory, with a structure like this:

.
├── README.md
├── project.clj
├── dev
│   └── dev.clj
│   └── user.clj
└── src
    └── com
        └── example
            └── new_project.clj

The src directory contains your application source files.

The dev directory contains files that you will use only during interactive development, including:

  • dev.clj, with template functions to create your application.

  • user.clj, loaded automatically by Clojure at startup.

These files will not be packaged in the JAR files created by lein jar or lein uberjar.

The user namespace refers the go, reset, and dev symbols from the com.stuartsierra.component.user-helpers namespace, which is packaged with component.repl. In user-helpers, reset is just an alias for go, so that you can use type the same thing regardless of whether the REPL is in user or dev.

The dev namespace refers common Clojure utilities and the reset, start, stop, and system symbols from the com.stuartsierra.component.repl namespace.

See component.repl and the original article for explanations of how I use these files to develop an application. Note: The article was written before the existence of Component and component.repl.

Change Log

  • Version 0.5.0 released on 2017-03-12
    • Upgrade component.repl to 0.2.0
    • Refer user-helpers from component.repl instead of inline definitions in user.clj
  • Version 0.4.0 released on 2017-03-01
    • Add test directory to created project
    • Add CHANGELOG to created project
  • Version 0.3.1 released on 2017-02-27
    • Fix: dev requires clojure.tools.logging but it is not a dependency
  • (BROKEN) Version 0.3.0 released on 2017-02-27
  • Version 0.2.1 released on 2015-09-19
    • Fix mis-named go symbol in dev namespace
  • (BROKEN) Version 0.2.0 released on 2015-09-19
    • Move start/stop functions into dev namespace
    • Update tools.namespace & Clojure versions
  • Version 0.1.3 released on 2014-10-04
    • Update tools.namespace dependency in template
  • Version 0.1.2 released on 2014-07-18
    • Update Clojure & tools.namespace dependencies in template
  • Version 0.1.1 released on 2013-10-21
    • Do not assume EPL or any other license in generated project
  • Version 0.1.0 released on 2013-08-05

Forking

I created this template for my own personal use, and I am publishing it in the hopes that others will find it useful. I encourage you to fork and modify this template to suit your own needs and personal workflow, but I am unlikely to merge any changes into this repository.

Copyright and License

Copyright © 2013-2017 Stuart Sierra. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software.