Table of contents

• Overview
• Installation
• Usage
• API
  • compile
  • watch

Overview

Standalone webpack compile/watch API for @component-controls.

Installation

$ npm install @component-controls/webpack-compile --save-dev

Usage

import { compile } from '@component-controls/webpack-compile';
...
const { store } = await compile({
  presets: ['react', 'react-docgen-typescript'],
  configPath: path.resolve(__dirname, 'fixtures', 'examples'),
});

API

compile

async function

compile the stories with webpack returns the stories store object

defined in @component-controls/webpack-compile/core/webpack-compile/src/index.ts

parameters

| Name | Type | Description | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | anonymous* | BuildPropswebpack: Configuration | WebpackConfigFnfinalWebpack: Configuration | WebpackConfigFnpresets: RuleType[]configPath: stringdistFolder: stringbundleName: stringstaticFolder: stringcssFileName: stringlogOptions: Partial<LogOptions>mode: "none" | "development" | "production"loadersencodeHTML*: encodeHTMLat*: function (index*: ) => T | undefinedmodule: stringident: stringloader: stringoptions: string | type | configuration properties for compile and run | | callback | function (results*bundleName*: stats*: store*: ) => void | Promise | callback function to monitor new documents/deleted documents | | returns | Promise<CompileResults> | |

watch

async function

compile the stories with webpack and launch watching for changes returns the stories store object

defined in @component-controls/webpack-compile/core/webpack-compile/src/index.ts

parameters

| Name | Type | Description | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | anonymous* | WatchPropswatchOptionsaggregateTimeout: numberfollowSymlinks: booleanignored: string | RegExp | string[]poll: number | booleanstdin: booleanwebpack: Configuration | WebpackConfigFnfinalWebpack: Configuration | WebpackConfigFnpresets: RuleType[]configPath: stringdistFolder: stringbundleName: stringstaticFolder: stringcssFileName: stringlogOptions: Partial<LogOptions>mode: "none" | "development" | "production"loadersencodeHTML*: encodeHTMLat*: function (index*: ) => T | undefinedmodule: string | adds webpack WatchOptions to the Compiler options | | callback | function (results*bundleName*: stats*: store*: ) => void | Promise | callback function to monitor new documents/deleted documents | | returns | Promise<CompileResults> | |