Vue-cli 项目结构讲解

项目目录结构

这里列出的是模板为webpack的目录结构

build          // 项目构建(webpack)相关代码

config          // 项目开发环境配置

src          // 源码目录 

static          // 静态文件,比如一些图片,json数据等

.babelrc         // ES6语法编译配置

.editorconfig        // 定义代码格式

.gitignore         // git上传需要忽略的文件格式

 README.md        // 项目说明

 index.html         // 入口页面

package.json          // 项目基本信息

重要文件讲解:

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

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

dependencies字段和devDependencies字段

dependencies字段指项目运行时所依赖的模块;

devDependencies字段指定了项目开发时所依赖的模块;

在命令行中运行npm install命令,会自动安装dependencies和devDempendencies字段中的模块。

package.json还有很多相关配置,如果你想全面了解,可以专门去百度学习一下。

webpack配置相关

上面说了运行npm run dev 就相当于执行了node build/dev-server.js,说明这个文件相当重要

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: {}

}

.babelrc

Babel解释器的配置文件,存放在根目录下。Babel是一个转码器,项目里需要用它将ES6代码转为ES5代码。

.editorconfig

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容

  • 原文http://www.cnblogs.com/libin-1/p/6596810.html 版本号 vue-c...
    tengrl阅读 3,634评论 0 0
  • 版权声明:本文为博主原创文章,未经博主允许不得转载。 webpack介绍和使用 一、webpack介绍 1、由来 ...
    it筱竹阅读 11,028评论 0 21
  • 只有山顶 才见大片的枯木 是长时间的缺水 还是遭受雷击 没有人告诉我 我只在沉思中 陷入痛苦 多少年了 就那么挺立...
    云淡风轻之蓝阅读 394评论 12 22
  • 夕阳没(mo)了. 还是没有你的身影. 星儿隐了. 依旧没有熟悉的琴音. 你是否已向远方前进.是我还是那般颓废.消...
    犹子阅读 178评论 0 0
  • 互联网金融火了,随之而来的是黑客们尾随的脚步。数据显示,国内已有上百家互联网金融平台,由于受到黑客攻击,导致网站系...
    龚雪_ff0c阅读 348评论 0 0