项目规范
刀刀
0字
0分钟
2026/8/16
规范必要性
多人协作项目中，统一规范可避免代码风格冲突，明确本地改动范围，保障项目顺利推进与后续维护。规范范围涵盖目录结构、代码风格等。
文件夹规范
项目包含多个图层，需保持目录结构一致，便于排查与维护。
examples：存放一级路由组件，用于引入地图与本图层组件。src/components/Common：存放公共组件（如地图组件）。src/components/Layer：存放各图层专属组件。src下公共资源与图层私有资源分工：assets：静态资源（图片、字体等）。components：当前图层组件。store：多组件共享的变量与事件函数。utils：当前图层公共方法。config：当前图层枚举与字典。
router：定义图层路由。
路由别名配置
在 scripts/common.js 中定义别名映射：
javascript
export const aliasMap = {
'@TestLayer': './src/xxx/TestLayer',
}在 Vite 配置文件 vite.config.js 中应用：
javascript
import { aliasMap } from './scripts/common.js'
export default defineConfig(({ mode }) => {
return {
resolve: {
alias: {
'@Test': fileURLToPath(
new URL(aliasMap['@TestLayer'], import.meta.url),
),
},
},
}
})代码风格规范
通过配置 ESLint 和 Stylelint 统一代码风格（如分号、行宽、箭头函数括号等）。 在 VSCode 的 settings.json 中配置保存自动格式化：
json
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"eslint.validate": [
"javascript",
"javascriptreact",
"html",
"vue"
]WARNING
注意：若安装了 Prettier 等格式化扩展，需禁用以避免与 ESLint 冲突。
贡献者
duyidao 刀刀
v_duyilin