Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

paeckchen/paeckchen

Repository files navigation

paeckchen

license commitizen

Rationale

TL;DR paeckchen (german for small parcel) is an incremental, fast and efficient JavaScript module bundler doing one thing well.

Most JavaScript module bundlers do a lot of things – being plugin pipelines, fulfilling development setup wishes, being development servers and so on. This breadth of features inevitably comes with tradeoffs.

paeckchen on the other hand is designed to do exactly one thing: It bundles your JavaScript modules. This focus allows paeckchen to do its job fast and efficiently.

packages

paeckchen is developed in multiple repositories; This repository is the main entry point and documentation for paeckchen.

Package Version Dependencies
paeckchen-core npm dep
paeckchen-cli npm dep
gulp-paeckchen npm dep

Installation

Grab paeckchen via npm:

npm install paeckchen-cli

Usage

./node_modules/.bin/paeckchen --entry <path/to/your/entrypoint>

API documentation

stay tuned

Features

  • ES2015 module support
  • CommonJS module support
  • Basic support for jsnext:main field | Reference
  • Basic support for browser field | Reference
  • Incremental bundling
  • Watch mode
  • SourceMaps
  • Development Cache

See Roadmap for upcoming stuff.


Development

If you want to compile the source yourself, here are the instructions.
Remember that paeckchen lives in a monorepository, that means a simple npm install does not work and will break the setup.

git clone https://github.com/paeckchen/paeckchen.git
cd paeckchen
npm run bootstrap
npm test

Development of a specific package of paeckchen will be more easy with running two watch tasks for that package.

cd packages/paeckchen-core
# in terminal one
npm run build:watch
# in terminal two
npm run test:watch

Contributions

See contribution guide


paeckchen is built by KnisterPeter and contributors and released under the MIT license.