Weaponize guides your client-side app from development to production. Bundles and optimizes your assets. Separates dev and production environment.
npm install weaponize
|2||downloads in the last month|
|Version||0.1.3 last updated 8 months ago|
|Dependencies (11)||commander, csso, express, mime, tilt, envv, cheerio, uglify-js, async, findit, wrench|
Weaponize guides your client-side app from development to production. Bundles and optimizes your assets. Separates dev and production environment. Simplifies working with public and private CDNs.
Weaponize is highly experimental, alpha, under heavy development, however you'd like to call it. Please don't use this... yet.
You know the one drawback to static site generators? It's no fun waiting around for every file to be regenerated (even if you pass Weaponize only a partial set based on what you know to be out of date). To fight that, Weaponize is ruthlessly parallelized and it doesn't keep a file in memory for any longer than it's needed.
Because of this "every file is an island" architecture (we'll have the first file generated and in your build directory before we've even walked your full project tree), there are certain concessions to be made to make up for our application's lack of omniscience.
Typically, your entrypoint file is simply your
index.handlebars or what not) but the way Weaponizer sees it, it's
simply a bunch of instructions for how to handle certain files, so if your
project is a little bit more involved you can just as easily create an HTML
file with no body and just a bunch of link and script tags between the head.
It needn't be part of the generated output either, it is simply the file from
which we will determine how to optimize certain things.
You can specify multiple entrypoint files. They will all be loaded and examined before anything is optimized.
[NOTE: this explanation will make more sense to people when I've first had
a chance to explain how Weaponize can interpret certain tags and attributes
envv and how it can preprocess any template using
tilt.js. If you're
using plain HTML and CSS you only really need an entrypoint file so Weaponize
cases, it's easy to just note that you should pass the command-line tool
the index of your generated-but-not-optimized project instead of
just the directory (or when passed a directory, complain if it doesn't
find an index.html)]
- Packages up a client-side app for easy distribution through a CDN or faster serving on your own hardware: minification, concatenation, all that good stuff.
- Filters out code you only need during development and includes code you only need in production, flagged through
- Finds and replaces references to common libraries like jQuery with the equivalent from a public CDN like cdnjs.com or the Google Libraries CDN.
Weaponize doesn't require any configuration and works with any project structure. Weaponize can work standalone, but you can also use it from Draughtsman. Draughtsman integrates with Weaponize to give you a full-blown local web server and static site builder, built from the ground up to simplify front-end engineers' workflows.
It is also the rendering engine that powers Hector, a nascent Jekyll-like static site generation framework -- ideal if you're not just optimizing an app but want to use Weaponize to build a promotional site or to run your blog.
You can integrate Weaponize into your own apps.
- Give Weaponize a library name or path, and it'll return CDN urls it knows of that have that library (doing HEAD requests so it's always up to date, though with a nocheck parameter so you can use it if offline or if you know your libraries are available at cdnjs.com.)
Point the Weaponize command line interface to an HTML file or directory and it will output a nicely optimized version in a directory of your choice. If for whatever weird reason the Weaponize cache is corrupted, just run
# build your app (always does a clean build and empties the build dir first)
-o --output # output dir
-s --sources # add additional CDN sources (in order of preference)
# draughtsman will respect `data-weaponize-environment` and, being a dev server,
# strip out scripts that target the production environment; but weaponize
# also has its own server, which (as opposed to draughtsman) is as plain to
# a regular file server as possible, and serves mainly to test out if there are
# no errors in the packaging process or in your code that targets the production
# environment only
# We want to encourage people to use draughtsman, but weaponize should be able to stand
# on its own.
-e --environment # production by default
-f --follow # serves an endpoint that a GitHub post-commit hook
# can POST to, which prompts Weaponize to fetch the latest
# commit from said repository and rebuild the app/site
# [also works on weaponize build, which turns that command
# into a long-lived process]
weaponize clean and you'll have a fresh, empty cache.
Point the Weaponize command line interface to an HTML file or directory and it will output a nicely optimized version in a directory of your choice.
If for whatever weird reason the Weaponize cache is corrupted, just run