Vue-cli2.0 第2节 Vue-cli项目结构讲解

第2节 Vue-cli项目结构讲解

vue-cli脚手架工具就是为我们搭建了开发所需要的环境，为我们省去了很多精力。有必要对这个环境进行熟悉，我们就从项目的结构讲起。

Ps：由于版本实时更新和你选择安装的不同（这里列出的是模板为webpack的目录结构），所以你看到的有可能和下边的有所差别。

        .
|-- build                            // 项目构建(webpack)相关代码
|   |-- build.js                     // 生产环境构建代码（设置webpack编译时输出日志效果配置文件）
|   |-- check-version.js             // 检查node、npm等版本配置文件
|   |-- logo.png                     // 
|   |-- utils.js                     // 构建工具及路径相关配置文件
|   |-- vue-loader.conf.js           // 设置是否使用开发/生产环境配置文件
|   |-- webpack.base.conf.js         // webpack基础配置文件
|   |-- webpack.dev.conf.js          // webpack开发环境配置（编译时使用资源路径配置）
|   |-- webpack.prod.conf.js         // webpack生产环境配置（设置webpack打包时输出相关配置）
|-- config                           // 项目开发环境配置
|   |-- dev.env.js                   // 开发环境变量配置文件
|   |-- index.js                     // 项目一些基础配置变量
|   |-- prod.env.js                  // 生产环境变量配置文件
|-- src                              // 源码目录
|   |-- assets                         // 资源目录
|   |-- components                     // vue公共组件目录
|   |-- router                         // 路由
|   |-- App.vue                        // 页面入口文件（根组件）
|   |-- main.js                        // 程序入口js文件，加载各种公共组件
|-- static                           // 静态文件，比如一些图片，json数据等
|   |-- .gitkeep                     // git版本控制功能在空文件中添加的标志文件.gitkeep，在网上看作用是纯静态资源，不会被webpack构建
|-- .babelrc                         // ES6语法编译配置（ES标准转换器配置文件）
|-- .editorconfig                    // 定义代码格式
|-- .gitignore                       // git上传需要忽略的文件格式
|-- postcssrc.js                     // 自动兼容浏览器特性以及屏幕适配配置文件
|-- package-lock.json                // 固定版本依赖配置文件（记录一些需要固定版本的依赖包，这里放一个借鉴地址：https://www.cnblogs.com/cangqinglang/p/8336754.html）
|-- README.md                        // 项目说明文档
|-- index.html                       // 入口页面
|-- package.json                     // 项目基本信息，依赖配置文件，里面记录的是项目的依赖，npm install指令就是根据这个里面的内容来判断需要下载的文件的
.

    

我的是2.9.6，看一下目录结构：

重要文件讲解：

package.json文件是项目根目录下的一个文件，定义该项目开发所需要的各种模块以及一些项目配置信息（如项目名称、版本、描述、作者等）。

package.json里的scripts字段，这个字段定义了你可以用npm运行的命令。在开发环境下，在命令行工具中运行npm run dev 就相当于执行 node build/dev-server.js .也就是开启了一个node写的开发行建议服务器。由此可以看出script字段是用来指定npm相关命令的缩写。

        "scripts": {
	"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
    "start": "npm run dev",
    "build": "node build/build.js"
},

    

dependencies字段和devDependencies字段：

• dependencies字段指项目运行时所依赖的模块
• devDependencies字段指定了项目开发时所依赖的模块

在命令行中运行npm install命令，会自动安装dependencies和devDempendencies字段中的模块。package.json还有很多相关配置，自行百度。

webpack配置相关
运行npm run dev 就相当于执行了node build/dev-server.js,说明这个文件相当重要，解释一下这个文件：（2.9.6的版本是没有这个文件的）
dev-server.js

        // 检查 Node 和 npm 版本
require(‘./check-versions‘)()

// 获取 config/index.js 的默认配置
var config = require(‘../config‘)

// 如果 Node 的环境无法判断当前是 dev / product 环境
// 使用 config.dev.env.NODE_ENV 作为当前的环境

if (!process.env.NODE_ENV) process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)

// 使用 NodeJS 自带的文件路径工具
var path = require(‘path‘)

// 使用 express
var express = require(‘express‘)

// 使用 webpack
var webpack = require(‘webpack‘)

// 一个可以强制打开浏览器并跳转到指定 url 的插件
var opn = require(‘opn‘)

// 使用 proxyTable
var proxyMiddleware = require(‘http-proxy-middleware‘)

// 使用 dev 环境的 webpack 配置
var webpackConfig = require(‘./webpack.dev.conf‘)

// default port where dev server listens for incoming traffic

// 如果没有指定运行端口，使用 config.dev.port 作为运行端口
var port = process.env.PORT || config.dev.port

// Define HTTP proxies to your custom API backend
// https://github.com/chimurai/http-proxy-middleware

// 使用 config.dev.proxyTable 的配置作为 proxyTable 的代理配置
var proxyTable = config.dev.proxyTable

// 使用 express 启动一个服务
var app = express()

// 启动 webpack 进行编译
var compiler = webpack(webpackConfig)

// 启动 webpack-dev-middleware，将 编译后的文件暂存到内存中
var devMiddleware = require(‘webpack-dev-middleware‘)(compiler, {
  publicPath: webpackConfig.output.publicPath,
  stats: {
    colors: true,
    chunks: false
  }
})

// 启动 webpack-hot-middleware，也就是我们常说的 Hot-reload
var hotMiddleware = require(‘webpack-hot-middleware‘)(compiler)
// force page reload when html-webpack-plugin template changes
compiler.plugin(‘compilation‘, function (compilation) {
  compilation.plugin(‘html-webpack-plugin-after-emit‘, function (data, cb) {
    hotMiddleware.publish({ action: ‘reload‘ })
    cb()
  })
})

// proxy api requests
// 将 proxyTable 中的请求配置挂在到启动的 express 服务上
Object.keys(proxyTable).forEach(function (context) {
  var options = proxyTable[context]
  if (typeof options === ‘string‘) {
    options = { target: options }
  }
  app.use(proxyMiddleware(context, options))
})

// handle fallback for HTML5 history API
// 使用 connect-history-api-fallback 匹配资源，如果不匹配就可以重定向到指定地址
app.use(require(‘connect-history-api-fallback‘)())

// serve webpack bundle output
// 将暂存到内存中的 webpack 编译后的文件挂在到 express 服务上
app.use(devMiddleware)

// enable hot-reload and state-preserving
// compilation error display
// 将 Hot-reload 挂在到 express 服务上
app.use(hotMiddleware)

// serve pure static assets
// 拼接 static 文件夹的静态资源路径
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 为静态资源提供响应服务
app.use(staticPath, express.static(‘./static‘))

// 让我们这个 express 服务监听 port 的请求，并且将此服务作为 dev-server.js 的接口暴露
module.exports = app.listen(port, function (err) {
  if (err) {
    console.log(err)
    return
  }
  var uri = ‘http://localhost:‘ + port
  console.log(‘Listening at ‘ + uri + ‘\n‘)

  // when env is testing, don‘t need open it
  // 如果不是测试环境，自动打开浏览器并跳到我们的开发地址
  if (process.env.NODE_ENV !== ‘testing‘) {
    opn(uri)
  }
})

    

webpack.base.confg.js webpack的基础配置文件

        module.export = {
    // 编译入口文件
    entry: {},
    // 编译输出路径
    output: {},
    // 一些解决方案配置
    resolve: {},
    resolveLoader: {},
    module: {
        // 各种不同类型文件加载器配置
        loaders: {
        ...
        ...
        // js文件用babel转码
        {
            test: /\.js$/,
            loader: ‘babel‘,
            include: projectRoot,
            // 哪些文件不需要转码
            exclude: /node_modules/
        },
        ...
        ...
        }
    },
    // vue文件一些相关配置
    vue: {}
}

    

这里有很多webpack的知识，要去看专门讲webpack的视频教程。

.babelrc
Babel解释器的配置文件，存放在根目录下。Babel是一个转码器，项目里需要用它将ES6代码转为ES5代码。如果你想了解更多，可以查看babel的知识。

        {
  //设定转码规则
  "presets": [
    [
    //对BABEL_ENV或者NODE_ENV指定的不同的环境变量，进行不同的编译操作
    "env", {
      "modules": false,
      "targets": {
        "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
      }
    }],
    "stage-2"
  ],
  //转码用的插件
  "plugins": ["transform-vue-jsx", "transform-runtime"]
}

    

.editorconfig
该文件定义项目的编码规范，编译器的行为会与.editorconfig文件中定义的一致，并且其优先级比编译器自身的设置要高，这在多人合作开发项目时十分有用而且必要。

        root = true

[*]      // 对所有文件应用下面的规则
charset = utf-8                     // 编码规则用utf-8
indent_style = space                // 缩进用空格
indent_size = 2                     // 缩进数量为2个空格
end_of_line = lf                    // 换行符格式
insert_final_newline = true         // 是否在文件的最后插入一个空行
trim_trailing_whitespace = true     // 是否删除行尾的空格

    

这是比较重要的关于vue-cli的配置文件

原文：https://www.cnblogs.com/Elva3zora/p/12699153.html