管理webpack中的jQuery插件依赖项

时间:2015-03-10 17:06:15

标签: javascript jquery amd webpack

我在我的应用程序中使用Webpack,我在其中创建了两个入口点 - 所有JavaScript文件/代码的bundle.js,以及jQuery和React等所有库的vendors.js。我怎么做才能使用jQuery作为依赖项的插件,我想在vendors.js中也有它们?如果这些插件有多个依赖项怎么办?

目前我正在尝试使用此jQuery插件 - https://github.com/mbklein/jquery-elastic。 Webpack文档提到了providePlugin和imports-loader。我使用了providePlugin,但仍然没有jQuery对象。这是我的webpack.config.js的样子 -

var webpack = require('webpack');
var bower_dir = __dirname + '/bower_components';
var node_dir = __dirname + '/node_modules';
var lib_dir = __dirname + '/public/js/libs';

var config = {
    addVendor: function (name, path) {
        this.resolve.alias[name] = path;
        this.module.noParse.push(new RegExp(path));
    },
    plugins: [
        new webpack.ProvidePlugin({
            $: "jquery",
            jquery: "jQuery",
            "window.jQuery": "jquery"
        }),
        new webpack.optimize.CommonsChunkPlugin('vendors', 'vendors.js', Infinity)
    ],
    entry: {
        app: ['./public/js/main.js'],
        vendors: ['react','jquery']
    },
    resolve: {
        alias: {
            'jquery': node_dir + '/jquery/dist/jquery.js',
            'jquery.elastic': lib_dir + '/jquery.elastic.source.js'
        }
    },
    output: {
        path: './public/js',
        filename: 'bundle.js'
    },
    module: {
        loaders: [
            { test: /\.js$/, loader: 'jsx-loader' },
            { test: /\.jquery.elastic.js$/, loader: 'imports-loader' }
        ]
    }
};
config.addVendor('react', bower_dir + '/react/react.min.js');
config.addVendor('jquery', node_dir + '/jquery/dist/jquery.js');
config.addVendor('jquery.elastic', lib_dir +'/jquery.elastic.source.js');

module.exports = config;

但是尽管如此,它仍然在浏览器控制台中引发错误:

  

未捕获的ReferenceError:未定义jQuery

同样,当我使用imports-loader时,它会抛出错误,

  

require未定义'

在这一行:

var jQuery = require("jquery")

但是,当我不将它添加到我的vendors.js文件中时,我可以使用相同的插件,而是以普通的AMD方式使用它,因为我如何包含我的其他JavaScript代码文件,如 -

define(
[
    'jquery',
    'react',
    '../../common-functions',
    '../../libs/jquery.elastic.source'
],function($,React,commonFunctions){
    $("#myInput").elastic() //It works

});

但这不是我想要做的,因为这意味着jquery.elastic.source.js与我在bundle.js中的JavaScript代码捆绑在一起,我希望我的所有jQuery插件都在供应商中。 js捆绑。那么我该如何实现这个目标呢?

11 个答案:

答案 0 :(得分:715)

您已将不同的方法混合在一起,如何包含旧版供应商模块。这就是我解决问题的方法:

1。更喜欢未经明确的CommonJS / AMD超过dist

大多数模块会将dist版本链接到main的{​​{1}}字段中。虽然这对大多数开发人员都很有用,但对于webpack,最好为package.json版本添加别名,因为这样webpack可以更好地优化依赖关系(例如,在使用DedupePlugin时)。

src

但是,在大多数情况下,// webpack.config.js module.exports = { ... resolve: { alias: { jquery: "jquery/src/jquery" } } }; 版本的效果也很好。


2。使用dist注入隐式全局变量

大多数遗留模块依赖于特定全局变量的存在,例如ProvidePlugin$上的jQuery插件。在这种情况下,您可以配置webpack,以便在遇到全局jQuery标识符时添加var $ = require("jquery")

$

3。使用imports-loader配置var webpack = require("webpack"); ... plugins: [ new webpack.ProvidePlugin({ $: "jquery", jQuery: "jquery" }) ]

某些旧版模块依赖于this作为this对象。当模块在window等于this的CommonJS上下文中执行时,这就成了问题。在这种情况下,您可以使用imports-loader覆盖module.exports

运行this然后

npm i imports-loader --save-dev

imports-loader也可用于手动注入各种变量。但是大多数情况下module: { loaders: [ { test: /[\/\\]node_modules[\/\\]some-module[\/\\]index\.js$/, loader: "imports-loader?this=>window" } ] } 在隐式全局变量时更有用。


4。使用imports-loader禁用AMD

有些模块支持不同的模块样式,如AMD,CommonJS和legacy。但是,大多数情况下,他们首先检查ProvidePlugin,然后使用一些古怪的代码来导出属性。在这些情况下,通过设置define

可以帮助强制CommonJS路径
define = false

5。使用script-loader全局导入脚本

如果您不关心全局变量并且只想让遗留脚本工作,您也可以使用脚本加载器。它在全局上下文中执行模块,就像您通过module: { loaders: [ { test: /[\/\\]node_modules[\/\\]some-module[\/\\]index\.js$/, loader: "imports-loader?define=>false" } ] } 标记包含它们一样。


6。使用<script>包含大型dists

如果模块没有AMD / CommonJS版本且您想要包含noParse,则可以将此模块标记为dist。然后webpack将包含模块而不解析它,这可用于改善构建时间。这意味着任何需要AST的功能(如noParse)都无效。

ProvidePlugin

答案 1 :(得分:81)

对于jquery的全局访问,存在几个选项。在我最近的webpack项目中,我希望全局访问jquery,所以我在插件声明中添加了以下内容:

 plugins: [
    new webpack.ProvidePlugin({
      $: "jquery",
      jQuery: "jquery"
    })
  ]

这意味着可以通过全局引用$和jQuery从JavaScript源代码中访问jquery。

当然,您还需要通过npm安装jquery:

$ npm i jquery --save

有关此方法的工作示例,请随时在github

上分享我的应用

答案 2 :(得分:51)

我不知道我是否理解你想要做什么,但是我必须使用jQuery插件,这需要jQuery在全局上下文(窗口)中,并且我将以下内容放在我的{{1}中}:

entry.js

我只需要在var $ = require('jquery'); window.jQuery = $; window.$ = $; 的任何地方提出要求,jqueryplugin.min.js按预期扩展插件。

答案 3 :(得分:17)

我在使用Webpack 3.8.1及以下内容将$jQuery作为全局变量公开时,工作得很顺利。

将jQuery安装为项目依赖项。您可以省略@3.2.1来安装最新版本或指定其他版本。

npm install --save jquery@3.2.1

如果尚未安装,请安装expose-loader作为开发依赖项。

npm install expose-loader --save-dev

配置Webpack以便为我们加载和公开jQuery。

// webpack.config.js
const webpack = require('webpack')

module.exports = {
  entry: [
    // entry bits
  ],
  output: {
    // output bits
  },
  module: {
    rules: [
      // any other rules
      {
        // Exposes jQuery for use outside Webpack build
        test: require.resolve('jquery'),
        use: [{
          loader: 'expose-loader',
          options: 'jQuery'
        },{
          loader: 'expose-loader',
          options: '$'
        }]
      }
    ]
  },
  plugins: [
    // Provides jQuery for other JS bundled with Webpack
    new webpack.ProvidePlugin({
      $: 'jquery',
      jQuery: 'jquery'
    })
  ]
}

答案 4 :(得分:15)

将此添加到webpack.config.js

中的plugins数组中
new webpack.ProvidePlugin({
    'window.jQuery': 'jquery',
    'window.$': 'jquery',
})

然后通常需要jquery

require('jquery');

如果痛苦持续让其他脚本看到它,请尝试通过(在条目js中)明确地将它放在全局上下文中

window.$ = jQuery;

答案 5 :(得分:13)

在您的webpack.config.js文件中添加以下内容:

 var webpack = require("webpack");
 plugins: [
    new webpack.ProvidePlugin({
        $: "jquery",
        jQuery: "jquery"
    })
 ],

使用npm安装jQuery:

$ npm i jquery --save

在app.js文件中添加以下行:

import $ from 'jquery';
window.jQuery = $;
window.$ = $;

这对我有用。 :)

答案 6 :(得分:7)

这适用于 webpack 3:

在webpack.config.babel.js文件中:

resolve: {
    alias: {
         jquery: "jquery/src/jquery"
    },
 ....
}

并使用 ProvidePlugin

new webpack.ProvidePlugin({
        '$': 'jquery',
        'jQuery': 'jquery',
    })

答案 7 :(得分:7)

我尝试了一些提供的答案,但似乎都没有。然后我尝试了这个:

new webpack.ProvidePlugin({
    'window.jQuery'    : 'jquery',
    'window.$'         : 'jquery',
    'jQuery'           : 'jquery',
    '$'                : 'jquery'
});

无论我使用哪个版本

,似乎都能正常工作

答案 8 :(得分:2)

我发现的最佳解决方案是:

https://github.com/angular/angular-cli/issues/5139#issuecomment-283634059

基本上,你需要在typings.d.ts中包含一个虚拟变量,从&#39; jquery&#34;中删除任何&#34; import * as $;从您的代码中,然后手动将标签添加到您的SPA html的jQuery脚本。通过这种方式,webpack不会让您失望,并且您应该能够在所有脚本中访问相同的全局jQuery变量。

答案 9 :(得分:2)

这适用于webpack.config.js

    new webpack.ProvidePlugin({
        $: 'jquery',
        jQuery: 'jquery',
        'window.jQuery': 'jquery'
    }),

在另一个javascript或HTML中添加:

global.jQuery = require('jquery');

答案 10 :(得分:0)

编辑:有时您希望将webpack简单地用作简单Web项目的模块捆绑器 - 以保持您自己的代码组织。以下解决方案适用于那些只希望外部库在模块中按预期工作的人 - 而不需要花费大量时间深入到webpack设置中。 (在-1之后编辑)

快速简单(es6)解决方案,如果您仍在努力或想避免外部配置/额外的webpack插件配置:

<script src="cdn/jquery.js"></script>
<script src="cdn/underscore.js"></script>
<script src="etc.js"></script>
<script src="bundle.js"></script>

在模块内:

const { jQuery: $, Underscore: _, etc } = window;