@theholocron/webpack-config NPM

Webpack Config

A Webpack configuration for developing and bundling libraries locally within the Galaxy.

Installation

npm install --save-dev @theholocron/webpack-config

Usage

In Storybook:

// your app's webpack.config.js
const custom = require('@theholocron/webpack-config');

module.exports = async ({ config, mode }) => {
    return { 
        ...config, 
        module: { 
            ...config.module, 
            rules: custom.module.rules 
        } 
    };
};

In an application:

const common = require('@theholocron/webpack-config');
const webpack = require('webpack');
const WriteFilePlugin = require('write-file-webpack-plugin');

module.exports = Object.assign(
    {},
    common,
    {
        devServer: {
            port: 3000,
        },
        mode: 'development',
        externals: [{
            window: 'window',
        }],
        plugins: common.plugins.concat(
            new WriteFilePlugin(),
            new webpack.DefinePlugin({
                'process.env.NODE_ENV': JSON.stringify('development'),
            }),
        ),
    },
);

How We Configure Bundles

Currently, this configuration is to provide a custom Webpack setup for Storybook. Within it we use:

babel-loader to transpile our JS.
raw-loader to handle Markdown for importing our documentation.
style-loader, css-loader, postcss-loader and sass-loader to use dart-sass for SCSS transpilation.

Our postcss-config is added to use autoprefixer and postcss-flexbugs-fixes.

How We Track Changes

This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.

How We Version

We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes.
MINOR version when you add functionality in a backward-compatible manner.
PATCH version when you make backward-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

How to Contribute

Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below: