在 webpack 中管理 jQuery 插件依赖

IT技术 javascript jquery amd webpack
2021-01-30 12:41:17

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

目前我正在尝试在这里使用这个 jQuery 插件 - https://github.com/mbklein/jquery-elasticWebpack 文档中提到了providePlugin和 import-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

同样,当我使用导入加载器时,它会抛出一个错误,

要求未定义'

在这一行:

var jQuery = require("jquery")

但是,当我不将它添加到我的 vendor.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 插件都在 vendor.js 捆绑包中。那么我该如何实现这一目标呢?

6个回答

您已经混合了如何包含遗留供应商module的不同方法。这就是我解决它的方式:

1. 更喜欢未缩小的 CommonJS/AMD dist

大多数moduledistmainpackage.json. 虽然这对大多数开发人员很有用,但对于 webpack 最好为src版本设置别名,因为这样 webpack 能够更好地优化依赖项(例如,在使用 时DedupePlugin)。

// webpack.config.js

module.exports = {
    ...
    resolve: {
        alias: {
            jquery: "jquery/src/jquery"
        }
    }
};

但是,在大多数情况下,该dist版本也能正常工作。


2. 使用ProvidePlugin注入隐式全局变量

大多数遗留module依赖于特定全局变量的存在,就像 jQuery 插件在$jQuery. 在这种情况下,您可以配置 webpack,以在var $ = require("jquery")每次遇到全局$标识符时进行前置

var webpack = require("webpack");

    ...

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

3.使用imports-loader进行配置this

一些传统的module依赖于this作为window对象。当module在 CommonJS 上下文中执行时,这会成为一个问题,其中thisequals module.exports在这种情况下,您可以this使用import-loader覆盖

运行npm i imports-loader --save-dev然后

module: {
    loaders: [
        {
            test: /[\/\\]node_modules[\/\\]some-module[\/\\]index\.js$/,
            loader: "imports-loader?this=>window"
        }
    ]
}

导入加载器也可用于手动注入各种变量。但大多数情况下,ProvidePlugin当涉及到隐式全局变量时,它更有用。


4.使用imports-loader禁用AMD

有些module支持不同的module样式,例如 AMD、CommonJS 和 legacy。然而,大多数时候他们首先检查define然后使用一些古怪的代码来导出属性。在这些情况下,通过设置define = false.

module: {
    loaders: [
        {
            test: /[\/\\]node_modules[\/\\]some-module[\/\\]index\.js$/,
            loader: "imports-loader?define=>false"
        }
    ]
}

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

如果您不关心全局变量而只想让遗留脚本工作,您还可以使用脚本加载器。它在全局上下文中执行module,就像您通过<script>标签包含它们一样


6.noParse用于包含大的 dist

当没有 AMD/CommonJS 版本的module并且您想要包含 时dist,您可以将此module标记为noParse. 然后 webpack 将只包含module而不解析它,这可以用来缩短构建时间。这意味着任何需要AST 的功能,如ProvidePlugin,都将不起作用。

module: {
    noParse: [
        /[\/\\]node_modules[\/\\]angular[\/\\]angular\.js$/
    ]
}
ProvidePlugin应用在所有文件中指定的标识符的所有事件。imports-loader可以在特定的文件只适用,但你不应该为同一变量/依赖性同时使用。
2021-03-12 12:41:17
做了这一切,还是不行;然后补充说:"module": { "loaders": [ { test: require.resolve("jquery"), loader: "expose?$!expose?jQuery" },它工作正常。
2021-03-17 12:41:17
我对此感到困惑。jquery实际上来自哪里?本地还是CDN?3. 之后的所有内容都不清楚是否有必要。使用 webpack 将 jquery 集成到您的项目中的实际步骤是什么?它是否绕过了通过 CDN 提供的版本?
2021-03-20 12:41:17
CDN 中的所有内容都超出了 webpack 的范围,因此这里指的是本地 jquery 安装。Jquery 可以是必需的,没有必要的特殊步骤来集成它。这个问题是关于如何集成依赖于全局$变量的jquery插件
2021-03-23 12:41:17
做这一切,只包含一个 jquery 包?,多么痛苦。我要回到我的 gulp 构建
2021-04-03 12:41:17

对于对 jquery 的全局访问,存在几个选项。在我最近的 webpack 项目中,我想要全局访问 jquery,因此我将以下内容添加到我的插件声明中:

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

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

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

$ npm i jquery --save

有关此方法的工作示例,请随时在github上 fork 我的应用程序

如果您降级投票并解释原因,请发表评论。以上信息准确无误。使用上述方法查看我的工作应用程序:github.com/arcseldon/react-babel-webpack-starter-app
2021-03-16 12:41:17
我不是反对者,但也许这是因为ProvidePlugin您建议解决方案已经提出?
2021-03-28 12:41:17
我需要添加'window.jQuery': 'jquery'到该列表中以加载 ms-signalr-client npm 包。我也'window.$': 'jquery'采取了很好的措施:)
2021-04-04 12:41:17
@LéoLam - 感谢您的评论。感谢您的观点 - 我已经通过单独的查询推断出答案,并且只是在这里分享了我认为可能与希望效仿我所做的其他人最相关的片段。不过,您是对的,官方答案确实涵盖了此选项。
2021-04-07 12:41:17
它正在工作,但我收到 2 个警告:./~/jQuery/dist/jquery.js There is another module with an equal name when case is ignored../~/jquery/dist/jquery.js
2021-04-08 12:41:17

我不知道我是否非常了解您要做什么,但我必须使用需要 jQuery 处于全局上下文(窗口)中的 jQuery 插件,并且我将以下内容放入我的entry.js

var $ = require('jquery');
window.jQuery = $;
window.$ = $;

在我刚有需要的地方,我想的jqueryplugin.min.jswindow.$扩展与插件如预期。

基本上,我犯了将 ProvidePlugin 与 noParse 条件一起使用的错误。如答案的第 6 点所述,如果我们执行 NoParse,像 ProvidePlugin 这样的插件将不起作用。你可以在代码中看到那个错误
2021-03-24 12:41:17
是的,我发现与提供插件等相比,它在插件之间更一致地工作......尤其是如果你通过脚本加载器引入 angular 1.x。
2021-04-01 12:41: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'
    })
  ]
}
对我来说,它使用稍微不同的语法工作:` test: require.resolve("jquery"), loader: "expose-loader", options: {暴露: ["$", "jQuery"], }, }, `
2021-03-10 12:41:17
谢谢!这适用于“jquery”:“^3.4.1”和“webpack”:“^4.41.5”。只是我还是让 jQuery 与 Webpack 一起工作不应该这么荒谬吗?
2021-03-11 12:41:17
这对我有用👍。jquery:3.3.1,暴露加载器:0.7.5,webpack:4.20.2
2021-03-16 12:41:17
你忘了提到你需要安装expose-loader才能正常工作 npm install expose-loader --save-dev
2021-04-06 12:41:17
expose-loaded为我做。我在编译时没有收到错误,但是在 Chrome 开发人员工具中。现在已经解决了。
2021-04-06 12:41:17

在您的 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.$ = $;

这对我有用。:)

注意“jquery”的大小写敏感性。在我的 webpack.config 外部,我有“jquery:'jQuery'”。我的脚本中有“从 'jQuery' 导入 $”。更改为“从'jquery'导入$”解决了我的问题:)
2021-03-10 12:41:17
如果您有前任,这将如何运作。app.js 和 jquery-module.js,都需要 jquery?,对我来说,我得到 jquery13981378127 和 jquery12389723198 作为窗口上的实例?
2021-03-23 12:41:17