- API 路由统一: 移除 /api/h5/,统一 /api/pms/ 入口 - 二进制改名: api-server -> pms-api(与服务名一致) - nginx: 合并 /api/ + /pms/api/ 为 /api/pms/ - 新增 docs/API.md 接口文档 - 后端: CabinetDetail 增加 rssi/pow_fail/address/soc 等字段 - Redis 管道批量读取仓体实时数据(SOC/电压/电流/功率) - DB: 所有 TIMESTAMP 列改为 DATETIME(修复类型不匹配) - 用户管理: 新增创建时间/修改时间列,状态改用 Switch - 角色管理/用户管理: 操作按钮改为图标 - PC 设备详情: 基本信息补全 RSSI/ICCID/电源/地址 - PC 卡片: 通道统计改用 Lucide 图标,颜色统一 - PC 二维码: canvas 渲染,含编号文字,支持右键下载 - H5: 按 uni-app 规范修正导航(navigateTo 替代 reLaunch) - H5: 详情页加返回导航条 - H5: 扫码支持摄像头(jsQR)+ ?id= 参数 - H5: 底部 tabBar 在所有页面常显 - H5: 首页统计改为 6 项(设备/通道/空闲/充电/充满/故障) - H5: 下拉刷新 / 上拉加载 - 产品首页: 添加业务联系 - 文档: 清理过时文件,补充缺失规范章节
3.1 KiB
3.1 KiB
title, impact, impactDescription, type, tags
| title | impact | impactDescription | type | tags | |||||
|---|---|---|---|---|---|---|---|---|---|
| Use PascalCase for Component Names | LOW | Improves code clarity and IDE support, but both cases work | best-practice |
|
Use PascalCase for Component Names
Impact: LOW - Vue supports both PascalCase (<MyComponent>) and kebab-case (<my-component>) in templates, but PascalCase is recommended. It provides better IDE support, clearly distinguishes Vue components from native HTML elements, and avoids confusion with web components (custom elements).
Task Checklist
- Name component files in PascalCase (e.g.,
UserProfile.vue) - Use PascalCase when referencing components in templates
- Use kebab-case only when required (in-DOM templates)
- Be consistent across the entire codebase
Less Ideal:
<script setup>
import userProfile from './user-profile.vue'
</script>
<template>
<!-- Works but harder to distinguish from HTML elements -->
<user-profile :user="currentUser" />
<header>Native HTML</header>
<footer>Native HTML</footer>
</template>
Recommended:
<script setup>
import UserProfile from './UserProfile.vue'
</script>
<template>
<!-- Clear visual distinction: components vs HTML elements -->
<UserProfile :user="currentUser" />
<header>Native HTML</header>
<footer>Native HTML</footer>
</template>
Why PascalCase?
1. Visual Distinction
<template>
<!-- Immediately clear what's a component vs native HTML -->
<PageHeader /> <!-- Component -->
<header>...</header> <!-- Native HTML -->
<NavigationMenu /> <!-- Component -->
<nav>...</nav> <!-- Native HTML -->
<UserAvatar /> <!-- Component -->
<img src="..." /> <!-- Native HTML -->
</template>
2. IDE Auto-completion
PascalCase names are valid JavaScript identifiers, enabling better IDE support:
- Auto-import suggestions
- Go-to-definition
- Refactoring tools
3. Avoids Web Component Confusion
Web Components (custom elements) require kebab-case with a hyphen. Using PascalCase for Vue components avoids any confusion:
<template>
<!-- Vue component -->
<MyButton @click="handle" />
<!-- Web component (custom element) -->
<my-custom-element></my-custom-element>
</template>
Exception: In-DOM Templates
When using in-DOM templates (HTML files without build step), you MUST use kebab-case because HTML is case-insensitive:
<!-- index.html - in-DOM template -->
<div id="app">
<!-- PascalCase won't work in HTML files -->
<!-- <UserProfile></UserProfile> --> <!-- WRONG -->
<!-- Must use kebab-case -->
<user-profile :user="currentUser"></user-profile>
</div>
Vue's Automatic Resolution
Vue automatically resolves PascalCase components to both casings:
<script setup>
import MyComponent from './MyComponent.vue'
</script>
<template>
<!-- Both work, but PascalCase is preferred -->
<MyComponent />
<my-component />
</template>