# template

**Repository Path**: happychl/template

## Basic Information

- **Project Name**: template
- **Description**: 模板项目
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-15
- **Last Updated**: 2022-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# template

> 规范模板项目

## 配置

### vscode 必选插件

- EditorConfig 支持：EditorConfig for VS Code
- Prettier 代码格式化：Prettier - Code formatter
- Eslint 代码检查：ESLint
- Stylelint 样式检查：Stylelint

### vscode 选装插件

- 汉化包：Chinese (Simplified) Language Pack for Visual Studio Code
- JetBrains 键盘映射：JetBrains IDE Keymap
- 行内查看 git 提交记录：GitLens — Git supercharged
- 文件头部注释和函数注释：koroFileHeader
- vue 工具：Vetur

```json
// 添加到用户配置
// 文件头部注释，将Author和LastEditors改为自己的名字
// 快捷键：ctrl+alt+i
"fileheader.customMade": {
    "Date": "Do not edit",
    "Version": "1.0.0",
    "Author": "",
    "Description": "",
    "FilePath": "Do not edit",
    "LastEditTime": "Do not edit",
    "LastEditors": ""
},
// 取消自动添加头部注释
"fileheader.configObj": {
    "autoAdd": false
},
// 函数注释
// 快捷键：ctrl+alt+t
"fileheader.cursorMode": {
    "description": "",
    "param": "",
    "return": ""
}
```

### vscode 快捷键设置（视个人习惯配置）

- 格式化

```text
键盘快捷方式搜索 editor.action.formatDocument ，添加 ALT+L 快捷键
```

- 文件注释

```text
键盘快捷方式搜索键 ctrl+win+t ，添加 ALT+Z 快捷键
键盘快捷方式搜索键 ctrl+win+i ，添加 ALT+I 快捷键
```

### jsconfig.json

jsconfig.json 配置按项目配置自行调整，需搭配如 webpack 路径别名使用。