felis-stack-compiler
Version:
A stack compiler for front-end web development
91 lines (63 loc) • 2.17 kB
Markdown
# Felis Stack Compiler
----
The Felis Stack Compiler is a stack compiler for front web development.
It's a simple and easy way to manage, compress, and compile Sass, Ec6, and Html.
- Html code is compressed down to optimize load time
- Scss is compiled to CSS, auto-prefixed, and then compressed
- And thanks to Babel, Ec6 Js is compiled to cross-browser friendly Js
----
## Ussage
```
npm install -g felis-stack-compiler
felis-stack w \
```
That's it!
The compiler will automatically watch for changes in the files and compile sources when they are changed.
## Command syntax
```
Usage: felis-stack <verb> [<args>]
The verbs are:
h, help Dispalys help
w, watch Watches for changes and compiles. Arguments:
<Dir>
<SassDir> <BabelDir> <HtmlDir>
<SassDir> <CssOutDir> <BabelDir> <JsOutDir> <HtmlDir>
c, compile Compiles, doesn't listen.
<Dir>
<SassDir> <BabelDir> <HtmlDir>
<SassDir> <CssOutDir> <BabelDir> <JsOutDir> <HtmlDir>
The args are:
--debug <level>
Prints debug information while code is running. Level (0 - 2)
indicates how much debug info to print. 0(default) is least, 2 is most
--ignore [dir, dir, ...]
Ignores certian dirs
--check <n>
Checks for new files every n seconds.
0 = don't check
Default = 0
--compileOnRun
Compile files initially when felis-stack is called
Extentions:
".max.htm" and ".max.html" files are compressed
".babl" files are compressed
".scss" files are compressed
```
----
## What's compiled
`.scss` files are compiled and compressed
`.js` and `.ec6` files are compiled and compressed
`.max.html` and `.max.htm` files are compressed
## Technical notes
`walk` is used to find files
`chokidar` is used to monitor files for changes
`node-sass` is used to compile the Scss.
`postcss` and `autoprefixer` are used to auto-prefix the CSS.
`crass` is used to minify the css.
`babel-core` is used to compile ec6 and the `babili` preset is used to minify.
`html-minifier` is used to minify the html.
## License
... undecided