Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nha/boot-uglify

minification/compression for Clojure
https://github.com/nha/boot-uglify

boot-uglify clojure clojurescript compression minifies uglifyjs

Last synced: 12 days ago
JSON representation

minification/compression for Clojure

Host: GitHub
URL: https://github.com/nha/boot-uglify
Owner: nha
License: epl-1.0
Created: 2015-12-19T20:23:37.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2019-11-08T00:56:39.000Z (over 5 years ago)
Last Synced: 2024-12-30T06:49:53.029Z (about 1 month ago)
Topics: boot-uglify, clojure, clojurescript, compression, minifies, uglifyjs
Language: Clojure
Homepage:
Size: 518 KB
Stars: 13
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Boot-uglify

[![Clojars Project](https://img.shields.io/clojars/v/nha/boot-uglify.svg)](https://clojars.org/nha/boot-uglify)

[![CircleCI](https://circleci.com/gh/nha/boot-uglify.svg?style=shield)](https://circleci.com/gh/nha/boot-uglify.svg?style=shield)

A [Clojure](https://clojure.org/) library to minify JavaScript code.

Use it as an extra optimisation step in your release process to make the JavaScrip file(s) smaller.

Use the Google Closure Compiler normally but when releasing files in `:advanced` mode, use this library to further compress the files. There can be [20%](https://blog.jeaye.com/2016/02/16/clojurescript/) gain on the final file served.

# Installation

[![Clojars Project](http://clojars.org/nha/boot-uglify/latest-version.svg)](http://clojars.org/nha/boot-uglify)

Please note that one of the dependencies is not on maven. So please add the follwowing to you leiningen project.clj:

```clojure

:repositories [["bintray.jbrotli" "http://dl.bintray.com/nitram509/jbrotli"]]

```

If using `boot`, the equivalent is:

```clojure

(set-env!

 :repositories #(conj % '["bintray" {:url "http://dl.bintray.com/nitram509/jbrotli"}]))

```

# Usage

The minifier provides two functions called `minify-css` and `minify-js`, both functions accept a source path followed by the output target and an optional parameter map. The source can be a filename, a directory, or a sequence of directories and or filenames.

```clojure

(ns my.ns

  (:require [nha.boot-uglify.core :refer [minify-js]]))

;; (minify-js in out) ;; operates on files or directories

;; on a single input file

(minify-js "arrays.js" "arrays.min.js") ;;=> {:errors '(), :warnings '(), :sources '("arrays.js"), :target "arrays.min.js", :original-size 153, :compressed-size 47, :original-gzipped-size 109, :gzipped-size 55}

;; several input files

(minify-js ["file1.js" "file2.js"] "twofiles.min.js") ;; {:errors '(), :warnings '(), :sources '("arrays.js" "blocks.js"), :target "twofiles.min.js", :original-size 336, :compressed-size 121, :original-gzipped-size 197, :gzipped-size 114}

;; a directory

(minify-js "js-files-dir/" "all.min.js")

```

## Usage with boot

Relevant parts to add to the `build.boot` :

```clojure

(set-env! :dependencies '[;; ...

                          [nha/boot-uglify "2.8.29"]

                          ])

(require

 ;;...

 '[nha.boot-uglify  :refer [uglify]]

 )

;; sample task

(deftask package

  "Build the package"

  []

  (comp

   ;;(watch)

   (cljs :optimizations :advanced)

   (uglify) ;; put after the cljs task

   ;;(aot)

   ;;(pom)

   ;;(uber)

   ;;(jar)

   ))

```

## Options (WIP)

The default options are:

```clojure 
(def default-options {:sequences 
                      :properties 
                      :dead_code 
                      :drop_debugger true, 
                      :unsafe 
                      :conditionals 
                      :comparisons 
                      :evaluate 
                      :booleans 
                      :loops 
                      :unused 
                      :hoist_funs 
                      :hoist_vars 
                      :if_return 
                      :join_vars 
                      :cascade 
                      :side_effects 
                      :warnings 
                      :global_defs   {}, 
                      :mangle 
                      }) 
```

true,  ; join consecutive statemets with the “comma operator” true,  ; optimize property access: a["foo"] → a.foo true,  ; discard unreachable code ; discard “debugger” statements false, ; some unsafe optimizations true,  ; optimize if-s and conditional expressions true,  ; optimize comparisons true,  ; evaluate constant expressions true,  ; optimize boolean expressions true,  ; optimize loops true,  ; drop unused variables/functions true,  ; hoist function declarations false, ; hoist variable declarations true,  ; optimize if-s followed by return/continue true,  ; join var declarations true,  ; try to cascade `right` into `left` in sequences true,  ; drop side-effect-free statements true,  ; warn about potentially dangerous optimizations/code ; global definitions false  ; mangle names

# Thanks

The following libraries were a source of inspiration or code (or both):

- [ClojureScript](https://github.com/clojure/clojurescript)

- [assets-minifier](https://github.com/yogthos/asset-minifier)

- [boot-cljsjs](https://github.com/adzerk-oss/boot-cljs)

- [UglifyJS-java](https://github.com/yuanyan/UglifyJS-java)

Remaining bugs are mine though.