Nearsighted Penguin March

    lumo-cljs

    1.10.1 • Public • Published
    lumo logo

    Lumo

    Backers on Open Collective Sponsors on Open Collective

    Lumo is a standalone ClojureScript environment that runs on Node.js and the V8 JavaScript engine. It starts up instantaneously and has out-of-the-box access to the entire Node.js ecosystem.

    Lumo also provides a ClojureScript build API, making it possible to compile ClojureScript projects entirely without the JVM, thanks to the experimental JavaScript version of the Google Closure Compiler.

    Read the announcement blog post and our pledge!

    If you enjoy Lumo, consider backing or sponsoring the project on Open Collective

    Build status

    Platform Status
    macOS CircleCI
    Linux Build Status
    Windows Build status

    Contents

    Installation

    Via NPX

    npm is a package runner that comes with node6+. You can try lumo "without install" with:

    npx -p lumo-cljs lumo

    Via NPM

    $ npm install -g lumo-cljs

    If you get a permission failure, try this:

    $ npm install -g lumo-cljs --unsafe-perm
    

    Note: the installed binary will be named lumo rather than lumo-cljs

    Via Homebrew (macOS)

    $ brew install lumo

    Note: If you want to install a binary built from master, run brew install --HEAD lumo (at your own responsibility).

    Docker

    $ docker pull anmonteiro/lumo:latest
    $ docker run -it anmonteiro/lumo

    Manual

    1. Download the latest release.
    2. Move it to somewhere in your $PATH.

    Using Lumo

    Enter lumo at the command line to launch it.

    Check out lumo -h for usage instructions and supported command line options.

    Compile ClojureScript

    Lumo can compile ClojureScript code as of version 1.2.0. See the introductory blog post. It is still considered experimental, given the relatively new Google Closure Compiler port to JavaScript, but it aims to be at feature parity with the JVM ClojureScript compiler.

    The build API mirrors the ClojureScript one. Please reference its Quick Start and the Compiler Options. You can basically just replace the namespace with lumo.build.api:

    (require 'lumo.build.api) 
     
    (lumo.build.api/build "src" {:output-to "out/main.js"}) 

    The following example also shows how to use multiple source folders.

    (require '[lumo.build.api :as b]) 
     
    (b/build 
     (b/inputs "src1" "src2") ;; variadic
     {:output-to "out/main.js"}) 

    Building

    To build Lumo from source:

    1. Make sure you have installed Boot, Yarn and Node.js (version >= 8).
    2. At the root of the repository, run: boot release.
    3. The resulting binary can be found in build/lumo (or build\lumo.exe if you're on Windows).

    Contributing

    See CONTRIBUTING.md.

    Backers

    Support us with a monthly donation and help us continue our activities. [Become a backer]

    Sponsors

    Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

    Copyright & License

    Copyright © 2016-2017 António Nuno Monteiro

    Distributed under the Eclipse Public License (see LICENSE).

    Keywords

    none

    Install

    npm i lumo-cljs

    DownloadsWeekly Downloads

    30

    Version

    1.10.1

    License

    EPL-1.0

    Unpacked Size

    171 kB

    Total Files

    7

    Last publish

    Collaborators

    • anmonteiro