Huel

A highly opinionated build and development tool for web projects.

Table of Contents

• Features
• Motivation
• Requirements
• Get Started
  • Install
  • Usage
    • Production build
    • Development server
    • Package Tests
    • NOTE
• Contributing

Features

A concatenation of the following tools, hidden behind a minimalistic command-line-interface:

• webpack - module bundler
• babel - write next-gen javascript
• postcss - write next-gen css
• prettier - formats your code
• eslint - lints your code
• husky - add git commit hooks
• commitlint - lint your commit messages
• conventional-changelog - auto generate changelog
• depcheck - sync dependencies between node_modules and package.json and check for unused modules
• package-json-validator - validate package.json
• size-limit - check size limit
• check-dependencies check that modules are synced between package.json and package-lock.json
• jarvis - start a browser based Webpack dashboard
• speed-measure-webpack-plugin - measure time it takes for webpack plugins to run
• validate node and npm versions
• validate that strict versioning is used in package.json for modules

Motivation

When you rely on microservice architecture or merely deploy multiple similar web projects, you find yourself replicating a lot of mundane work, and that's where Huel comes in. It allows you to hide all the configuration files and scripts behind a few commands defined in your package.json file. There's also a huel init command which bootstraps your project with various build and development scripts and also adds commitlint, a git hook which lints your commits.

Requirements

• Node > 8

Get Started

Install

npm install --save-dev huel

Usage

Production build

huel build --template src/index.html --entry src/index.js --output dist/

Development server

huel build --env development --debug -w --port 1337 --template src/index.html --entry src/index.js --output dist/

Package Tests

huel test --all --verbose

NOTE

You have to stand in the root directory of your application, the same directory as your package.json for any of the commands to work.

Misc

Some helpful resources:

• Bundlephobia, find the cost of adding a npm package to your bundle

Contributing

Follows Conventional Commits.