@wanyunfront/wdy-front-core NPM

文档地址

# 注：YAML不支持数组同时作为对象，以下只是为了方便表达
wdy-entry:
  - package.json										# npm包配置
  - vite.config.ts									# vite配置
  - tsconfig.json										# typescript配置
  - index.html											# 运行时基础的html
	src:
  	- index.ts											# 解析二级域名，调用wdy-core的逻辑实现

# 注：wdy-core下所有的index.ts都只用于重导当前目录下的模块
wdy-core:
  - package.json										# npm包配置
  - vite.config.ts									# vite配置
  - tsconfig.json										# typescript配置
  src:															# 源代码目录
  	- index.ts
    base:														# 基础实现目录
      - index.ts
      - app.ts											# 应用的实现
      - page.ts											# 基础页面
      - component.ts								# 基础组件
      - variable.ts									# 基础变量
      - userpoll.ts									# 用户池
      - service.ts									# 基础服务
      - element.ts									# 元素
      - event.ts                                    # 消息机制
    render:													# 基础渲染器目录
      - index.ts
      - AppRender.tsx								# 应用的渲染器
      - EntryRender.tsx							# 单个路由的渲染器
      - PageRender.tsx							# 页面的渲染器
      - ComponentRender.tsx					# 组件的渲染器
    utils:													# 工具方法目录
    	- index.ts
    loader:													# 加载器目录
    	- index.ts
      - loader.ts										# 加载器实现
      - namespace.ts								# 命名空间实现

开发规范

命名规范

文件夹、变量命名、普通 ts、js 文件遵循小驼峰法命名

例如: commomConstants.ts

组件文件夹名、组件、类名遵循大驼峰法命名

例如: UserList

常量全部大些以下划线(_)连接

例如: FIELD_TYPS

css 命名全部小写，以中划线(-)连接

例如: user-list

名称只能由数字、字母、下划线、$符组成，不能以数字开头

尽量不要使用拼音或者英语掺杂拼音

例如：StudentDianHua || MyHomeDiZhi 等

尽量用有意义的英文命名

例如: 组件避免使用 index.tsx

尽量不缩写，除非一看就明白的单词

例如：wrapper 可以写成 wrap

注释

注释的书写的位置最好放在被描述的代码上行，或者右侧单行注释： // 注释内容多行注释：/* 注释内容 */ 文档注释：/** 注释内容 */

TODO和FIXME

要说明：谁、什么时间、TODO原因 #TODO {userName} {date} {description}，如：#TODO awen 20220525 这是TODO描述 #FIXME {userName} {date} {description}，如：#FIXME awen 20220525 这是FIXME描述