spuild

1.1.0 • Public • Published

Spuild: Web build tool in NodeJS

This build tool automates the web development build process. Currently, these are plugins that are ready for use:

  • Generating HTML from JADE templates (.jade or .pug)
  • Generating CSS form SCSS templates (.scss, or .sass)

More details on inspiration here.

install

from source

  • git clone <this repository>
  • cd spuild2
  • npm install
  • npm link (allows you to call spuild globally)

from npm

  • npm install -g spuild

basic usage, in directory

ensure you are in your project directory, which is organized in the following way.

before

 project
 |_ src/
    |_ assets/
    |_ index.jade
    |_ style.scss
    |_ all-other-files.txt

running spuild in project/.

after

 project
 |_ src/
 |  |_ assets/
 |  |_ .dot-files-ignored
 |  |_ index.jade
 |  |_ style.scss
 |  |_ all-other-files.txt
 |_ build/
    |_ assets/
    |_ index.html
    |_ style.css
    |_ all-built-files.txt

pretty printing feature

by default, the output of spuild is compressed. with the -p flag activated, your build will be rendered. If your output is not previously in the same state (pretty-printed VS compressed), it will be re-rendered too.

clean build feature

this feature will remove the existing files in the build folder before re-rendering every file from src. If build is tracked using git, no worries, your .git folder will be left untouched.

updates

v1.1

  • add help to spuild
  • clean flag function for spuild
  • add flag to enable pretty-print
  • remove lowdb and use native fs
  • extract params into flags

Readme

Keywords

none

Package Sidebar

Install

npm i spuild

Weekly Downloads

0

Version

1.1.0

License

ISC

Unpacked Size

6.3 kB

Total Files

7

Last publish

Collaborators

  • ongspxm