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/中的内容。

相关推荐
不好听6135 分钟前
useState 完全解析:初始化、异步更新、以及为什么传函数能解决闭包问题
前端·react.js
神明不懂浪漫2 小时前
【第七章】Java中的常用类
java·开发语言·前端·经验分享·笔记
GuWenyue7 小时前
放弃云端API!一套React+WebGPU本地LLM方案,零数据上传、离线可用
前端·人工智能·前端框架
原则猫9 小时前
函数/变量提升
前端
独泪了无痕9 小时前
Vue3 Hooks使用实战解析
前端·vue.js
shawxlee11 小时前
vue3在public下封装config.js自定义配置动态数据,可在打包后直接修改,方便后端部署及后续维护
前端·javascript·经验分享·vue·团队开发·js·项目优化
用户0595401744611 小时前
把记忆存储的回归测试从手工换成 Playwright + GitHub Actions,线上缺陷降低 80%
前端·css
触底反弹11 小时前
🚀 从 DOM0 级到 React 合成事件:前端事件监听的 20 年演进史
前端·react.js·面试
kyriewen11 小时前
我给前端项目的接口请求套了6层保护——才发现以前一直在裸奔
前端·javascript·面试
颜酱11 小时前
04 | 召回前置准备:搭好召回所需的四个数据库
前端·人工智能·后端