squire

Flexible front-end build tools

npm install squire
1 downloads in the last day
15 downloads in the last week
53 downloads in the last month

Squire

Squire is a set of flexible front-end build tools for static content. It's equally usable for static websites, blogs, or single-page ajax-based web applications. It provides:

  • File translation (i.e., CoffeeScript to JavaScript)
  • File concatenation and generic dependency management
  • A live preview server for easy, rapid development
  • A generic plugin system to support all types of content
  • A flexible configuration system
  • Request proxying

Getting started

Make sure node.js and npm are installed and use npm to install the package. The -g flag is necessary to make the squire command-line utility available.

sudo npm install -g squire

You can then initialize a new project.

squire new path/to/project

You may use the -t option to change the project template. Run squire new -h to see a list of available templates.

Once that's done you're ready to start up a preview server.

cd path/to/project
squire preview

At this point you can begin editing your content. The changes will automatically be reflected every time you refresh the page. When you're ready to deploy, just run squire build. Your output will be in the build directory by default.

Overview

The core functionality of Squire is to take in a set of files and run them through plugins to process them in some way. To do this, it expects your project to be structured in a particular way. It should look something like this.

app/
    content/
config/
    squire.cson
plugins/
build/

app and app/content

The app directory forms the core of your project. When your project is built, any files in app/content will be placed into the build directory, getting processed by a plugin if a matching one is found. There is always a one-to-one correspondence of files in app/content to files in build.

Files that are in app but not in app/content do not get placed into build directly, but are made available in other ways. Plugins have access to the contents of the app directory via the app tree, and concat files can be comprised of those contents as well.

config

This directory contains configuration files that are written in CSON. You will typically have at least the file "squire.cson", which is used to configure Squire itself. You can also add plugin-specific configuration files by giving them the same name as the plugin. For example, the file "coffeescript.cson" would correspond to the coffeescript plugin.

See Configuration Files for details on the contents of these files.

plugins

This directory is optional. If you need to define any custom plugins, just place them in here and they will be available to use.

build

This is where your compiled files get placed. It is recommended to add this directory to .gitignore. You don't need to create this directory yourself -- it will be created automatically whenever the project is built.

Plugins

Each plugin defines one or more input file extensions and a single output extension. For example, the CoffeeScript plugin supports the "coffee" input extension and the "js" output extension. This means that any .coffee file in your app/content directory will get piped through the CoffeeScript plugin and then placed into the same relative location in the build directory with a .js extension. Any file that doesn't get matched to a plugin will get copied over untouched.

Note that for a plugin to be available you need to explicitly include it in squire.config -- even for the built-in plugins.

Typically you don't need to worry too much about how plugins work beyond this unless you're writing your own plugin. See this document for details on how to do that.

Squire provides six built-in plugins: coffeescript, jade, stylus, markdown, and minifiers for javascript and css. The wiki contains information on how to use each of them.

Index files

Index files files are any files inside app/content that have a base name of "index". They are given special treatment in that they will always compile to an HTML file regardless of the associated plugin's typical output extension.

Plugins that don't typically compile to HTML will often have special-case index file behavior to generate HTML rather than the typical output. For example, the CoffeeScript plugin will take an index.coffee file and gather a set of local variables from it. It will then proxy to a templating plugin, passing in the local variables to the associated template. This is very convenient for specifying template metadata or pre-processing the app tree before it hits the template.

See the documentation for each plugin for details on how they handle index files.

Concat files

Concat files are one of the most powerful and useful features of Squire. They allow you to separate your code into multiple files during development, but compile them into a single file during the build process. They give you a great deal of flexibility in how this is done.

Concat files can only live inside the app/content directory. To specify that a file is a concat file, you prefix the extension with ".concat". For example, you would rename "app.js" to "app.concat.js". The ".concat" will be stripped out during the build process.

Inside the file you simply provide a list of files and/or directories, relative to the app directory, that will be included into the final file. Files are separated by newlines (empty lines and comment lines prefixed with # are okay), and the files will be compiled in the order they are listed in the concat file.

There is no limitation on mixing types in a concat file -- Squire is smart enough to pipe everything through the correct plugin before combining the final result. For this reason, the file extension of a concat file should always be the desired output extension. So even if your concat file contains only CoffeeScript files, you should call it "app.concat.js", not "app.concat.coffee".

Here is a simple example of a concat file.

# This file includes all of our JavaScript.
scripts/lib/jquery.js
scripts/lib/underscore.js
scripts/setup.coffee
scripts/script_a.coffee
scripts/script_b.coffee
scripts/script_c.coffee
scripts/init.coffee

It's a bit annoying to list out every file by hand though. Let's try this instead.

# This file includes all of our JavaScript.
scripts

This will recursively include all of the files inside app/scripts. Now whenever you add more files, they'll be automatically included without any extra effort on your part. However, there is no guaranteed order that the files will be included in. Squire provides a few ways to get around this problem. Here's one way.

# This file includes all of our JavaScript.
scripts/lib
scripts/setup.coffee
scripts
scripts/init.coffee

This will guarantee that all of the files inside the scripts directory will be included as before, but now everything in lib is guaranteed to be included first, followed immediately by setup, with init coming last. The order of the files inside lib is not guaranteed, but in this case that's okay.

Let's say we have some test files inside the folder scripts/tests that we don't want to be included into the concat file. We can exclude them with an exclamation point prefix.

# This file includes all of our JavaScript.
scripts/lib
scripts/setup.coffee
scripts
scripts/init.coffee
!scripts/tests

Although script_a, script_b and script_c are guaranteed to be included after setup and before init, they are not guaranteed any order amongst themselves. But let's say script_b actually depends on script_a. We could type out the two files explicitly in the concat file, but as the project gets larger that's going to become unwieldy. Instead we can specify dependencies inside the files themselves, similar to how files are included or required in other programming languages. This is done with a specially-formatted comment near the top of the file.

scripts/script_a.coffee

class MyClassA
    # ...

scripts/script_b.coffee

#~ scripts/script_a.coffee

class MyClassB extends MyClassA
    # ...

Now script_b is guaranteed to be included after script_a.

The ~ character specifies that the comment is a dependency statement. There are several formats of accepted dependency statements to support dependency management across as many languages as possible. The supported formats are #~ path/to/file, ##~ path/to/file, //~ path/to/file, and /*~ path/to/file */.

The file path can either be relative to the app directory or to the file itself by using the dot character. The path in the above example could have been written as either "./script_a.coffee" or "scripts/script_a.coffee".

Dependency statements are allowed to come after comments, but Squire will stop searching for statements once it encounters a non-comment or non-empty line.

The app tree

During the build process, Squire will scan all of the files and directories in your app directory and generate the app tree. The app tree is a representation of all the content within the app directory, and it gets passed along to each plugin. Plugins can then pass the data on to you when it makes sense to do so (typically in templating language plugins).

The built-in Jade plugin, for example, will pass along the app tree as a local variable to your templates. You might use this if you are, say, creating an image gallery -- in your Jade template you can iterate over all the images in a particular directory and render them to the page.

See the documentation for each plugin for details on how they make use of the app tree.

The tree is made up of SquireDirectories and SquireFiles, which are documented below. The app tree itself is a SquireDirectory.

SquireDirectory

Property Type Description
name String The name of the directory.
path String The path to the directory relative to the app directory.
publicPath String If this is a content directory (i.e., it's inside the app/content directory), this will be the path to the directory relative to the build directory, otherwise it will be null.
files Object An object with a key-value pair for each file in the directory. The keys are the names of the files, and the values are instances of SquireFile.
directories Object An object with a key-value pair for each subdirectory in the directory. The keys are the names of the directories, and the values are instances of SquireDirectory.
getPath Function A convenience function for getting a file or directory at the given path. i.e.: logoFile = app.getPath "content/images/logo.png"
walk Function A function that will synchronously, recursively iterate through all of the directory's subdirectories, calling a callback for each one. i.e.: app.walk (directory) -> # Do something with each directory.

SquireFile

Property Type Description
name String The name of the file.
path String The path to the file relative to the app directory.
publicPath String If this is a content file (i.e., it's inside the app/content directory), this will be the path to the compiled file relative to the build directory, otherwise it will be null. In other words, this will be the URL to the publicly-accessible file after the project is built, relative to the project root.
content String The contents of the file after being processed by the associated plugin. If there is an error when processing the content, the error message will be placed here instead. By default, plugins do not process content that goes into the app tree, but they are able to override this behavior. See the documentation of each plugin for details.
data Object Any secondary data generated by the plugin when processing the content. See the documentation of each plugin for details.

Request proxying

In preview mode, Squire can proxy requests to another server. This is useful when you're building a web application that needs to talk to some other backend server. You can enable the feature by setting some config values. The config properties you'll be interested in are enableProxy, proxyPort and possibly proxyHost.

When proxying is enabled, Squire will no longer serve 404s on its own. Any requests that don't correspond to a built file will automatically be sent to the proxy server instead.

Configuration files

Squire supports configuration at the global level and the plugin level. All configuration files are written in CSON and live in the config directory. The file "squire.cson" contains configuration for the entire build process, and any other files are specifically for plugins with the same name. "jade.cson" will correspond to the jade plugin, etc.

All config values should be placed into one of three namespaces: global, preview, or build. Global values are the base config values, while preview and build values will add to and override global values only in their corresponding environments. Here's what a squire.config file might look like.

global:
    appDirectory: "src"
    plugins: ["coffeescript", "jade", "stylus", "markdown"]
preview:
    minify: false
build:
    minify: true

Look at the documentation for each plugin to see the config values it supports. Here's what the Squire config file supports.

Key Default Description
plugins [] The list of plugins that you want to use in your project. You'll almost always want to define this value, because no plugins are included by default.
appDirectory "app" The name of the directory that contains all of the app files.
inputDirectory "content" The name of the directory inside the app directory from which files are compiled into the build directory.
outputDirectory "build" The name of the directory that the compiled files get placed into.
ignoreHiddenFiles true Hidden files (files prefixed with a dot) will be ignored during the build process when this is true. This is helpful for preventing those pesky .DS_Store files from causing trouble.
minify true during build, false otherwise This isn't used by Squire itself, but some plugins use it to specify whether their output is minified or not.
enableProxy false during preview, undefined during build Set this to true to enable request proxying in preview mode. You'll likely need to set the proxyPort property as well.
proxyHost "localhost" during preview, undefined during build If you are proxying requests, you can set this to change the proxy host name.
proxyPort 80 during preview, undefined during build If you are proxying requests, you can set this to change the proxy port number.
simulatedProxyDelay undefined A time, in milliseconds, to delay proxy routes in preview mode. This is useful for simulating a slow server.
simulatedFileDelay undefined A time, in milliseconds, to delay served files in preview mode. This is useful for simulating a slow server.
routeRewrites undefined An array of objects, each with two string properties, from and to. When the preview server is running, any routes that match the from route will instead call the to route.

Changelog

1.1.8

  • Fixed an issue where the preview server would sometimes not rebuild the project.

1.1.7

  • Added config options simulatedProxyDelay and simulatedFileDelay to simulate server delay.
  • Improved verbose logging with pretty colors.

1.1.6

  • Fixed an issue where the preview server would rebuild projects too often.
  • The JavaScript plugin now allows you to specify constants to be injected into the output.
  • Can now specify the verboseness of the preview command.

1.1.5

  • package.json now specifies major and minor versions of dependencies.

1.1.4

  • Fixed a crash that would occur after running the preview server for too long due to too many open files.

1.1.3

  • Fixed an issue with the version command.

1.1.2

  • The current version can now be inspected by running squire version.
  • Custom modes can now be specified when building with the -m or --mode flag, as in squire build -m test.

1.1.1

  • The JavaScript plugin now allows you to use strict mode automatically with the useStrict config option.

1.1.0

  • Plugins can now perform post-processing on content after it's been compiled.
  • JavaScript and CSS minification have been separated out into their own plugins that utilize post-processing. This improves the behavior of minification for concat files and allows for minification even if you aren't using CoffeeScript or Stylus.
  • Files can now be excluded from concat files by preceding a line with an exclamation point.
  • Added support for route rewriting in preview mode.
  • Improved template projects.
  • CoffeeScript files can now be optionally wrapped in a function. This is turned on by default.
  • Removed usage of node.js API deprecated as of 0.7.1.

1.0.2

  • Added support for request proxying.
  • Fixed an issue where the build directory would sometimes be removed during the build process, causing the server to die.

1.0.1

  • Fixed some issues with loading plugins installed from npm.

1.0.0

  • Initial release.

License

Copyright (c) 2012 Jarod Long

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.

npm loves you