1 Star 2 Fork 0

pipe / webpack_dev

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

🌲 webpack

官网:https://webpack.docschina.org

安装

webpack && webpack-cli -D

webpack 可以进行 0 配置

  • 🔶 打包工具 -> 输出后的结果(支持 js 模块)
  • 🔶 打包 (支持我们的 js 的模块化)

手动配置 webpack

  • 🔵 默认配置文件的名字 webpack.config.js
  • 🔵 开发服务器参数配置
  • 🔵HtmlWebpackPlugin 插件使用

插件和模块

  • 🟡css loader 解析@import 这种语法
  • 🟡style-loader 把 css 插入到 head 的标签中
  • 🟡mini-css-extract-plugin 将 css 从 js 中抽离出来,单独打包
  • 🟡less, less-loader处理 less 文件
  • 🟡babel-loader 处理 ES6
  • 🟡postcss-loader autoprefixer 处理自动添加浏览器前缀
  • 🟡css-minimizer-webpack-plugin 压缩 css && 在 optimization.minimizer 中可以使用 '...' 来访问默认值。防止 css 压缩后 js 又不压缩(js 是默认压缩的)

处理 js

  • 🟢 转义 JS 语法,将 ES 高级语法转换为浏览器 ES5 语法 需要用到的包: @babel-loader @babel/core @babel/preset-env
  • 🟢 处理 class @babel/plugin-proposal-class-properties ,装饰器语法 @babel/plugin-proposal-decorators
  • 🟢 在项目中使用了 async/await, 就开始报错 regeneratorRuntime is not defined。则需要处理 es7 语法,@babel/plugin-transform-runtime @babel/polyfill(已被废弃)
  • 🟢 校验 js eslint-loader enforce:pre

处理全局变量引入问题

作用:把变量暴露到全局

  • 🔵 采用 expose-loader 可采用内联 loader 或 直接在 webpack.config.js 中配置。
import $ from "expose-loader?exposes=$!jquery"; // 采用内联loader处理全局变量问题
  module: {
    rules: [
      {
        test: require.resolve("jquery"),
        loader: "expose-loader",
        options: {
          exposes: ["$", "jQuery"],
        }
      }
    ]
  }
  其他使用方式可到npm上查看官网示例
  • 🔵 采用webpack. ProvidePlugin自动加载,在任何地方不必 import 或 require 模块。给每个模块注入一个$
new webpack.ProvidePlugin({
    $: "jquery",
    jQuery: "jquery",
});
  • 🔵 引入 CDN, 不打包的方式。采用Externals
module.exports = {
    //...
    externals: {
        /* 
               import $ from "jquery";
               引号前面的是我们项目中引入的包名(可自定义)
               例如:import $ from "jqueryTEST";
                externals: {
                  jqueryTEST: 'jQuery',
                }
               引号后面的是CDN中暴露的全局变量
            */
        jquery: "jQuery",
    },
};

处理图片

  • 🟣"url 处理图片和打包优化

url-loader 内置了 file-loader , 是增强的 file-loader

优点: 如果图片较多,会发很多 http 请求,会降低页面性能。url-loader 会将引入的图片编码,生成 dataURl。相当于把图片数据翻译成一串字符。再把这串字符打包到文件中,最终只需要引入这个文件就能访问图片了。当然,如果图片较大,编码会消耗性能。因此 url-loader 提供了一个 limit 参数,小于 limit 字节的文件会被转为 DataURl,大于 limit 的还会使用 file-loader 进行 copy。

注意: url-loader 需要结合 file-loader 使用。

/* 下载依赖 */
yarn add url - loader file - loader - D
/* webpack.config.js配置 */
module: {
    rules: [{
        test: /\.(png|jpg|gif)$/i,
        use: [{
            loader: 'url-loader',
            options: {
                limit: 40960, // 超过40KB采用file-loader处理
            }
        }]
    }]
}
/* 应用代码段 */
import shrimp from './images/shrimp.png';
let img = new Image()
img.src = shrimp
$('body').append(img);

打包文件分类

将不同的文件类型打包到各自的文件夹中

  • 🟤js 分类
module.exports = {
    output: {
        filename: "js/[name].[contenthash:8].bundel.js", //采用contenthash,自己发生改变,只重新hash自己,不会hash真个项目。采用[hash]则会hash整个项目
        path: path.resolve(__dirname, "dist"),
    },
};
  • 🟤css 分类
module.exports = {
    plugins: [
        new MiniCssExtractPlugin({
            filename: "css/main.[contenthash:8].css",
        }),
    ],
};
  • 🟤image 分类
module.exports = {
    module: {
        rules: [{
            test: /\.(png|jpg|gif)$/i,
            use: [{
                loader: "url-loader",
                options: {
                    limit: 40960,
                    outputPath: "img/",
                    // fallback: require.resolve('image-webpack-loader')
                },
            }, ],
        }, ],
    },
};

多页面打包配置

  • ⚫ 多页面应用 webpack 打包配置
// webpack.config.js
module.exports = {
    entry: {
        ...你的配置...
        // 配置多入口
        main: "./src/index.js", // 前面的key就是打包后的文件名
        test: "./src/test.js", // 前面的key就是打包后的文件名
    },
    // new 多个HtmlWebpackPlugin插件
    plugins: [
        new HtmlWebpackPlugin({
            template: "./src/index.html", //模板位置
            filename: "index.html", //打包出来后的文件名
            minify: {
                removeAttributeQuotes: true, //删除双引号
                collapseWhitespace: true,
            },
            hash: true,
            chunks: ["main"], // 只引入main模块
        }),
        new HtmlWebpackPlugin({
            template: "./src/home.html", //模板位置
            filename: "home.html", //打包出来后的文件名
            minify: {
                removeAttributeQuotes: true, //删除双引号
                collapseWhitespace: true,
            },
            hash: true,
            chunks: ["test"], // 只引入test模块
        }),
    ]
}

source-map 源码映射配置

  • 🟥dev-tool:'source-map'

产生一个单独的 source-map 文件,功能最完全,但会减慢打包速度

  • 🟥dev-tool:'eval-source-map'

使用 eval 打包源文件模块,直接在源文件中写入干净完整的 source-map,不影响构建速度,但影响执行速度和安全,建议开发环境中使用,生产阶段不要使用

  • 🟥dev-tool:'cheap-module-source-map'

会产生一个不带映射到列的单独的 map 文件,开发者工具就只能看到行,但无法对应到具体的列(符号),对调试不便

  • 🟥dev-tool:'cheap-module-eval-source-map'

不会产生单独的 map 文件,(与 eval-source-map 类似)但开发者工具就只能看到行,但无法对应到具体的列(符号),对调试不便

module.exports = {
    /* 配置开发工具 */
    devtool: "source-map",
};

watch 的用法 监控文件

  • 🟧 监控文件,实时打包。(仅用于构建)
module.exports = {
    /* Do not use serve with --watch. serve already watches for changes. */
    watch: true, // 生产环境不要开启此选项 Do not use serve with --watch. serve already watches for changes.
    watchOptions: {
        aggregateTimeout: 2000, //防抖
        ignored: /node_modules/, //需要忽略的监听文件
        poll: 1000, // // 每秒检查一次变动
    },
};

webpack 小插件

  • 🟨cleanWebpackPlugn

自动删除之前的构建包,避免构建包越来越大

  • 🟨copyWebpackPlugin

将已存在的单个文件或整个目录复制到构建目录。

  • 🟨bannerPlugin webpack 内置插件

给打包后的 js 添加版权或者说明

webpack 代理配置 http-proxy

  • 🟩 配置 proxy 解决跨域
module.exports = {
    //...
    devServer: {
        proxy: {
            context: ["/auth", "/api"], //如果想将多个特定路径代理到同一目标,则可以使用一个或多个带有 context 属性的对象的数组:
            "/api": "http://localhost:3000",
            pathRewrite: {
                "^/api": "", //不希望传递api 如果不设置此参数  所有请求将会携带/api 即:http://localhost:3000/api
            },
            changeOrigin: true, // 默认情况下,代理时会保留主机头的来源,可以将 changeOrigin 设置为 true 以覆盖此行为。
        },
    },
};
  • 🟩mock 数据
denServe: {
    before(app) {
        app.get('/user', (req, res) => {
            res.json({
                name: 'pipe_before'
            })
        })
    }
}
  • 🟩 不用代理处理,服务端启动 webpack,保持本地端口一直,既解决了跨域问题 。

💚 在本地搭建项目既有服务端和客户端时非常有用 💚

resolve 解析配置

  • module:[path.resolve('node_modules')]
  • extensions:['.js', '.json', '.wasm'], 解析后缀顺序
  • mainFields
  • mainFiles 入口文件名字 index.js
module.exports = {
    resolve: {
        modules: [path.resolve(__dirname, "other_modules"), "node_modules"], //webpack 解析模块时应该按顺序搜索的目录
        // mainFields: ['style'], //此选项将决定在 package.json 中使用哪个字段导入模块
        extensions: [".css", "..."],
        alias: {
            bootstrap: path.resolve(
                __dirname,
                "node_modules/bootstrap/dist/css/bootstrap.css"
            ), // 创建 import 或 require 的别名,来确保模块引入变得更简单。
        },
    },
};

定义环境变量

webpack.definePlugin 定义一个全局常量

/* webpack.config.js */
new webpack.DefinePlugin({
    PRODUCTION: JSON.stringify(true),
});
/* 代码中直接判断 */
if (!PRODUCTION) {
    console.log("Debug info");
}

if (PRODUCTION) {
    console.log("Production log");
}
/* 未经 webpack 压缩过的代码 */
if (!true) {
    console.log("Debug info");
}
if (true) {
    console.log("Production log");
}
/* 过压缩后 */
console.log("Production log");

区分不同环境

webpack-merge

let {
    smart
} = require("webpack-merge");
let base = require("./webpack.config.my.js");

module.exports = smart(base, {
    mode: "development",
    devServer: {},
    devtool: "source-map",
});

webpack 优化

webpack 相关优化,请查看另一个仓库地址 https://gitee.com/pipepandafeng/webpack_opt

📰 资料

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于webpack的构建模板 展开 收起
JavaScript 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/pipepandafeng/webpack_dev.git
git@gitee.com:pipepandafeng/webpack_dev.git
pipepandafeng
webpack_dev
webpack_dev
master

搜索帮助