Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
doc
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Hammer

Build Tool for Browser and Node Applications

npm version

Install

$ npm install @sinclair/hammer -g

Usage

Create an index.html file

<!DOCTYPE html>
<html>
  <head>
    <link href="index.css" rel="stylesheet" />
    <script src="index.tsx"></script>
  </head>
  <body>
    <img src="banner.png" />
  </body>
</html>

Run Hammer

$ hammer build index.html

Done

Overview

Hammer is a build tool for browser and node applications. It offers a command line interface to instantly run browser and node applications and provides appropriate watch and reload workflows for each. It is designed with rapid application development in mind and requires little to no configuration to use.

Hammer was written to consolidate several disparate tools related to monitoring node processes (nodemon), building from HTML (parcel), mono repository support (lerna, nx) and project automation (gulp, grunt). It takes esbuild as its only dependency and is as much concerned with build performance as it is with dramatically reducing the number of development dependencies required for modern web application development.

License MIT

Serve

Use the serve command to start a development server that reloads on save.

<!DOCTYPE html>
<html>
  <head>
    <script src="index.tsx"></script>
  </head>
  <body>
    <h1>Hello World</h1>
  </body>
</html>
$ hammer serve index.html

Run

Use the run command to start node scripts that reload on save.

$ hammer run index.ts

$ hammer run "index.ts arg1 arg2" # use quotes to pass arguments

Watch

Use the watch command to start a compiler watch process only.

$ hammer watch worker.ts

Monitor

Use the monitor command to execute shell commands on file change.

$ hammer monitor fib.ts "asc fib.ts --binaryFile fib.wasm --optimize"

Task

Use the task command to execute javascript functions in a file named hammer.task.ts or hammer.task.js. Hammer will look for this file in the current working directory and will allow any exported function to be called though the CLI. You can use tasks to run shell commands in parallel. Hammer includes a built in shell() function for this purpose. The following runs a run and serve task in parallel.

/**
 * file: hammer.task.js
 */

export async function start(dist = 'target') {
    await shell([
        `hammer serve apps/website/index.html --dist ${dist}/website`,
        `hammer run apps/server/index.ts --dist ${dist}/server`
    ])
}
$ hammer task start

Libs

In mono repository projects, you can import shared libraries by using TypeScript tsconfig.json path aliasing.

/apps
  /server
    index.ts    ───────────┐
  /website                 │
    index.html             │
    index.ts    ───────────┤ depends on
/libs                      │
  /shared                  │
    index.ts    <──────────┘
tsconfig.json

To enable website and server to import the shared library. Configure tsconfig.json in the project root as follows.

{
    "compilerOptions": {
        "baseUrl": ".",
        "paths": {
            "@libs/shared": ["libs/shared/index.ts"],
        }
    }
}

Once configured the server and website applications can import with the following.

import { Foo } from '@libs/shared'

Cli

Hammer provides the following command line interface.

Commands:
   $ hammer run     <entry script>   <...options>
   $ hammer build   <file or folder> <...options>
   $ hammer watch   <file or folder> <...options>
   $ hammer serve   <file or folder> <...options>
   $ hammer monitor <file or folder> <shell command>
   $ hammer task    <task>           <...arguments>
   $ hammer version
   $ hammer help

Options:

   --target      targets     The es build targets.
   --platform    platform    The target platform.
   --dist        directory   The target directory.
   --port        port        The port to listen on.
   --minify                  Minifies the output.
   --sourcemap               Generate sourcemaps.

About

Build Tool for Browser and Node Applications

Topics

Resources

License

Releases

No releases published

Packages

No packages published

Languages