├── .babelrc ├── .editorconfig ├── .eslintignore ├── .eslintrc.js ├── .gitignore ├── .postcssrc.js ├── .travis.yml ├── README.md ├── build ├── build.js ├── check-versions.js ├── logo.png ├── utils.js ├── vue-loader.conf.js ├── webpack.base.conf.js ├── webpack.dev.conf.js └── webpack.prod.conf.js ├── config ├── dev.env.js ├── index.js └── prod.env.js ├── index.html ├── package.json ├── src ├── App.vue ├── assets │ ├── 1.png │ ├── 2.png │ ├── 3.png │ ├── arrow.png │ ├── background.png │ ├── logo.png │ ├── save.png │ ├── template1.png │ ├── template2.png │ ├── template3.png │ ├── test.jpeg │ └── upload.png ├── components │ ├── ClipImage.vue │ └── UploadFile.vue ├── main.js ├── router │ └── index.js └── utils │ ├── exif.js │ └── utils.js └── static └── .gitkeep /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | ["env", { 4 | "modules": false, 5 | "targets": { 6 | "browsers": ["> 1%", "last 2 versions", "not ie <= 8"] 7 | } 8 | }], 9 | "stage-2" 10 | ], 11 | "plugins": ["transform-vue-jsx", "transform-runtime"] 12 | } 13 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 2 7 | end_of_line = lf 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | /config/ 3 | /dist/ 4 | /src/utils/exif.js 5 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | // https://eslint.org/docs/user-guide/configuring 2 | 3 | module.exports = { 4 | root: true, 5 | parserOptions: { 6 | parser: 'babel-eslint' 7 | }, 8 | env: { 9 | browser: true, 10 | }, 11 | extends: [ 12 | // https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention 13 | // consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules. 14 | 'plugin:vue/essential', 15 | // https://github.com/standard/standard/blob/master/docs/RULES-en.md 16 | 'standard' 17 | ], 18 | // required to lint *.vue files 19 | plugins: [ 20 | 'vue' 21 | ], 22 | // add your custom rules here 23 | rules: { 24 | // allow async-await 25 | 'generator-star-spacing': 'off', 26 | // allow debugger during development 27 | 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off' 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules/ 3 | /dist/ 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Editor directories and files 9 | .idea 10 | .vscode 11 | *.suo 12 | *.ntvs* 13 | *.njsproj 14 | *.sln 15 | -------------------------------------------------------------------------------- /.postcssrc.js: -------------------------------------------------------------------------------- 1 | // https://github.com/michael-ciniawsky/postcss-load-config 2 | 3 | module.exports = { 4 | "plugins": { 5 | "postcss-import": {}, 6 | "postcss-url": {}, 7 | // to edit target browsers: use "browserslist" field in package.json 8 | "autoprefixer": {} 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - 8 4 | 5 | branches: 6 | only: 7 | - master 8 | 9 | script: 10 | - "npm run lint" 11 | - "npm run build" 12 | 13 | cache: 14 | directories: 15 | - node_modules 16 | 17 | dist: trusty 18 | 19 | deploy: 20 | provider: pages 21 | skip_cleanup: true 22 | github_token: $GITHUB_TOKEN # Set in the settings page of your repository, as a secure variable 23 | keep_history: true 24 | local_dir: dist/ 25 | on: 26 | branch: master -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vue通过Canvas生成海报 2 | 3 | [](https://travis-ci.org/JustinWang23/Vue-Canvas-Poster) 4 | 5 | 前几天公司年会要做一个需求,在移动端上传图片并生成封面海报,中间还涉及图片的移动和缩放。 6 | 7 | 由于之前的海报都是交给后台JAVA来生产的,原理类似于打水印,正巧前段时间看了Canvas,很有意思,所以这个需求就用纯前端实现了一下。 8 | 9 | 这几天整理了一下代码,总结一下中间遇到的坑和经验。 10 | 11 | ## 演示 12 | 13 | [在线演示](https://justinwang23.github.io/vue-canvas-poster/) 14 | 15 | ## 安装 16 | 17 | ``` bash 18 | # 安装依赖 19 | npm install 20 | 21 | # 启动本地调试环境 22 | npm run dev 23 | 24 | # 生成打包部署文件 25 | npm run build 26 | ``` 27 | 28 | ## 获取图片 29 | 30 | ### 上传 31 | 32 | 很简单 一个类型为file的input就可以搞定了 33 | 34 | ``` 35 | 36 | 37 | ``` 38 | 39 | accept属性用来限制上传的图片类型,可以是图片也可以是视频,这里需求只要求图片,因此只接受gif,jpg,jpeg和png格式的图片 40 | 41 | 其实也可以用accept="image/*"来实现,但在实际使用中,发现这么写会导致一定的卡顿,原因大致是在作判断前需要先遍历一遍所有的image类型,所以这里指定了几个图片类型。 42 | 43 | 至于上传按钮的样式,可以通过CSS进行处理,来达到你想要的效果。 44 | 45 | ### 接收 46 | 47 | 这里用到了FileReader的readAsDataURL方法,将上传的图片转化成一串URL,也就是图片的Base64编码。 48 | 49 | ``` 50 | let reader = new FileReader() 51 | let file = event.target.files[0] 52 | // 读取上传的文件 53 | reader.readAsDataURL(file) 54 | reader.onload = (e) => { 55 | // 获取图片的Base64编码 56 | t.img.src = e.target.result 57 | } 58 | ``` 59 | 60 | ### 处理 61 | 62 | 获取到图片后,接下来还要进行一下处理,比如,限制一下图片的大小。 63 | 64 | ``` 65 | // 图片大小的控制,不能超过3M 66 | if (file.size > 3 * 1024 * 1024) { 67 | alert('上传的图片过大,请重新选择') 68 | return 69 | } 70 | ``` 71 | 72 | 将图片的宽高进行一下同比缩放,更好的适应手机的屏幕。 73 | 74 | ``` 75 | t.img.onload = () => { 76 | var imgWidth = t.img.width 77 | var imgHeight = t.img.height 78 | // 控制上传图片的宽高 79 | if (imgWidth > imgHeight && imgWidth > 750) { 80 | imgWidth = 750 81 | imgHeight = Math.ceil(750 * t.img.height / t.img.width) 82 | } else if (imgWidth < imgHeight && imgHeight > 1334) { 83 | imgWidth = Math.ceil(1334 * t.img.width / t.img.height) 84 | imgHeight = 1334 85 | } 86 | } 87 | ``` 88 | 89 | 本来以为这样就结束了,但是在后期测试的时候,发现在某些iOS和android手机上,上传的图片会被翻转90度,查了一下,是某些机型的bug,因此,需要将图片再翻转回来。 90 | 91 | 由于后续生成海报的话还需要在上传图片的基础上再覆盖一层模版,所以无法简单的通过之后的手势来进行图片的旋转。 92 | 93 | 因此这里我们在上传的时候就对图片进行处理,用到了一个exif.js,用于判断图片的orientation,再根据orientation将图片翻转一下。 94 | 95 | ``` 96 | // 获取上传图片的朝向 97 | EXIF.getData(file, function () { 98 | t.orientation = EXIF.getTag(this, 'Orientation') 99 | }) 100 | 101 | // 针对某些机型上取到图片朝向不对的处理 102 | if (t.orientation && t.orientation !== 1) { 103 | switch (t.orientation) { 104 | case 6: // 旋转90度 105 | canvas.width = imgHeight 106 | canvas.height = imgWidth 107 | ctx.rotate(Math.PI / 2) 108 | // (0,-imgHeight) 从旋转原理图那里获得的起始点 109 | ctx.drawImage(t.img, 0, -imgHeight, imgWidth, imgHeight) 110 | break 111 | case 3: // 旋转180度 112 | ctx.rotate(Math.PI) 113 | ctx.drawImage(t.img, -imgWidth, -imgHeight, imgWidth, imgHeight) 114 | break 115 | case 8: // 旋转-90度 116 | canvas.width = imgHeight 117 | canvas.height = imgWidth 118 | ctx.rotate(3 * Math.PI / 2) 119 | ctx.drawImage(t.img, -imgWidth, 0, imgWidth, imgHeight) 120 | break 121 | } 122 | } else { 123 | ctx.drawImage(t.img, 0, 0, imgWidth, imgHeight) 124 | } 125 | ``` 126 | 这里还要注意一下翻转后的坐标,由于翻转后可视区域变了,因此要将坐标做相应的平移。 127 | 128 | ### 图片压缩 129 | 130 | 由于手机拍出来的照片可能过大,并且转成base64后会导致图片的Size进一步变大,因此,通过 canvas.toDataURL() 方法来压缩照片质量。 131 | 132 | ``` 133 | canvas.toDataURL('image/png', 0.5) 134 | ``` 135 | 136 | toDataURL() 方法一共有两个参数,第一个参数为图片格式,默认为 image/png。第二个参数为压缩质量,可以从 0 到 1 的区间内选择图片的质量。 137 | 138 | ## 图片编辑 139 | 140 | ### 创建Canvas 141 | 142 | 首先,需要先创建一个Canvas对象,将图片绘画上去。 143 | 144 | ``` 145 | 146 | 147 | mounted () { 148 | this.canvas = this.$refs.myCanvas 149 | // 获取屏幕可见宽度和高度 防止在有导航栏的情况下 全屏拉伸导致的比例问题 150 | this.canvas.width = document.documentElement.clientWidth * window.devicePixelRatio 151 | this.canvas.height = document.documentElement.clientHeight * window.devicePixelRatio 152 | // 再通过css将canvas缩放到全屏 防止canvas的内容失真 153 | this.canvas.style.width = '100%' 154 | this.canvas.style.height = '100%' 155 | this.ctx = this.canvas.getContext('2d') 156 | } 157 | ``` 158 | 159 | 这里最早直接通过CSS将Canvas的width和height设置成全屏,也就是100%之后,发现绘出来的图片非常模糊,而且图片的比例也不对,原因是,Canvas默认是300px\*150px的,CSS改变宽高其实是先生成了一个300px\*150px的Canvas,然后再拉伸到CSS设置的宽度和高度,自然会模糊以及比例不对。 160 | 161 | 解决方案也很简单,先设置Canvas的宽高属性,可以设置为实际大小的2倍,再通过css缩小到实际大小,我们这里设置为可见区域的像素值乘以屏幕的像素比。 162 | 163 | ### 绘制图片 164 | 165 | 接着,将图片绘制到Canvas中,通过Canvas里content对象的drawImage方法。 166 | 167 | ``` 168 | this.img.src = sessionStorage.getItem('uploadImage') 169 | this.img.onload = ($this) => { 170 | this.drawImage() 171 | this.drag() 172 | } 173 | 174 | drawImage () { 175 | // 清除canvas内容 176 | this.ctx.clearRect(0, 0, this.canvas.width, this.canvas.height) 177 | // 绘画底层上传图片 178 | this.ctx.drawImage(this.img, this.imgX, this.imgY, this.imgWidth * this.imgScale, this.imgHeight * this.imgScale) 179 | // 绘画上层模版 180 | this.drawTemplate() 181 | } 182 | ``` 183 | 184 | drawImage一共有三个方法,分别是: 185 | 186 | ``` 187 | drawImage(img, X, Y) 188 | 189 | drawImage(img, X, Y, newWidth, newHeight) 190 | 191 | drawImage(img, clipX, clipY, clipWidth, clipHeight, X, Y, newWidth, newHeight) 192 | ``` 193 | 194 | 由于我们不需要对图片进行剪裁,所以我们选择了第二个方法,对图片的起点坐标和大小进行修改。 195 | 196 | 需要对图片进行剪裁的话,请选择第三个方法。 197 | 198 | ### 绘制模版 199 | 200 | 在绘制完图片之后,再绘制模版,这里顺序要注意,后绘制的东西会在上层。 201 | 202 | ``` 203 | drawTemplate () { 204 | this.ctx.drawImage(this.bgimg, 0, 0, this.canvas.width, this.canvas.height) 205 | } 206 | ``` 207 | 208 | ### 添加手势 209 | 210 | 绘制完成后,就要添加手势操作了,让图片可以调整位置和大小。 211 | 212 | 首先是图片的位置 213 | 214 | ``` 215 | let draging = false 216 | 217 | // 记录初始点击的pageX,pageY。用于记录位移 218 | let pageX = 0 219 | let pageY = 0 220 | 221 | // 初始位移 222 | let startX = 0 223 | let startY = 0 224 | 225 | this.canvas.addEventListener('touchstart', (ev, $this) => { 226 | let e = ev.touches[0] 227 | 228 | draging = true 229 | 230 | pageX = e.pageX 231 | pageY = e.pageY 232 | 233 | startX = this.imgX 234 | startY = this.imgY 235 | }) 236 | 237 | this.canvas.addEventListener('touchmove', (ev, $this) => { 238 | let e = ev.touches[0] 239 | 240 | if (draging) { 241 | this.imgX = e.pageX - pageX + startX 242 | this.imgY = e.pageY - pageY + startY 243 | this.drawImage() 244 | } 245 | }) 246 | 247 | this.canvas.addEventListener('touchend', ($this) => { 248 | draging = false 249 | }) 250 | ``` 251 | 252 | 这里,用到了移动端的touch事件,在touchstart的时候,将上一次图片的起始坐标赋给startX、startY,而pageX、pageY用于记录手指拖动的起始坐标。 253 | 254 | 在touchmove的时候,将手指拖动后的坐标减去拖动前的初始坐标再加上图片本身的初始坐标,就是拖拽后的实际坐标了。 255 | 256 | 接着是手势缩放 257 | 258 | ``` 259 | let draging = false 260 | 261 | // 记录双指缩放的距离 262 | let scaleX = 0 263 | let scaleY = 0 264 | 265 | this.canvas.addEventListener('touchstart', (ev, $this) => { 266 | let e = ev.touches[0] 267 | let e2 = ev.touches[1] 268 | 269 | draging = true 270 | 271 | this.imgWidth = this.imgWidth * this.imgScale 272 | this.imgHeight = this.imgHeight * this.imgScale 273 | 274 | scaleX = Math.pow(e.pageX - e2.pageX, 2) + Math.pow(e.pageY - e2.pageY, 2) 275 | }) 276 | 277 | this.canvas.addEventListener('touchmove', (ev, $this) => { 278 | let e = ev.touches[0] 279 | let e2 = ev.touches[1] 280 | 281 | if (draging) { 282 | scaleY = Math.pow(e.pageX - e2.pageX, 2) + Math.pow(e.pageY - e2.pageY, 2) 283 | this.imgScale = Math.sqrt(scaleY) / Math.sqrt(scaleX) 284 | 285 | this.drawImage() 286 | } 287 | }) 288 | this.canvas.addEventListener('touchend', ($this) => { 289 | draging = false 290 | }) 291 | ``` 292 | 293 | 原理也很简单,就是先计算手势缩放前两个手指间的距离,再计算缩放后两个手指间的距离,最后将两个距离相除,得出缩放的比例,在绘制图片的时候,将图片的长和宽分别乘以比例就行了。 294 | 295 | 最终,完整的代码如下: 296 | 297 | ``` 298 | drag () { 299 | let draging = false 300 | 301 | // 记录初始点击的pageX,pageY。用于记录位移 302 | let pageX = 0 303 | let pageY = 0 304 | 305 | // 初始位移 306 | let startX = 0 307 | let startY = 0 308 | 309 | // 记录双指缩放的距离 310 | let scaleX = 0 311 | let scaleY = 0 312 | 313 | this.canvas.addEventListener('touchstart', (ev, $this) => { 314 | let e = ev.touches[0] 315 | let e2 = ev.touches[1] 316 | let finger = ev.touches.length 317 | 318 | draging = true 319 | 320 | if (finger === 2) { 321 | this.imgWidth = this.imgWidth * this.imgScale 322 | this.imgHeight = this.imgHeight * this.imgScale 323 | 324 | scaleX = Math.pow(e.pageX - e2.pageX, 2) + Math.pow(e.pageY - e2.pageY, 2) 325 | } else if (finger === 1) { 326 | pageX = e.pageX 327 | pageY = e.pageY 328 | 329 | startX = this.imgX 330 | startY = this.imgY 331 | } 332 | }) 333 | 334 | this.canvas.addEventListener('touchmove', (ev, $this) => { 335 | let e = ev.touches[0] 336 | let e2 = ev.touches[1] 337 | let finger = ev.touches.length 338 | 339 | if (draging) { 340 | if (finger === 2) { 341 | scaleY = Math.pow(e.pageX - e2.pageX, 2) + Math.pow(e.pageY - e2.pageY, 2) 342 | this.imgScale = Math.sqrt(scaleY) / Math.sqrt(scaleX) 343 | } else if (finger === 1) { 344 | this.imgX = e.pageX - pageX + startX 345 | this.imgY = e.pageY - pageY + startY 346 | } 347 | this.drawImage() 348 | } 349 | }) 350 | 351 | this.canvas.addEventListener('touchend', ($this) => { 352 | draging = false 353 | }) 354 | } 355 | ``` 356 | 357 | ### 绘制文字 358 | 359 | 在绘制文字的时候,canvas提供了一个属性叫textAlign,可以使绘制的文字根据给定的坐标居中绘制,只需要计算中轴线的X坐标即可,方便了许多。 360 | 361 | ``` 362 | drawName () { 363 | // 设置文字的字体大小 364 | var fontSize = 16 * window.devicePixelRatio 365 | this.ctx.font = 'bold ' + fontSize + 'px SimSun' 366 | // 设置文字的颜色 367 | this.ctx.fillStyle = '#172A88' 368 | // 设置文字的对齐方式 369 | this.ctx.textAlign = 'center' 370 | // 设置文字具体坐标位置 371 | var textX 372 | var textY 373 | switch (this.templateIndex) { 374 | case 1: 375 | textX = this.canvas.width * 3.16 / 4 376 | textY = this.canvas.height * 6.08 / 11 377 | break 378 | case 2: 379 | textX = this.canvas.width * 0.68 / 4 380 | textY = this.canvas.height * 6.03 / 11 381 | break 382 | case 3: 383 | textX = this.canvas.width * 0.80 / 4 384 | textY = this.canvas.height * 5.93 / 11 385 | break 386 | default: 387 | } 388 | // 绘画字体 389 | this.ctx.fillText(this.keyword, textX, textY) 390 | } 391 | ``` 392 | 393 | 这里由于需求有三个模版,因此按屏幕比例给定了三个不同的文字起始坐标,实际的坐标可以根据具体情况自行进行计算。 394 | 395 | ### 生成海报 396 | 397 | 同样通过toDataURL()方法将canvas的内容转化成包含图片展示的 data URI,再将这个URI赋给图片的src。 398 | 399 | ``` 400 | generatePost () { 401 | this.$refs.myImg.src = this.canvas.toDataURL('image/png') 402 | } 403 | ``` 404 | -------------------------------------------------------------------------------- /build/build.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | require('./check-versions')() 3 | 4 | process.env.NODE_ENV = 'production' 5 | 6 | const ora = require('ora') 7 | const rm = require('rimraf') 8 | const path = require('path') 9 | const chalk = require('chalk') 10 | const webpack = require('webpack') 11 | const config = require('../config') 12 | const webpackConfig = require('./webpack.prod.conf') 13 | 14 | const spinner = ora('building for production...') 15 | spinner.start() 16 | 17 | rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => { 18 | if (err) throw err 19 | webpack(webpackConfig, (err, stats) => { 20 | spinner.stop() 21 | if (err) throw err 22 | process.stdout.write(stats.toString({ 23 | colors: true, 24 | modules: false, 25 | children: false, // If you are using ts-loader, setting this to true will make TypeScript errors show up during build. 26 | chunks: false, 27 | chunkModules: false 28 | }) + '\n\n') 29 | 30 | if (stats.hasErrors()) { 31 | console.log(chalk.red(' Build failed with errors.\n')) 32 | process.exit(1) 33 | } 34 | 35 | console.log(chalk.cyan(' Build complete.\n')) 36 | console.log(chalk.yellow( 37 | ' Tip: built files are meant to be served over an HTTP server.\n' + 38 | ' Opening index.html over file:// won\'t work.\n' 39 | )) 40 | }) 41 | }) 42 | -------------------------------------------------------------------------------- /build/check-versions.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const chalk = require('chalk') 3 | const semver = require('semver') 4 | const packageConfig = require('../package.json') 5 | const shell = require('shelljs') 6 | 7 | function exec (cmd) { 8 | return require('child_process').execSync(cmd).toString().trim() 9 | } 10 | 11 | const versionRequirements = [ 12 | { 13 | name: 'node', 14 | currentVersion: semver.clean(process.version), 15 | versionRequirement: packageConfig.engines.node 16 | } 17 | ] 18 | 19 | if (shell.which('npm')) { 20 | versionRequirements.push({ 21 | name: 'npm', 22 | currentVersion: exec('npm --version'), 23 | versionRequirement: packageConfig.engines.npm 24 | }) 25 | } 26 | 27 | module.exports = function () { 28 | const warnings = [] 29 | 30 | for (let i = 0; i < versionRequirements.length; i++) { 31 | const mod = versionRequirements[i] 32 | 33 | if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) { 34 | warnings.push(mod.name + ': ' + 35 | chalk.red(mod.currentVersion) + ' should be ' + 36 | chalk.green(mod.versionRequirement) 37 | ) 38 | } 39 | } 40 | 41 | if (warnings.length) { 42 | console.log('') 43 | console.log(chalk.yellow('To use this template, you must update following to modules:')) 44 | console.log() 45 | 46 | for (let i = 0; i < warnings.length; i++) { 47 | const warning = warnings[i] 48 | console.log(' ' + warning) 49 | } 50 | 51 | console.log() 52 | process.exit(1) 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /build/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/JustinWang23/vue-canvas-poster/bc6e40cfd2983d1dce89cfb83b8340b02be4c1dd/build/logo.png -------------------------------------------------------------------------------- /build/utils.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const config = require('../config') 4 | const ExtractTextPlugin = require('extract-text-webpack-plugin') 5 | const packageConfig = require('../package.json') 6 | 7 | exports.assetsPath = function (_path) { 8 | const assetsSubDirectory = process.env.NODE_ENV === 'production' 9 | ? config.build.assetsSubDirectory 10 | : config.dev.assetsSubDirectory 11 | 12 | return path.posix.join(assetsSubDirectory, _path) 13 | } 14 | 15 | exports.cssLoaders = function (options) { 16 | options = options || {} 17 | 18 | const cssLoader = { 19 | loader: 'css-loader', 20 | options: { 21 | sourceMap: options.sourceMap 22 | } 23 | } 24 | 25 | const postcssLoader = { 26 | loader: 'postcss-loader', 27 | options: { 28 | sourceMap: options.sourceMap 29 | } 30 | } 31 | 32 | // generate loader string to be used with extract text plugin 33 | function generateLoaders (loader, loaderOptions) { 34 | const loaders = options.usePostCSS ? [cssLoader, postcssLoader] : [cssLoader] 35 | 36 | if (loader) { 37 | loaders.push({ 38 | loader: loader + '-loader', 39 | options: Object.assign({}, loaderOptions, { 40 | sourceMap: options.sourceMap 41 | }) 42 | }) 43 | } 44 | 45 | // Extract CSS when that option is specified 46 | // (which is the case during production build) 47 | if (options.extract) { 48 | return ExtractTextPlugin.extract({ 49 | use: loaders, 50 | fallback: 'vue-style-loader' 51 | }) 52 | } else { 53 | return ['vue-style-loader'].concat(loaders) 54 | } 55 | } 56 | 57 | // https://vue-loader.vuejs.org/en/configurations/extract-css.html 58 | return { 59 | css: generateLoaders(), 60 | postcss: generateLoaders(), 61 | less: generateLoaders('less'), 62 | sass: generateLoaders('sass', { indentedSyntax: true }), 63 | scss: generateLoaders('sass'), 64 | stylus: generateLoaders('stylus'), 65 | styl: generateLoaders('stylus') 66 | } 67 | } 68 | 69 | // Generate loaders for standalone style files (outside of .vue) 70 | exports.styleLoaders = function (options) { 71 | const output = [] 72 | const loaders = exports.cssLoaders(options) 73 | 74 | for (const extension in loaders) { 75 | const loader = loaders[extension] 76 | output.push({ 77 | test: new RegExp('\\.' + extension + '$'), 78 | use: loader 79 | }) 80 | } 81 | 82 | return output 83 | } 84 | 85 | exports.createNotifierCallback = () => { 86 | const notifier = require('node-notifier') 87 | 88 | return (severity, errors) => { 89 | if (severity !== 'error') return 90 | 91 | const error = errors[0] 92 | const filename = error.file && error.file.split('!').pop() 93 | 94 | notifier.notify({ 95 | title: packageConfig.name, 96 | message: severity + ': ' + error.name, 97 | subtitle: filename || '', 98 | icon: path.join(__dirname, 'logo.png') 99 | }) 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /build/vue-loader.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const utils = require('./utils') 3 | const config = require('../config') 4 | const isProduction = process.env.NODE_ENV === 'production' 5 | const sourceMapEnabled = isProduction 6 | ? config.build.productionSourceMap 7 | : config.dev.cssSourceMap 8 | 9 | module.exports = { 10 | loaders: utils.cssLoaders({ 11 | sourceMap: sourceMapEnabled, 12 | extract: isProduction 13 | }), 14 | cssSourceMap: sourceMapEnabled, 15 | cacheBusting: config.dev.cacheBusting, 16 | transformToRequire: { 17 | video: ['src', 'poster'], 18 | source: 'src', 19 | img: 'src', 20 | image: 'xlink:href' 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /build/webpack.base.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const utils = require('./utils') 4 | const config = require('../config') 5 | const vueLoaderConfig = require('./vue-loader.conf') 6 | 7 | function resolve (dir) { 8 | return path.join(__dirname, '..', dir) 9 | } 10 | 11 | const createLintingRule = () => ({ 12 | test: /\.(js|vue)$/, 13 | loader: 'eslint-loader', 14 | enforce: 'pre', 15 | include: [resolve('src'), resolve('test')], 16 | options: { 17 | formatter: require('eslint-friendly-formatter'), 18 | emitWarning: !config.dev.showEslintErrorsInOverlay 19 | } 20 | }) 21 | 22 | module.exports = { 23 | context: path.resolve(__dirname, '../'), 24 | entry: { 25 | app: './src/main.js' 26 | }, 27 | output: { 28 | path: config.build.assetsRoot, 29 | filename: '[name].js', 30 | publicPath: process.env.NODE_ENV === 'production' 31 | ? config.build.assetsPublicPath 32 | : config.dev.assetsPublicPath 33 | }, 34 | resolve: { 35 | extensions: ['.js', '.vue', '.json'], 36 | alias: { 37 | 'vue$': 'vue/dist/vue.esm.js', 38 | '@': resolve('src'), 39 | } 40 | }, 41 | module: { 42 | rules: [ 43 | ...(config.dev.useEslint ? [createLintingRule()] : []), 44 | { 45 | test: /\.vue$/, 46 | loader: 'vue-loader', 47 | options: vueLoaderConfig 48 | }, 49 | { 50 | test: /\.js$/, 51 | loader: 'babel-loader', 52 | include: [resolve('src'), resolve('test'), resolve('node_modules/webpack-dev-server/client')] 53 | }, 54 | { 55 | test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, 56 | loader: 'url-loader', 57 | options: { 58 | limit: 10000, 59 | name: utils.assetsPath('img/[name].[hash:7].[ext]') 60 | } 61 | }, 62 | { 63 | test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/, 64 | loader: 'url-loader', 65 | options: { 66 | limit: 10000, 67 | name: utils.assetsPath('media/[name].[hash:7].[ext]') 68 | } 69 | }, 70 | { 71 | test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, 72 | loader: 'url-loader', 73 | options: { 74 | limit: 10000, 75 | name: utils.assetsPath('fonts/[name].[hash:7].[ext]') 76 | } 77 | } 78 | ] 79 | }, 80 | node: { 81 | // prevent webpack from injecting useless setImmediate polyfill because Vue 82 | // source contains it (although only uses it if it's native). 83 | setImmediate: false, 84 | // prevent webpack from injecting mocks to Node native modules 85 | // that does not make sense for the client 86 | dgram: 'empty', 87 | fs: 'empty', 88 | net: 'empty', 89 | tls: 'empty', 90 | child_process: 'empty' 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /build/webpack.dev.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const utils = require('./utils') 3 | const webpack = require('webpack') 4 | const config = require('../config') 5 | const merge = require('webpack-merge') 6 | const path = require('path') 7 | const baseWebpackConfig = require('./webpack.base.conf') 8 | const CopyWebpackPlugin = require('copy-webpack-plugin') 9 | const HtmlWebpackPlugin = require('html-webpack-plugin') 10 | const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin') 11 | const portfinder = require('portfinder') 12 | 13 | const HOST = process.env.HOST 14 | const PORT = process.env.PORT && Number(process.env.PORT) 15 | 16 | const devWebpackConfig = merge(baseWebpackConfig, { 17 | module: { 18 | rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap, usePostCSS: true }) 19 | }, 20 | // cheap-module-eval-source-map is faster for development 21 | devtool: config.dev.devtool, 22 | 23 | // these devServer options should be customized in /config/index.js 24 | devServer: { 25 | clientLogLevel: 'warning', 26 | historyApiFallback: { 27 | rewrites: [ 28 | { from: /.*/, to: path.posix.join(config.dev.assetsPublicPath, 'index.html') }, 29 | ], 30 | }, 31 | hot: true, 32 | contentBase: false, // since we use CopyWebpackPlugin. 33 | compress: true, 34 | host: HOST || config.dev.host, 35 | port: PORT || config.dev.port, 36 | open: config.dev.autoOpenBrowser, 37 | overlay: config.dev.errorOverlay 38 | ? { warnings: false, errors: true } 39 | : false, 40 | publicPath: config.dev.assetsPublicPath, 41 | proxy: config.dev.proxyTable, 42 | quiet: true, // necessary for FriendlyErrorsPlugin 43 | watchOptions: { 44 | poll: config.dev.poll, 45 | } 46 | }, 47 | plugins: [ 48 | new webpack.DefinePlugin({ 49 | 'process.env': require('../config/dev.env') 50 | }), 51 | new webpack.HotModuleReplacementPlugin(), 52 | new webpack.NamedModulesPlugin(), // HMR shows correct file names in console on update. 53 | new webpack.NoEmitOnErrorsPlugin(), 54 | // https://github.com/ampedandwired/html-webpack-plugin 55 | new HtmlWebpackPlugin({ 56 | filename: 'index.html', 57 | template: 'index.html', 58 | inject: true 59 | }), 60 | // copy custom static assets 61 | new CopyWebpackPlugin([ 62 | { 63 | from: path.resolve(__dirname, '../static'), 64 | to: config.dev.assetsSubDirectory, 65 | ignore: ['.*'] 66 | } 67 | ]) 68 | ] 69 | }) 70 | 71 | module.exports = new Promise((resolve, reject) => { 72 | portfinder.basePort = process.env.PORT || config.dev.port 73 | portfinder.getPort((err, port) => { 74 | if (err) { 75 | reject(err) 76 | } else { 77 | // publish the new Port, necessary for e2e tests 78 | process.env.PORT = port 79 | // add port to devServer config 80 | devWebpackConfig.devServer.port = port 81 | 82 | // Add FriendlyErrorsPlugin 83 | devWebpackConfig.plugins.push(new FriendlyErrorsPlugin({ 84 | compilationSuccessInfo: { 85 | messages: [`Your application is running here: http://${devWebpackConfig.devServer.host}:${port}`], 86 | }, 87 | onErrors: config.dev.notifyOnErrors 88 | ? utils.createNotifierCallback() 89 | : undefined 90 | })) 91 | 92 | resolve(devWebpackConfig) 93 | } 94 | }) 95 | }) 96 | -------------------------------------------------------------------------------- /build/webpack.prod.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const utils = require('./utils') 4 | const webpack = require('webpack') 5 | const config = require('../config') 6 | const merge = require('webpack-merge') 7 | const baseWebpackConfig = require('./webpack.base.conf') 8 | const CopyWebpackPlugin = require('copy-webpack-plugin') 9 | const HtmlWebpackPlugin = require('html-webpack-plugin') 10 | const ExtractTextPlugin = require('extract-text-webpack-plugin') 11 | const OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin') 12 | const UglifyJsPlugin = require('uglifyjs-webpack-plugin') 13 | 14 | const env = require('../config/prod.env') 15 | 16 | const webpackConfig = merge(baseWebpackConfig, { 17 | module: { 18 | rules: utils.styleLoaders({ 19 | sourceMap: config.build.productionSourceMap, 20 | extract: true, 21 | usePostCSS: true 22 | }) 23 | }, 24 | devtool: config.build.productionSourceMap ? config.build.devtool : false, 25 | output: { 26 | path: config.build.assetsRoot, 27 | filename: utils.assetsPath('js/[name].[chunkhash].js'), 28 | chunkFilename: utils.assetsPath('js/[id].[chunkhash].js') 29 | }, 30 | plugins: [ 31 | // http://vuejs.github.io/vue-loader/en/workflow/production.html 32 | new webpack.DefinePlugin({ 33 | 'process.env': env 34 | }), 35 | new UglifyJsPlugin({ 36 | uglifyOptions: { 37 | compress: { 38 | warnings: false 39 | } 40 | }, 41 | sourceMap: config.build.productionSourceMap, 42 | parallel: true 43 | }), 44 | // extract css into its own file 45 | new ExtractTextPlugin({ 46 | filename: utils.assetsPath('css/[name].[contenthash].css'), 47 | // Setting the following option to `false` will not extract CSS from codesplit chunks. 48 | // Their CSS will instead be inserted dynamically with style-loader when the codesplit chunk has been loaded by webpack. 49 | // It's currently set to `true` because we are seeing that sourcemaps are included in the codesplit bundle as well when it's `false`, 50 | // increasing file size: https://github.com/vuejs-templates/webpack/issues/1110 51 | allChunks: true, 52 | }), 53 | // Compress extracted CSS. We are using this plugin so that possible 54 | // duplicated CSS from different components can be deduped. 55 | new OptimizeCSSPlugin({ 56 | cssProcessorOptions: config.build.productionSourceMap 57 | ? { safe: true, map: { inline: false } } 58 | : { safe: true } 59 | }), 60 | // generate dist index.html with correct asset hash for caching. 61 | // you can customize output by editing /index.html 62 | // see https://github.com/ampedandwired/html-webpack-plugin 63 | new HtmlWebpackPlugin({ 64 | filename: config.build.index, 65 | template: 'index.html', 66 | inject: true, 67 | minify: { 68 | removeComments: true, 69 | collapseWhitespace: true, 70 | removeAttributeQuotes: true 71 | // more options: 72 | // https://github.com/kangax/html-minifier#options-quick-reference 73 | }, 74 | // necessary to consistently work with multiple chunks via CommonsChunkPlugin 75 | chunksSortMode: 'dependency' 76 | }), 77 | // keep module.id stable when vendor modules does not change 78 | new webpack.HashedModuleIdsPlugin(), 79 | // enable scope hoisting 80 | new webpack.optimize.ModuleConcatenationPlugin(), 81 | // split vendor js into its own file 82 | new webpack.optimize.CommonsChunkPlugin({ 83 | name: 'vendor', 84 | minChunks (module) { 85 | // any required modules inside node_modules are extracted to vendor 86 | return ( 87 | module.resource && 88 | /\.js$/.test(module.resource) && 89 | module.resource.indexOf( 90 | path.join(__dirname, '../node_modules') 91 | ) === 0 92 | ) 93 | } 94 | }), 95 | // extract webpack runtime and module manifest to its own file in order to 96 | // prevent vendor hash from being updated whenever app bundle is updated 97 | new webpack.optimize.CommonsChunkPlugin({ 98 | name: 'manifest', 99 | minChunks: Infinity 100 | }), 101 | // This instance extracts shared chunks from code splitted chunks and bundles them 102 | // in a separate chunk, similar to the vendor chunk 103 | // see: https://webpack.js.org/plugins/commons-chunk-plugin/#extra-async-commons-chunk 104 | new webpack.optimize.CommonsChunkPlugin({ 105 | name: 'app', 106 | async: 'vendor-async', 107 | children: true, 108 | minChunks: 3 109 | }), 110 | 111 | // copy custom static assets 112 | new CopyWebpackPlugin([ 113 | { 114 | from: path.resolve(__dirname, '../static'), 115 | to: config.build.assetsSubDirectory, 116 | ignore: ['.*'] 117 | } 118 | ]) 119 | ] 120 | }) 121 | 122 | if (config.build.productionGzip) { 123 | const CompressionWebpackPlugin = require('compression-webpack-plugin') 124 | 125 | webpackConfig.plugins.push( 126 | new CompressionWebpackPlugin({ 127 | asset: '[path].gz[query]', 128 | algorithm: 'gzip', 129 | test: new RegExp( 130 | '\\.(' + 131 | config.build.productionGzipExtensions.join('|') + 132 | ')$' 133 | ), 134 | threshold: 10240, 135 | minRatio: 0.8 136 | }) 137 | ) 138 | } 139 | 140 | if (config.build.bundleAnalyzerReport) { 141 | const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin 142 | webpackConfig.plugins.push(new BundleAnalyzerPlugin()) 143 | } 144 | 145 | module.exports = webpackConfig 146 | -------------------------------------------------------------------------------- /config/dev.env.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const merge = require('webpack-merge') 3 | const prodEnv = require('./prod.env') 4 | 5 | module.exports = merge(prodEnv, { 6 | NODE_ENV: '"development"' 7 | }) 8 | -------------------------------------------------------------------------------- /config/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | // Template version: 1.3.1 3 | // see http://vuejs-templates.github.io/webpack for documentation. 4 | 5 | const path = require('path') 6 | 7 | module.exports = { 8 | dev: { 9 | 10 | // Paths 11 | assetsSubDirectory: 'static', 12 | assetsPublicPath: '/', 13 | proxyTable: {}, 14 | 15 | // Various Dev Server settings 16 | host: '0.0.0.0', // can be overwritten by process.env.HOST 17 | port: 8080, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined 18 | autoOpenBrowser: false, 19 | errorOverlay: true, 20 | notifyOnErrors: true, 21 | poll: false, // https://webpack.js.org/configuration/dev-server/#devserver-watchoptions- 22 | 23 | // Use Eslint Loader? 24 | // If true, your code will be linted during bundling and 25 | // linting errors and warnings will be shown in the console. 26 | useEslint: true, 27 | // If true, eslint errors and warnings will also be shown in the error overlay 28 | // in the browser. 29 | showEslintErrorsInOverlay: false, 30 | 31 | /** 32 | * Source Maps 33 | */ 34 | 35 | // https://webpack.js.org/configuration/devtool/#development 36 | devtool: 'cheap-module-eval-source-map', 37 | 38 | // If you have problems debugging vue-files in devtools, 39 | // set this to false - it *may* help 40 | // https://vue-loader.vuejs.org/en/options.html#cachebusting 41 | cacheBusting: true, 42 | 43 | cssSourceMap: true 44 | }, 45 | 46 | build: { 47 | // Template for index.html 48 | index: path.resolve(__dirname, '../dist/index.html'), 49 | 50 | // Paths 51 | assetsRoot: path.resolve(__dirname, '../dist'), 52 | assetsSubDirectory: 'static', 53 | assetsPublicPath: './', 54 | 55 | /** 56 | * Source Maps 57 | */ 58 | 59 | productionSourceMap: true, 60 | // https://webpack.js.org/configuration/devtool/#production 61 | devtool: '#source-map', 62 | 63 | // Gzip off by default as many popular static hosts such as 64 | // Surge or Netlify already gzip all static assets for you. 65 | // Before setting to `true`, make sure to: 66 | // npm install --save-dev compression-webpack-plugin 67 | productionGzip: false, 68 | productionGzipExtensions: ['js', 'css'], 69 | 70 | // Run the build command with an extra argument to 71 | // View the bundle analyzer report after build finishes: 72 | // `npm run build --report` 73 | // Set to `true` or `false` to always turn it on or off 74 | bundleAnalyzerReport: process.env.npm_config_report 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /config/prod.env.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | module.exports = { 3 | NODE_ENV: '"production"' 4 | } 5 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 | 5 | 6 |
7 |
11 |
14 |
17 |
20 |
28 |