deplo

Mini Node.js build system for my legacy apps

Usage no npm install needed!

<script type="module">
  import deplo from 'https://cdn.skypack.dev/deplo';
</script>

README

deplo

deplo is a tiny build system aimed to be fast even on older machines.

Pros

  • simple and clean api tailored for common tasks
  • manual dependency tracking of files provides amazing speed of building

Cons

  • manual dependency tracking is cumbersome
  • Yet Another Build System

Installation

npm install deplo

Usage

var app = require('deplo')({
  target_dir: 'build/' // required by clean()
});

//
// plugins and transformers
//

var js = app.plugins.js;
var less = app.plugins.less;
var jsx = require('react-tools').transform;

//
// configure
//

app.use(js({
  target_dir: 'build/%env/js/',
  src_dir: 'src/js/',
  banner: '/* MIT License */\n',
  // hash env -> bool
  compress: {
    production: true 
  },
  transformers: {
    'HelloMessage.jsx': [jsx]
  }
}));

app.use(less({
  target_dir: 'build/%env/css/',
  src_dir: 'src/less/',
  banner: '/* MIT License */\n',
  // optional paths required by less parser
  paths: ['src/less/'],
  // hash env -> bool
  compress: {               
    production: true
  }
}));

//
// apps
//

// app1
app.js('app1.js', [
    'dep1.js',
    'app1.js'
]);

// app2
app.js('app2.js', [
    'HelloMessage.jsx', // jsx
    'dep1.js',
    'app2.js'
]);

// less
app.less('app.css', {
  main: 'app.less',
  images: {
    target_dir: 'images',
    src_dir: 'images'
  },
  deps: [
    'dep1.less'
  ]
});

// run
app.build('development', function (err) {
  if (err) throw err;
  app.watch();
});

Api

options

  • target dir: required

builder.use(plugin)

builder.build(env, callback)

  • env: list of env separated by ','

Example

// build development AND production
app.build('development,production', function (err) {});

builder.watch()

Watch filesystem and rebuild on files changes.

Example

Run

node examples/deploFile.js

Copyright & License

Copyright (C) 2014 Giulio Canti - Released under the MIT License.

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.