这是我参与「第四届青训营 」笔记创作活动的第2天。
上一篇笔记中我们使用 Vue CLI 工具创建了一个完整的 Vue 项目工程。是不是非常简单和方便呢?那么这篇笔记我们继续接着上一篇的话题,介绍 Vue CLI 创建的模板工程的目录结构,以及如何在项目中使用依赖。
模板项目工程的目录结构
如图所示,工程目录主要包含3个文件夹和7个主要文件。
7个主要文件
我们先看这7个文件:
- .gitignore
- babel.config.js
- package.json
- README.md
- jsconfig.json
- package-lock.json
- vue.config.js
一般来说每个Git项目中都需要一个.gitignore文件,这个文件的作用就是告诉Git哪些文件不需要添加到版本管理中。在创建工程时会默认配置好。
babel.config.js、vue.config.js分别是Babel和Vue的配置文件,一般不需要修改。
package.json 存储一个 JSON 对象,记录当前项目所依赖模块的版本信息,更新模块时锁定模块的大版本号(版本号的第一位),不能锁定后面的小版本。当我们需要向项目中添加额外的依赖时,就会被记录到这个文件中。目前该模板工程的生产环境依赖为:
"dependencies": {
"core-js": "^3.8.3",
"vue": "^3.2.13"
},
开发环境的依赖是:
"devDependencies": {
"@babel/core": "^7.12.16",
"@babel/eslint-parser": "^7.12.16",
"@vue/cli-plugin-babel": "~5.0.0",
"@vue/cli-plugin-eslint": "~5.0.0",
"@vue/cli-service": "~5.0.0",
"eslint": "^7.32.0",
"eslint-plugin-vue": "^8.0.3"
},
README.md是一个MarkDown格式的文件,其中默认是记录了项目的编译和调试模式。我们也可以加入自己的项目说明。
jsconfig.json,说白了就是提高在写项目时舒适度的,一般不用修改。
package-lock.json是在 npm install时候生成一份文件。记录了node_modules目录下所有模块(包)的名称、版本号、下载地址、及这个模块又依赖了哪些依赖。
3个文件夹
然后我们再来看一下默认生成的三个文件夹:
- node_modules
- public
- src
node_modules是安装node后用来存放用包管理工具下载安装的包的文件夹。比如webpack、gulp、grunt这些工具。npm install 执行完毕后,我们可以在 node_modules 中看到所有依赖的包。
public用来放置一些公有的资源文件,例如网页用到的图标、静态HTML文件等。
src是一个重要的文件夹,核心功能代码文件都放在这个文件夹下。在默认的模板工程中,该文件夹下还有两个子文件夹:asserts和components,前者存放资源文件,后者存放组件文件。
在public文件夹下有一个index.html文件,是网页的入口文件,会挂载根组件到id为“app”的div标签上。
main.js是应用程序的入口文件,里面是组件创建和挂载的相关逻辑。
import { createApp } from 'vue'
import App from './App.vue'
createApp(App).mount('#app')
根组件App被单独的放在App.vue文件中:
<template>
<img alt="Vue logo" src="./assets/logo.png">
<HelloWorld msg="Welcome to Your Vue.js App"/>
</template>
<script>
import HelloWorld from './components/HelloWorld.vue'
export default {
name: 'App',
components: {
HelloWorld
}
}
</script>
<style>
#app {
font-family: Avenir, Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
}
</style>
根组件通常需要定义3部分内容:template模板部分、script脚本代码部分和style样式代码部分。