使用webpack从无到有搭建一个简单项目

webpack版本:v4.23.1

node.js以及npm的安装不再整理

第一步,初始化项目

    #在项目目录下打开命令行,执行如下命令
    npm init
    #接下来会输入项目的一些信息,英语翻译就好,或者所有都回车选默认
    #可以使用下面的命令,直接生成一个默认的项目
    npm init -y

执行完上述命令后,会生成一个packjson文件,内容如下

    //packjson.json
    {
      "name": "sinon",
      "version": "1.0.0",
      "description": "",
      "main": "index.js",
      "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
      },
      "author": "",
      "license": "ISC"
    }

第二步,创建几个基本的目录以及相应的文件

sinon是根目录文件名

使用webpack从无到有搭建一个简单项目_第1张图片
dir

第三步,安装webpack相关插件

    npm install webpack webpack-cli -D

如此执行后,可以在packjson.json中已经添加了开发依赖(devDependencies),并且项目中多了node_modules目录。

因为我们安装了cli,所以此时已经可以进行打包操作:

    npx webpack

    # 或者在packjson中添加命令,这里加 '--config webpack.config.js'可以指定webpack的配置文件,默认是webpack.config.js
    
    #packjson.json
    "script":{
        "build":"webpack"
    }

    #下面我们就可以使用npm run build 来构建项目了
    #webpack后面加 --watch,可以是webpack进入观察者模式,这样当我们修改文件内容的时候,不需要每次都执行npm run build,直接刷新浏览器即可。

执行完上面的命令后可以在文件夹中看到,多出了dist目录,里面后有一个mian.js,也就是说该命令和将我们的脚本作为入口起点,然后输出为main.js。

第四步,添加webpack配置文件

webpack现在支持无配置文件也可运行的情况,但是我们的需求各不相同,所以基本上我们都需要配置自己的webpack配置文件,根目录下创建webpack.config.js。

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

    module.exports = {
        entry:'./src/index.js',
        //这里是省略写法,等价于
        //enrty:{
        //  main:'./src/index.js'
        //}
        output:{
            filename:'[name].bundle.js',//根据入口名,生成不同的文件,这里示例的入口名是main被省略了,所以生成的是main.js而不是index.js
            path:path.resolve(__dirname,'dist')
        }
    }

第五步,安装一些方便我们开发的插件

html-webpack-plugin , 自动在dist目录生成index.html文件,而且会自动更新,不需要我们手动添加或修改index.html文件。

    //npm install -D html-webpack-plugin
    
    //webpack.config.js
    const HtmlWebpackPlugin = require('html-webpack-plugin');

    plugins:[
        new HtmlWebpackPlugin({
            title:'hello world',
            template:'index.html'//模板文件,将根据这个文件生成
        })
    ]

按上面的设置完后,执行npm run build可以看到dist目录下多出了index.html文件,内容如下:

    
    
      
        
        hello world
      
      
      
    

可以看到生成的文件中自动引入了我们打包出去的main.js文件

clean-webpack-plugin 清理dist目录

开发过程中不断的build,可能会导致dist目录多出一些多余的历史文件,使用clean-webpack-plugin插件会在我们每次执行构建的时候,删除dist目录,如此便免去了手动删除的麻烦。

    // npm install -D clean-webpack-plugin
     
    const CleanWebpackPlugin = require('clean-webpack-plugin');

    plugins:[
        new CleanWebpackPlugin(['dist'])
    ]

完成上面配置后,执行npm run build可以看到dist目录先被干掉然后在重新根据配置生成。

webpack-dev-server 搭建一个简单的web服务器

为了方便开发我们要搭建一个webpack服务器,该插件支持实时重新加载。

    //npm install -D webpack-dev-server
    
    //webpack.config.json
    devServer:{
        contentBase:'./dist',//服务器目录
        open:true//自动打开浏览器
    }

    //packjson.json
    "scripts":{
        "start":"webpack-dev-server"
    }

完成上面配置后,便可以通过命令npm run start来启动服务器

开启模块热替换(HMR:Hot Module Replacement)

完成上面配置后,修改index.js文件刷新页面并不会更新,需要重新启动项目才可把更新同步过去,为了方便开发避免每次修改都重启项目,所以就有了模块热替换。现在webpack-dev-server封装了webpack-dev-middle和webpack-dev-middleware,所以我们不需要安装插件,可以直接开启HMR。

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

    devServer:{
        contentBase:'./dist',
        open:true,
        hot:true
    },
    plugins:[
        new webpack.NamedModulesPlugin(),
        new webpack.HotModuleReplacementPlugin()
    ]

配置完成后我们执行npm run start,然后修改index.js文件的内容可以看到浏览器自动刷新。

详细说明和配置,看另一篇文章。


下面列出整个项目的初始化结构和文件

目录结构

使用webpack从无到有搭建一个简单项目_第2张图片
dir_hole

packjson.json

    {
        "name": "sinon",
        "version": "1.0.0",
        "description": "",
        "main": "index.js",
        "scripts": {
            "test": "echo \"Error: no test specified\" && exit 1",
            "build": "webpack",
            "start":"webpack-dev-server"
        },
        "author": "",
        "license": "ISC",
        "devDependencies": {
            "clean-webpack-plugin": "^0.1.19",
            "html-webpack-plugin": "^3.2.0",
            "webpack": "^4.23.1",
            "webpack-cli": "^3.1.2",
            "webpack-dev-server": "^3.1.10"
        }
    }

webpack.config.js

    const path = require('path');
    const HtmlWebpackPlugin = require('html-webpack-plugin');
    const CleanWebpackPlugin = require('clean-webpack-plugin');
    const webpack = require('webpack');

    module.exports = {
        entry:'./src/index.js',
        output:{
            filename:'[name].js',
            path:path.resolve(__dirname,'dist')
        },
        plugins:[
            new HtmlWebpackPlugin({
                template:'./index.html'
            }),
            new CleanWebpackPlugin(['dist']),
            new webpack.NamedModulesPlugin(),
            new webpack.HotModuleReplacementPlugin()
        ],
        devServer:{
            contentBase:'./dist',
            open:true,
            hot:true
        }
    }

这篇笔记记录了使用webapck一步一步搭建一个项目,关于文章中的各个配置项说明,详见另一篇文章:webpack配置整理

参考文档:https://www.webpackjs.com/guides/

你可能感兴趣的:(使用webpack从无到有搭建一个简单项目)