Skip to content

Latest commit

 

History

History
156 lines (111 loc) · 4.87 KB

README.md

File metadata and controls

156 lines (111 loc) · 4.87 KB
Raw

🌏️ 🚀

Zero Configuration. Zero Dependencies. Fast AF

Mach is a super fast multi-threaded bundler written in Rust that puts an emphasis on
developer experience and the runtime performance of the compiled application.

Mach is heavily inspired by the Parcel bundler

Contributing Guidelines . Submit an Issue . Ask a Question . Blog

Installation

You can install Mach from npm or get the latest binary from the github releases

npm install @alshdavid/mach
npx mach version

Usage

$ mach build ./src/index.html
$ mach dev ./src/index.html #todo

Programmatic Usage

import { Mach } from '@alshdavid/mach'

// Create a Mach instance
const mach = new Mach()

// Build a target
const report = await mach.build({
  projectRoot: process.cwd(),
  outFolder: 'dist',
  entries: ['src/index.js']
})

Supported Types

Mach comes preconfigured with sensible defaults and does not need configuration. Mach ships with built-in support for the most common source files in web development.

  • TypeScript
  • JavaScript
  • JSX and TSX
  • CSS
  • HTML
  • Images (todo)

Plugins

Mach supports plugins that share the ideas and API of Parcel Plugins for cases where bundling must be customized.

Plugins can be written in:

JavaScript Plugins

Import the plugin API from the @alshdavid/mach npm package

import { Transformer } from '@alshdavid/mach'

Benchmark

Below is a build of the three-js source code multiplied 100 times and reexported from a single entry point. The benchmark was run on an M1 MacBook Pro with optimizations/minification turned off.

Mach is still under development and has lots of known opportunities for further build time improvements 🙂

Remaining work

The goal of Mach 1 will be a super fast production ready bundler with plugin support with some features remaining to be added (for instance - incremental bundling, or caching).

The order of these may change and some may be pushed back to Mach 2

🧩 Prerelease Flyer

  • Plugin support
  • Minification

🧩 Prerelease Red Baron

  • Source Maps

🧩 Prerelease Spitfire

  • Watch mode / Auto-recompilation
  • Development server
  • Hot reload

🧩 Prerelease Mustang

  • Bundle splitting (help wanted 🚩)

🧩 Prerelease Shooting Star

  • Incremental Bundling for Development

👀 Release Candidate X-1

  • TBD

🛩️ Mach 1 - Codenamed Concorde

  • TBD

Special Thanks

Mach is heavily inspired by Parcel. It derives learnings, approaches and adapts code directly from the project.
Check it out here

Special thanks to Atlassian for supporting my independent development of this project during my employment with them.
Learn about Atlassian

Special thanks to the Rust Community Discord, an amazing community of talented engineers who were
welcoming and always happy to help out.
Join the Discord Here