An easy to use build tool for web files.
Incrementally clean, build, and watch with little to no configuration required.
- Core Concepts
- Command Line
- Quickstart Guide
- Clean, Build, and Watch
- Command Line and API
- GIF, JPG, PNG, and SVG
- Linux, macOS, and Windows
One Source, One Destination
A single source directory which builds/compiles/minifies into a single destination directory.
Clean: Destination files that do not have a source equivalent are removed during cleaning.
Build: If a source file is missing a destination equivalent, build the file. If a source file is newer than a destination equivalent, build the file.
Watch: Run a clean or build task in reaction to file system changes.
File Extension Based
A single plan of action for each file type. CSS files are minified. JPG files are losslessly optimized. Markdown files are compiled, then minified, and so on. Each extension can have its own unique build process but all files with that extension are treated equally.
Any file prefixed with an underscore
_ is considered an include file. Include files do not get directly published from source to destination. Instead, include files contents are only published when a file that can leverage includes is published.
Although capable as is, Feri is designed to be extremely customizable. Using the API or a custom config file allows you to not only change options but even replace core functions.
Make sure you have Node version 11.0.0 or greater. Depending on your operating system, you may also need to install python or other tools used by dependencies that need to be compiled.
Install Feri globally as a command line tool, accessible from anywhere.
npm install -g feri
Install Feri locally in your project's node_modules folder for API use and/or command line use from within your project only.
npm install feri
Either process above may display warnings about optional dependencies. These warnings can be safely ignored as those dependencies were not needed for your particular OS.
You can always upgrade to the latest version of Feri by re-running the global or local install commands.
If you are unsure if an upgrade is available, run the following for a global install.
Or the following for a local install.
npx feri --version
The above commands will provide additional upgrade information if a newer version is available. Otherwise, just the currently installed version will be listed.
Upgrade from Version 3
Two potentially critical things to be aware of.
- The dependency
livereloadhas been replaced by a new extension server.
- Many dependencies have been removed.
- If you still want to work with CoffeeScript, EJS, Jade, JSX, Less, Pug, Sass, and/or Stylus, you'll need to create your own custom build task.
Custom config files using the boolean
feri.config.option.livereload should be changed to
API use for anything
livereload related should be changed to an
extensions equivalent depending on where you are in the plumbing.
Command line options like
--nolivereload have new equivalents like
If installed globally, you can see what command line options are available with:
Or locally with:
npx feri --help
More information is available in the command line documentation.
Assuming Feri is installed globally, the quickest way to start a new project is to use the init command.
This will create a
dest folder along with a custom config file. To make sure everything works, place some files in the
source folder. Now run
feri from the directory where you can see the source and destination folders. After a short time, your published files should appear in the
You'll need to run
feri everytime you want to clean and/or build new files. Once you are comfortable with that pattern, try running the following command instead.
Now Feri will stay active, watching your source folder for changes and automatically run the appropriate clean or build tasks depending on activity in the source folder. Neat!
Advanced topics for those that like to tinker.
Custom Config File
Create a custom config file to set your preferred options, add custom build tasks, or leverage the API.
Custom Build Task
Feri thinks you should be able to grab nearly any npm module and make a custom build task out of it without too much effort. Are
.snazzy files the latest way to write CSS? No need to wait for a plugin. Use the latest tech, right away.
Unique File Types
Feri comes with built-in support for unique file types such as
Reload a web browser tab when files change with the Feri Extension for Chrome, Edge, and Firefox.
Some edge cases you may want to be aware of.
Help support this project on Patreon. Help me caretake and craft new software, videos, and interactive art. All for as little as $1 a month.
In addition to Patreon, here are some other ways you can help this project.
- Translate Feri into other languages. tlhIngan maH!
- Report any issues on GitHub.
- Social media, meetups, fan art, papercraft, or any other way you like sharing your enthusiasm.
- Pull reqrests to improv spellng in documantations!
MIT © Kai Nightmode
The MIT license does NOT apply to the name
Feri or any of the images in this repository. Those items are strictly copyrighted to Kai Nightmode.