umi使用-文件介绍

umi脚手架文件作用解析

使用npx create-umi可以方便的创建出一个umi项目,本文就使用此脚手架生成项目的各个文件做以解析;通过阐述脚手架中的各个文件及其作用,能够对umi创建的项目有更深的理解。

0. node_modules/

存放项目依赖包和可执行脚本的目录。

1. .editorconfig

此文件用来提供编辑器相关的设置;因为不同的开发习惯使用的编辑器可能是不同的,所以需要此文件来统一代码风格。例如,缩进是4个空格还是2个空格等。

2. gitignore

此文件用来告诉git那些文件不会被管理。

3. .npmrc

npm的配置文件,一般来说会配置registry的地址,例如:

registry=https://registry.npmjs.org/

需要注意的是,如果registry的值不为https://registry.npmjs.org/, 那么使用npm login或者npm publish是会失败的!

4. .umirc.ts

umi项目的主配置文件,配置路由、mock等重要信息,是umi项目中最重要的文件。

5. package.json

项目中的包管理文件,重要性不言而喻。

6. tsconfig.json

typescript相关的配置文件,如设置规则等。

7. typings.d.ts

tsconfig.json文件的支持文件。

8. yarn.lock

用来锁定项目中使用的依赖的版本,以及这些依赖相互依赖的版本的文件。

9. src/

src目录下面存放相关的资源文件

9.1 .umi/

缓存文件的目录

9.2 assets/

存放图片等资源的目录

9.3 layouts/

存放布局文件相关的目录。由index.less和index.tsx组成,不是必须的

9.4. pages/

存放各个页面的目录,每一个页面放在一个单独的文件夹下面,这个文件夹中:放有index.tsx以此来提供页面组件;放有index.less来提供样式。

总结

在这些文件中,最为重要的是.umirc.tssrc/pages/

当然package.json也非常重要,但是其重要性不只体现在umi项目中,而是对于所有项目都很重要。

所以,后面会着重介绍.umirc.tssrc/pages/中的内容。

相关推荐
叫我一声阿雷吧几秒前
深入理解JavaScript作用域和闭包,解决变量访问问题
开发语言·javascript·ecmascript
顾北128 分钟前
AI对话应用接口开发全解析:同步接口+SSE流式+智能体+前端对接
前端·人工智能
iDao技术魔方20 分钟前
深入Vue 3响应式系统:为什么嵌套对象修改后界面不更新?
javascript·vue.js·ecmascript
历程里程碑25 分钟前
普通数组-----除了自身以外数组的乘积
大数据·javascript·python·算法·elasticsearch·搜索引擎·flask
摸鱼的春哥25 分钟前
春哥的Agent通关秘籍07:5分钟实现文件归类助手【实战】
前端·javascript·后端
念念不忘 必有回响29 分钟前
viepress:vue组件展示和源码功能
前端·javascript·vue.js
Amumu1213832 分钟前
Vue3 Composition API(一)
开发语言·javascript·ecmascript
C澒34 分钟前
多场景多角色前端架构方案:基于页面协议化与模块标准化的通用能力沉淀
前端·架构·系统架构·前端框架
崔庆才丨静觅35 分钟前
稳定好用的 ADSL 拨号代理,就这家了!
前端
江湖有缘37 分钟前
Docker部署music-tag-web音乐标签编辑器
前端·docker·编辑器