Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xsc/asset-builder
Utility for ClojureScript/JS/CSS Building and Minification
https://github.com/xsc/asset-builder
Last synced: 27 days ago
JSON representation
Utility for ClojureScript/JS/CSS Building and Minification
- Host: GitHub
- URL: https://github.com/xsc/asset-builder
- Owner: xsc
- License: mit
- Created: 2015-08-25T08:23:44.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-11T19:49:59.000Z (about 8 years ago)
- Last Synced: 2024-04-13T20:55:19.216Z (7 months ago)
- Language: Clojure
- Size: 25.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# asset-builder
A small utility to help with CLJS/JS/CSS asset building and minification.
[](https://travis-ci.org/xsc/asset-builder)
## Usage
#### Artifact Coordinates
[](http://clojars.org/xsc/asset-builder)
#### Inclusion
I recommend adding a new profile containing all the things necessary for
building - like ClojureScript dependencies - and activating it together with
the `:dev` profile (for availability in the REPL):
```clojure
:profiles
{:build {:dependencies [[org.clojure/clojurescript "1.7.107"]
[xsc/asset-builder "x.y.z"]]}
:dev [:build
{:dependencies ...}]}
```
#### Builder
You can then create a new namespace `build` (e.g. at `src/build.clj`) and add
the build logic:
```clojure
(ns build
(:require [asset-builder.core :as assets]))
(defn run
[]
(assets/build
{:cljs {:source-paths ["src/cljs"]
:output-to "resources/js/main.js"
:output-dir "target/out"
:optimizations :advanced}
:assets {:source-path "resources/js"
:target-path "resources/js"
:minify
{"external-script.js" "external-script.min.js"}}))
```
In the REPL, you can now run:
```clojure
(require 'build)
(build/run)
```
#### Aliases
For automatic building (outside the REPL) you can add the following aliases
(according to your requirements, of course):
```clojure
:aliases
{"build" ["with-profile" "+build" "run" "-m" "build/run"]
"jar" ["do" "build," "jar"]
"uberjar" ["do" "build," "uberjar"]
"install" ["do" "build," "install"]
"deploy" ["do" "build," "deploy"]}
```
#### Multiple Build Steps
`asset-builder.core/build` accepts any number of build specifications, running
them in the order they are supplied, so you can do something like:
```clojure
(assets/build
{:cljs {:output-to "resources/js/main.js", ...}}
{:assets {:minify {"resources/js/main.js" "resources/js/main.min.js"}}})
```
Also, `nil` values are ignored, so you can have conditional build steps quite
easily:
```clojure
(assets/build
(when (build? :cljs)
{:cljs ...})
...)
```
## Contributing
Contributions are always welcome!
## Shoulders/Giants
- [asset-minifier](https://github.com/yogthos/asset-minifier)
- And someone will inevitably say: "Why don't you just use [boot][boot]?"
[boot]: https://github.com/boot-clj/boot
## License
```
The MIT License (MIT)
Copyright (c) 2015 Yannick Scherer
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```