Hammer
Build Tool for Browser and Node Applications
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
Task
Hammer provides support for running tasks. To use, create a hammer.ts file in the project root. Any exported function can be run from the command line interface.
export function print(message: string) {
console.log(message)
}
$ hammer task print "Hello World"
You can use tasks to run Hammer or other command line applications in parallel. The following starts serve and run processes in parallel.
import { shell } from '@sinclair/hammer'
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 build <file or folder> <...options>
$ hammer watch <file or folder> <...options>
$ hammer serve <file or folder> <...options>
$ hammer run <script> <...options>
$ 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.
