connor-baer / package-template

📋 A template for JS packages with my common tooling

package-template

JS package template repository

• Installation
• Getting started
• Getting the smallest possible bundle size
• Changelog

---

package-template is a template repository for my JavaScript modules.

Some standout features include...

All this clocks in at around ⚡ kB gzipped.

⚠️ Requires Node >= 8.0.0.

Installation

Install @madebyconnor/package-template with your favorite package manager.

# yarn
yarn add @madebyconnor/package-template
# npm
npm i @madebyconnor/package-template

Getting started

@madebyconnor/package-template exports a function

import { sayHello } from '@madebyconnor/package-template';

sayHello('Tessa');

/*
    returns:

    Hello Tessa
 */

Getting the smallest possible bundle size

Many development conveniences are placed behind process.env.NODE_ENV !== "production" conditionals. When bundling your app, it's a good idea to replace these code snippets such that a minifier (like uglify) can sweep them away and leave a smaller overall bundle.

Here are instructions for some of the popular bundlers:

• webpack
• browserify plugin
• parcel
• fuse-box

Changelog

See GitHub Releases.