webpack-dll-bundles-plugin

  • Version 1.0.0-beta.5
  • Published
  • 2 dependencies
  • MIT license

Install

npm i webpack-dll-bundles-plugin
yarn add webpack-dll-bundles-plugin
pnpm add webpack-dll-bundles-plugin

Overview

A Webpack plugin for bundling group of packages as DLLs

Index

Classes

class DllBundlesPlugin

class DllBundlesPlugin {}

    constructor

    constructor(options: DllBundlesPluginOptions);

      method apply

      apply: (compiler: any) => void;

        method resolveFile

        static resolveFile: (bundleName: string) => string;

          method run

          run: (next: (err?: Error) => any) => void;

            Interfaces

            interface DllBundleConfig

            interface DllBundleConfig {}

              property name

              name: string;

                property packages

                packages: Array<string | DllPackageConfig>;

                  interface DllBundlesPluginOptions

                  interface DllBundlesPluginOptions {}

                    property bundles

                    bundles: {
                    [key: string]: Array<string | DllPackageConfig>;
                    };

                      property context

                      context?: string;
                      • The context for the plugin.

                        Used as context for internal plugins, e.g: DllReferencePlugin Used as context for dllDir (if relative)

                        process.cwd()

                      property dllDir

                      dllDir: string;
                      • The directory to store bundles and metadata it.

                        If not absolute context is process.cwd()

                      property ignorePackageError

                      ignorePackageError?: boolean;
                      • If true will ignore any errors resulted from package resolution. Such errors can be name mismatch, packages not found, package.json not found etc...

                        Error resolution errors does not mean a bundle can not build, if the package exists it will build. These errors mean that there was no exact match so the build state is not known and as a result the next check will result in a rebuild. If a package error is not fixed it essentially means that the bundle will build every time, no caching.

                        When using node modules as packages in the bundle this should be left FALSE. When using a path to a file/directory that is part of the project or does not have package.json file next to it then you should set this value to TRUE. (read comment below)

                        > Having files within the project as packages inside a DLL bundle is possible but not recommended. It is difficult to detect changes in the tree created by the file so DllBundlesPlugin will ignore it making it appear as "changed" for every check for updates in the bundle hence re-building the DLL bundle every time. Using the plugin with such behaviour makes no sense, make sure to add a "package.json" file next to the file you reference as well as update it's version on every change.

                        > While setting ignorePackageError to TRUE will not throw if a package was not found Webpack will.

                        false

                      property webpackConfig

                      webpackConfig: string | any;
                      • Webpack configuration object. Can be a path, an config object or a config object factory

                        If the path (string) is relative, resolved using the context option.

                      Package Files (3)

                      Dependencies (2)

                      Dev Dependencies (3)

                      Peer Dependencies (0)

                      No peer dependencies.

                      Badge

                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/webpack-dll-bundles-plugin.

                      • Markdown
                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/webpack-dll-bundles-plugin)
                      • HTML
                        <a href="https://www.jsdocs.io/package/webpack-dll-bundles-plugin"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>