This section of documentation may be outdated.
Frontends assets for Kitsune are managed through Django Pipeline.
To reduce the number of requests per page and increase overall performance,
JS and CSS resources are grouped into bundles. These are defined in
kitsune/bundles.py, and are loaded into pages with template tags. Each
bundle provides a list of files which will be compiled (if necessary), minified,
and concatenated into the final bundle product.
In development, the minification and concatenation steps are skipped. In production, each file is renamed to contain a hash of it’s contents in the name, and files are rewritten to account for the changed names. This is called cache busting, and allows the CDN to be more aggressive in caching these resources, and for clients to get updates faster when we make changes.
The styles written for Kitsune is mostly written in Sass using the SCSS synatax.
Sass files are recognized by an extension of
Plain JS is not suspect to any compilation step, and is only minified and concatenated. Plain JS files should be written to conform to ES3 standards, for compatibility.
Plain JS files have an extension of
These files are recognized by the ES6 compiler by an extension of
should end in
.js.es6 for clarity. However, see the note about Browserify
For more information about ES6 syntax and features, see lukehoban/es6features.
JSX is a syntax extension on top of ES6 (and in some places, ES7) which adds support for an XML-like trees. It is used in Kitsune as a way to specify DOM elements in React Component render methods. JSX is compiled using Babel as well, and in fact all ES6 files may contain JSX syntax, since Babel compiles it by default.
These files don’t have a specific individual extension, but use the
extension. For clarity, standalone jsx files should use the extension of
Files with the extension
.browserify.js are treated as Browserify entry
points. They may include other JS files using ES6 modules syntax. The files
included in this way may also make use of the ES6 module system, regardless of
All files loaded this way are treated as ES6+JSX files. This is generally the only way ES6 and JSX code should be included in a bundle, and so in practice the extensions assigned to those files don’t matter to Django Pipeline, and should be named to be clear to the reader.
Browserify has been configured with the babelify transformer, to be able to load ES6 files.
Frontend dependencies are downloaded using NPM. In a bundle file, they are
package-name/path/in/package.js. Django Pipeline will find the
correct npm package to pull files from.