# ybhsfxt-cesium

**Repository Path**: wanghan506/ybhsfxt-cesium

## Basic Information

- **Project Name**: ybhsfxt-cesium
- **Description**: 宜宾最新参数
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-07
- **Last Updated**: 2025-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目开发规范

新需求从 master 分支拉一个开发分支，开发完成后合并到 test 分支

- feat: 新功能
- fix: 问题修复
- refactor: 涉及代码重构，一般和新功能、问题修复无关
- perf: 和性能相关的改造，如 perf/table 用来优化 table 展示性能
- chore: 构建或辅助工具调整，如 chore/upgrade-vite

## commit 规范

> 代码提交的 commit 按照这个来

- `build`：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
- `ci`：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle 等)的提交
- `docs`：文档更新
- `feat`：新增功能
- `merge`：分支合并 Merge branch ? of ?
- `fix`：bug 修复
- `perf`：性能, 体验优化
- `refactor`：重构代码(既没有新增功能，也没有修复 bug)
- `style`：不影响程序逻辑的代码修改(修改空白字符，格式缩进，补全缺失的分号等，没有改变代码逻辑)
- `test`：新增测试用例或是更新现有测试
- `revert`：回滚某个更早之前的提交
- `chore`：像构建脚本、辅助工具、文档生成等工程相关代码提交

## 文件命名规范

- 文件/文件夹 以小驼峰命名
- 局部 components 组件以大写驼峰命名
- 全局 components 组件文件夹内部文件默认 index.vue，方便引用
- 代码中严禁使用纯中文拼音，或中文拼音与英文混合的方式命名

## Vue 规范

- ESLint + Prettier 格式化代码保证团队代码风格一致
- [vscode 参考配置](/my/code/setting.html#vs-code-config)
- 组件文件夹内部文件默认 index.vue，方便引用
- 在 template 中使用组件，需使用大驼峰模式，并使用自闭合组件

  ```vue
  <template>
    <!-- 购物车 -->
    <ShoppingCart />
  </template>

  <script setup lang="ts">
  import ShoppingCart from './components/ShoppingCart.vue'
  </script>
  ```

- 每个 Vue 文件不超过 500 行，进行分层开发，保证每个功能模块的职能单一
- 将分属同一模块代码的代码进行拆分，模块之间相互隔离，在 Vue 项目中，可使用全局状态和 props 进行通信
- template 尽量简洁，抽离 template 里面的逻辑，可使用 computed 计算属性进行优化
- 不建议直接写行内样式
- Vue 不需要在模板中绑定的变量，不用响应式进行包装
- 指令使用缩写形式，用 : 表示 v-bind: 、用 @ 表示 v-on:

## TypeScript/JavaScript

- 给 interface 声明顺序，只读参数放第一位，必选参数第二位，然后是可选参数，不确定参数放最后
- 判断符号建议使用 === 和 !== 而非 == 和 != ，如条件过于复杂，建议封装判断条件，提升可读性
- 同个文件每个模块只允许 import 一次，有多个 import 请写在一起
- 尽量减少函数入参，函数入参不建议超过 4 个，超过 4 个请使用对象来聚合
- 尽量遵循单一职责，一个函数只干一件事，否则可能函数过于复杂，考虑拆分逻辑
- 尽量避免使用回调函数，建议 promise async await 风格代替 Promise 链式写法，提高可读性
- 慎用 any 类型，遵循 TypeScript 开发规范
- 申明变量 const 优先，用 let 代替 var， 变量命名使用小驼峰命名方式
- 修改接口返回的数据字段尽量与后端保持一致

## Css（Sass）

- css 命名规则，建议使用 [BEM](/my/css/news.html#css-bem-命名规范) 规范（模块-元素-修饰符）
- css 涉及到颜色值，先去查找 scss 全局变量，尤其是主题色；
- 尽量使用缩写属性
- 每个选择器及属性独占一行
- 省略 0 后面的单位
- 避免使用 ID 选择器及全局标签选择器防止污染全局样式
- 慎用！important；