webpack / core Goto Github PK

View Code? Open in Web Editor NEW

26.0 26.0 26.0 82 KB

[OBSOLETE in webpack 2] The core of webpack and enhanced-require...

JavaScript 100.00%

core's Introduction

webpack

Webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset.

Install
Introduction
Concepts
Contributing
Support
Core Team
Sponsoring
Premium Partners
Other Backers and Sponsors
Gold Sponsors
Silver Sponsors
Bronze Sponsors
Backers
Special Thanks

Install

Install with npm:

npm install --save-dev webpack

Install with yarn:

yarn add webpack --dev

Introduction

Webpack is a bundler for modules. The main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset.

TL;DR

Bundles ES Modules, CommonJS, and AMD modules (even combined).
Can create a single bundle or multiple chunks that are asynchronously loaded at runtime (to reduce initial loading time).
Dependencies are resolved during compilation, reducing the runtime size.
Loaders can preprocess files while compiling, e.g. TypeScript to JavaScript, Handlebars strings to compiled functions, images to Base64, etc.
Highly modular plugin system to do whatever else your application requires.

Get Started

Check out webpack's quick Get Started guide and the other guides.

Browser Compatibility

Webpack supports all browsers that are ES5-compliant (IE8 and below are not supported). Webpack also needs Promise for import() and require.ensure(). If you want to support older browsers, you will need to load a polyfill before using these expressions.

Concepts

Plugins

Webpack has a rich plugin interface. Most of the features within webpack itself use this plugin interface. This makes webpack very flexible.

Name	Status	Install Size	Description
mini-css-extract-plugin			Extracts CSS into separate files. It creates a CSS file per JS file which contains CSS.
compression-webpack-plugin			Prepares compressed versions of assets to serve them with Content-Encoding
html-webpack-plugin			Simplifies creation of HTML files (`index.html`) to serve your bundles
pug-plugin			Renders Pug files to HTML, extracts JS and CSS from sources specified directly in Pug.

Loaders

Webpack enables the use of loaders to preprocess files. This allows you to bundle any static resource way beyond JavaScript. You can easily write your own loaders using Node.js.

Loaders are activated by using loadername! prefixes in require() statements, or are automatically applied via regex from your webpack configuration.

Files

Name	Status	Install Size	Description
val-loader			Executes code as module and considers exports as JS code

JSON

Name	Status	Install Size	Description
			Loads and transpiles a CSON file

Transpiling

Name	Status	Install Size	Description
			Loads ES2015+ code and transpiles to ES5 using Babel
			Loads TypeScript like JavaScript
			Loads CoffeeScript like JavaScript

Templating

Name	Status	Install Size	Description
			Exports HTML as string, requires references to static resources
			Loads Pug templates and returns a function
			Compiles Pug to a function or HTML string, useful for use with Vue, React, Angular
			Compiles Markdown to HTML
			Loads and transforms a HTML file using PostHTML
			Compiles Handlebars to HTML

Styling

Name	Status	Install Size	Description
`<style>`			Add exports of a module as style to DOM
			Loads CSS file with resolved imports and returns CSS code
			Loads and compiles a LESS file
			Loads and compiles a Sass/SCSS file
			Loads and compiles a Stylus file
			Loads and transforms a CSS/SSS file using PostCSS

Frameworks

Name	Status	Install Size	Description
			Loads and compiles Vue Components
			Process HTML & CSS with preprocessor of choice and `require()` Web Components like first-class modules
			Loads and compiles Angular 2 Components
			Riot official webpack loader
			Official Svelte loader

Performance

Webpack uses async I/O and has multiple caching levels. This makes webpack fast and incredibly fast on incremental compilations.

Module Formats

Webpack supports ES2015+, CommonJS and AMD modules out of the box. It performs clever static analysis on the AST of your code. It even has an evaluation engine to evaluate simple expressions. This allows you to support most existing libraries out of the box.

Code Splitting

Webpack allows you to split your codebase into multiple chunks. Chunks are loaded asynchronously at runtime. This reduces the initial loading time.

Optimizations

Webpack can do many optimizations to reduce the output size of your JavaScript by deduplicating frequently used modules, minifying, and giving you full control of what is loaded initially and what is loaded at runtime through code splitting. It can also make your code chunks cache friendly by using hashes.

Contributing

We want contributing to webpack to be fun, enjoyable, and educational for anyone, and everyone. We have a vibrant ecosystem that spans beyond this single repo. We welcome you to check out any of the repositories in our organization or webpack-contrib organization which houses all of our loaders and plugins.

Contributions go far beyond pull requests and commits. Although we love giving you the opportunity to put your stamp on webpack, we also are thrilled to receive a variety of other contributions including:

Documentation updates, enhancements, designs, or bugfixes
Spelling or grammar fixes
README.md corrections or redesigns
Adding unit, or functional tests
Triaging GitHub issues -- especially determining whether an issue still persists or is reproducible.
Searching #webpack on twitter and helping someone else who needs help
Teaching others how to contribute to one of the many webpack's repos!
Blogging, speaking about, or creating tutorials about one of webpack's many features.
Helping others in our webpack gitter channel.

To get started have a look at our documentation on contributing.

If you are worried or don't know where to start, you can always reach out to Sean Larkin (@TheLarkInn) on Twitter or simply submit an issue and a maintainer can help give you guidance!

We have also started a series on our Medium Publication called The Contributor's Guide to webpack. We welcome you to read it and post any questions or responses if you still need help.

Looking to speak about webpack? We'd love to review your talk abstract/CFP! You can email it to webpack [at] opencollective [dot] com and we can give pointers or tips!!!

Creating your own plugins and loaders

If you create a loader or plugin, we would <3 for you to open source it, and put it on npm. We follow the x-loader, x-webpack-plugin naming convention.

Support

We consider webpack to be a low-level tool used not only individually but also layered beneath other awesome tools. Because of its flexibility, webpack isn't always the easiest entry-level solution, however we do believe it is the most powerful. That said, we're always looking for ways to improve and simplify the tool without compromising functionality. If you have any ideas on ways to accomplish this, we're all ears!

If you're just getting started, take a look at our new docs and concepts page. This has a high level overview that is great for beginners!!

Looking for webpack 1 docs? Please check out the old wiki, but note that this deprecated version is no longer supported.

If you want to discuss something or just need help, here is our Gitter room where there are always individuals looking to help out!

If you are still having difficulty, we would love for you to post a question to StackOverflow with the webpack tag. It is much easier to answer questions that include your webpack.config.js and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

If you are twitter savvy you can tweet #webpack with your question and someone should be able to reach out and help also.

If you have discovered a 🐜 or have a feature suggestion, feel free to create an issue on GitHub.

License

Core Team

Tobias Koppers

Core

Founder of webpack

Johannes Ewald

Loaders & Plugins

Early adopter of webpack

Sean T. Larkin

Public Relations

Founder of the core team

Kees Kluskens

Development

Sponsor

Sponsoring

Most of the core team members, webpack contributors and contributors in the ecosystem do this open source work in their free time. If you use webpack for a serious task, and you'd like us to invest more time on it, please donate. This project increases your income/productivity too. It makes development and applications faster and it reduces the required bandwidth.

This is how we use the donations:

Allow the core team to work on webpack
Thank contributors if they invested a large amount of time in contributing
Support projects in the ecosystem that are of great value for users
Support projects that are voted most (work in progress)
Infrastructure cost
Fees for money handling

Premium Partners

Other Backers and Sponsors

Before we started using OpenCollective, donations were made anonymously. Now that we have made the switch, we would like to acknowledge these sponsors (and the ones who continue to donate using OpenCollective). If we've missed someone, please send us a PR, and we'll add you to this list.

Gold Sponsors

Become a gold sponsor and get your logo on our README on GitHub with a link to your site.

Silver Sponsors

Become a silver sponsor and get your logo on our README on GitHub with a link to your site.

Bronze Sponsors

Become a bronze sponsor and get your logo on our README on GitHub with a link to your site.

Backers

Become a backer and get your image on our README on GitHub with a link to your site.

Special Thanks to

(In chronological order)

@google for Google Web Toolkit (GWT), which aims to compile Java to JavaScript. It features a similar Code Splitting as webpack.
@medikoo for modules-webmake, which is a similar project. webpack was born because I wanted Code Splitting for modules-webmake. Interestingly the Code Splitting issue is still open (thanks also to @Phoscur for the discussion).
@substack for browserify, which is a similar project and source for many ideas.
@jrburke for require.js, which is a similar project and source for many ideas.
@defunctzombie for the browser-field spec, which makes modules available for node.js, browserify and webpack.
Every early webpack user, which contributed to webpack by writing issues or PRs. You influenced the direction...
@shama, @jhnns and @sokra for maintaining this project
Everyone who has written a loader for webpack. You are the ecosystem...
Everyone I forgot to mention here, but also influenced webpack.

core's People

Stargazers

Watchers

core's Issues

Loader query function, regex, and object, support

Currently, the loader query only supports strings, and when you pass it an actual object, it applies stringify to it, and prevents the ability to pass a function, which may be desirable if you wish to pass a custom minification function, or a regex to your loader.

Query to json string in /lib/LoadersList.js#L52-L61

function getLoadersFromObject(element) {
    if(element.query) {
        if(!element.loader || element.loader.indexOf("!") >= 0) throw new Error("Cannot define 'query' and multiple loaders in loaders list");
        if(typeof element.query === "string") return [element.loader + "?" + element.query];
        return [element.loader + "?" + JSON.stringify(element.query)];
    }
    if(element.loader) return element.loader.split("!");
    if(element.loaders) return element.loaders;
    throw new Error("Element from loaders list should have one of the fields 'loader' or 'loaders'");
}

jade-locals interpretting query: webpack/jade-loader/index.js#L9-L20

module.exports = function(source) {
    this.cacheable && this.cacheable();
    var jade = require("jade");

    var utils = require("jade/lib/utils");
    var nodes = require("jade/lib/nodes");
    var filters = require("jade/lib/filters");

    var req = loaderUtils.getRemainingRequest(this).replace(/^!/, "");

    var query = loaderUtils.parseQuery(this.query);

It is especially relevant for my current project where we need to pass in a localization function (convert keys to text) into the jade-loader locals object.

I feel this can be addressed by allowing element.query to be either an object or a string.

Maybe there is a way to work around this by allowing the list of loaders to be objects of the modules themselves, as described in webpack/How to register a custom loader in webpack.config #903 or where is apply-loader to use with jade-loader #940

Add support for aliases regex matching

Hi again!
I hope to not be too spammy, but I'll try to report all the issues I find along the way ;)

Right now I'm using an alias to resolve a package name,
but the test regex doesn't tries to match the defined aliases.

Current way of doing it:

 resolve: {
      alias: {
        angular: 'angular/angular'
      }
    },
    module: {
      loaders: [{ test: /angular\/angular/, loader: 'exports?angular'}]
    }

Easier and less verbose way supporting alias names:

    module: {
      loaders: [{ test: /^angular$/, loader: 'exports?angular'}]
    }

Or even better, defaulting a test: String parameter to alias matching:

    module: {
      loaders: [{ test: 'angular', loader: 'exports?angular'}]
    }

What do you think?

It is impossible to check context in loader's include function

When I use include: function(path){} parameter for loader, it is impossible to check context (file which requires this path).
Example:

    loaders: [
      {
        test: /.svg/,
        include: function(path) {
          //I want to check context here, but it is impossible
          console.log('path', path)
        },
        loader: 'svgo'
      }
   ]

Error: Webpack compiling

I've got an error on webpack comilation indutny/elliptic#109

Case:

git clone https://github.com/PeculiarVentures/webcrypto-liner.git -b es6
npm install

A plugin breaks builds in webpack core in webpack 1.13.1

Cross-posted from mrsum/webpack-svgstore-plugin#95 as I don't know whose problem it is.

tl;dr Having plugin enabled breaks webpack builds somwhere in webpack-core/lib/ConcatSource.js

> npm install --save-dev webpack

This installs webpack 1.13.1

Given the following webpack.config:

var SvgStore = require('webpack-svgstore-plugin');

var config = {
    entry:   {
        app: [
            '/soma-file.js'
        ],
        lib: [
            'lodash'
        ]
    },
    output:  {
        path:              '/path',
        filename:          filename
    },
    module:  {
        loaders: [
            {
                test:   /\.js$/,
                loader: 'babel',
                query:  {
                    presets: ['es2015', 'stage-0', 'react'],
                    compact: false
                }
            },
            {
                test:   /\.json$/,
                loader: 'json'
            }
        ]
    },
    plugins: [
        new SvgStore(path.join('./img/svg', '', '**!/!*.svg'), path.join('./', ''), {
            name:        '[hash].sprite.svg',
            chunk:       'app',
            prefix:      'pref-',
            baseUrl:     '/my-url',
            svgoOptions: {}
        }),
        new webpack.optimize.CommonsChunkPlugin("lib", "lib.js", Infinity)
    ],
    bail:    false,
    target:  'web'
};

Trying to run this results in:

/node_modules/webpack-core/lib/ConcatSource.js:24
        return typeof item === "string" ? item : item.source();
                                                     ^

TypeError: Cannot read property 'source' of undefined
    at /node_modules/webpack-core/lib/ConcatSource.js:24:48
    at Array.map (native)
    at ConcatSource.source (/node_modules/webpack-core/lib/ConcatSource.js:23:23)
    at Compiler.writeOut (/node_modules/webpack/lib/Compiler.js:256:26)
    at Compiler.<anonymous> (/node_modules/webpack/lib/Compiler.js:246:20)
    at /node_modules/async/lib/async.js:181:20
    at Object.async.forEachOf.async.eachOf (/node_modules/async/lib/async.js:233:13)
    at Object.async.forEach.async.each (/node_modules/async/lib/async.js:209:22)
    at Compiler.emitFiles (/node_modules/webpack/lib/Compiler.js:235:20)
    at /node_modules/mkdirp/index.js:48:26
    at FSReqWrap.oncomplete (fs.js:82:15)

ModuleBuildError: Module build failed: TypeError: Cannot read property 'columns' of undefined

I'm just creating this for other people to not slip up when they upgrade. This issue actually prevented me from upgrading for a while until I finally had a second to look at what was going on and it turned out to be quite simple. If you're getting this error, it is quite possibly because you have a loader that is using an OriginalSource object and calling node() without any options.

Previously, options was not used by the node function so this worked fine, but now it is being used.

So, I had a custom loader that did this:

// ... code

var origMap = this.sourceMap ? new OriginalSource(source, identifier, map) : null;

var globalPrefix = '@import "~global";\n'; // <-- note, do not do this... I'm paying for it now... #knowyourdependencies
source = globalPrefix + source;
if (origMap) {
  origMap.node().prepend(globalPrefix);
}

// ... code

I needed to change it to this:

// ... code

var origMap = this.sourceMap ? new OriginalSource(source, identifier, map) : null;

var globalPrefix = '@import "~global";\n'; // <-- note, do not do this... I'm paying for it now... #knowyourdependencies
source = globalPrefix + source;
if (origMap) {
  origMap.node({}).prepend(globalPrefix); // <-- note the empty object being passed to the `node` function
}

// ... code

Perhaps webpack-core should default the options to be an empty object, but either way, this fixes the issue.

Typescript 1.6 es6 with Decorator, Babel, SourceMap, throwing Exception

I'm using [email protected] configured to output ES6 and sourcemaps, outside of webpack.
Then using [email protected] with [email protected] preloader, and [email protected] loader.
If original TS source contains a Decorator, the following exception is thrown

c:\src\webpack\node_modules\webpack-core\lib\NormalModuleMixin.js:163
if(isError) throw e;
^

Error: No element indexed by 1
at ArraySet_at as at
at SourceMapConsumer. (c:\src\webpack\node_modules\webpack-core\node_modules\source-map\lib\source-map\source-map-consumer.js:147:69)
at Array.map (native)
at SourceMapConsumer_eachMapping as eachMapping
at Function.SourceNode_fromStringWithSourceMap as fromStringWithSourceMap
at SourceMapSource.node (c:\src\webpack\node_modules\webpack-core\lib\SourceMapSource.js:41:20)
at ReplaceSource.node (c:\src\webpack\node_modules\webpack-core\lib\ReplaceSource.js:55:29)
at CachedSource.node (c:\src\webpack\node_modules\webpack-core\lib\CachedSource.js:41:22)
at PrefixSource.node (c:\src\webpack\node_modules\webpack-core\lib\PrefixSource.js:27:26)
at c:\src\webpack\node_modules\webpack-core\lib\ConcatSource.js:38:49

If the babel-loader is disabled (simply by changing test pattern to non matching regex), no exceptions are thrown and output is as expected.

If the Decorator call is disabled (simply by removing the '@' before the call), no exceptions are thrown and output is as expected.

To Reproduce:

tsconfig.json

{
    "compilerOptions": {
        "target": "es6",
        "module": "commonjs",
        "sourceMap": true,
        "experimentalDecorators": true
    },
    "exclude": [
        "node_modules"
    ]
}

webpack.config.js

module.exports = {
    entry: [
        './decoratorChoking.js'
    ],
    devtool: 'source-map',
    output: {
        path: path.join(__dirname, '/'),
        filename: 'app.js'
    },
    module: {
        preLoaders: [{
            test: /\.js$/,
            loader: 'source-map-loader'
        }],
        loaders: [{
            test: /\.js$/,
            loader: 'babel',
            exclude: /node_modules/
        }]
    }
}

decoratorChoking.ts

function ChokingDecorator() {
    function(target: Function) {
    }
}

@ChokingDecorator
class Plain {}

It appears either source-map-loader, babel-loader, or webpack-core is generating a SourceMapSource object where its sourceMap.sources property contains 1 element set to "decoratorChoking.ts", but the sourceMap.sourcesContent contains 2 elements. The 1st element is the TypeScript transpiled Javascript; i.e. the contents of decoratorChoking.js, and the 2nd the original TypeScript source; i.e. the contents of decoratorChoking.ts. This is the cause of the above exception, although not the root cause of course.

Simply removing the @ symbol in front of @ChokingDecorator within decoratorChoking.ts results in a SourceMapSource object having only one element in sourceMap.sourcesContent, it being the contents of the original TypeScript file decoratorChoking.ts. This does not cause an exception to be thrown.

Kindest regards in helping locate and resolve this bug please.

Error: Element from loaders list should have one of the fields 'loader' or 'loaders'

Got the error message below, when doing babel-node tools/distServer.js (open-src)

Error: Element from loaders list should have one of the fields 'loader' or 'loaders'
at getLoadersFromObject (C:\Repo\vcm-spa\app\node_modules\webpack-core\lib\LoadersList.js:60:8)
at LoadersList. (C:\Repo\vcm-spa\app\node_modules\webpack-core\lib\LoadersList.js:78:12)
at Array.map (native)
at LoadersList.match (C:\Repo\vcm-spa\app\node_modules\webpack-core\lib\LoadersList.js:70:19)
at C:\Repo\vcm-spa\app\node_modules\webpack\lib\NormalModuleFactory.js:111:68
at C:\Repo\vcm-spa\app\node_modules\async\lib\async.js:726:13
at C:\Repo\vcm-spa\app\node_modules\async\lib\async.js:52:16
at done (C:\Repo\vcm-spa\app\node_modules\async\lib\async.js:246:17)
at C:\Repo\vcm-spa\app\node_modules\async\lib\async.js:44:16
at C:\Repo\vcm-spa\app\node_modules\async\lib\async.js:723:17
ERROR: "open-src" exited with 1.

Source file of srcServer.js

// This file configures the development web server
// which supports hot reloading and synchronized testing.

// Require Browsersync along with webpack and middleware for it
import browserSync from 'browser-sync';
// Required for react-router browserHistory
// see https://github.com/BrowserSync/browser-sync/issues/204#issuecomment-102623643
import historyApiFallback from 'connect-history-api-fallback';
import webpack from 'webpack';
import webpackDevMiddleware from 'webpack-dev-middleware';
import webpackHotMiddleware from 'webpack-hot-middleware';
import config from '../webpack.config.dev';

const bundler = webpack(config);

// Run Browsersync and use middleware for Hot Module Replacement
browserSync({
  server: {
    baseDir: 'src',
    middleware: [
      webpackDevMiddleware(bundler, {
        // Dev middleware can't access config, so we provide publicPath
        publicPath: config.output.publicPath,

        // pretty colored output
        stats: { colors: true },

        // Set to false to display a list of each file that is being bundled.
        noInfo: true,
        quiet:true
        // for other settings see
        // http://webpack.github.io/docs/webpack-dev-middleware.html
      }),
      // bundler should be the same as above
      webpackHotMiddleware(bundler),
      historyApiFallback()
    ]
  },

  // no need to watch '*.js' here, webpack will take care of it for us,
  // including full page reloads if HMR won't work
  files: [
    'src/*.html'
  ]
});

Structured objects in the loader list

Currently to specify a loader you can write:

loaders: [
  { test: /\.js$/, loader: 'babel', query: {stage: 0, optional: ['runtime']} }
]

but this does not support multiple loaders. For that, only the string syntax is supported: react-hot!babel?stage=0&optional[]=runtime. I would like to be able to use the object literal syntax to specify multiple loaders with query parameters:

loaders: [
  {
    test: /\.js$/,
    loaders: [
      { loader: 'react-hot' },  // or just 'react-hot', using the string syntax as shorthand
      { loader: 'babel',  query: {stage: 0, optional: ['runtime'] }
    ]
  }
]

Loaders query is not working as expected

Hi!

This may be a documentation problem, but I'm having problems with the following code in the webpack configuration:

This works:

loaders: [{ test: /^angular$/, loader: 'exports?angular'}],

But this doesn't work:

loaders: [{ test: /^angular$/, loader: 'exports', query: {angular: true}}],

Neither this does:

loaders: [{ test: /^angular$/, loader: 'exports', query: 'angular'}],

Thank you!