docs: 优化文档和注释中的单词大小写和语义

Author: pany-ang

.eslintignore

@@ -1,4 +1,4 @@
-# eslint 会忽略的文件
+# Eslint 会忽略的文件
 
 .DS_Store
 node_modules

.eslintrc.js

@@ -33,7 +33,7 @@ module.exports = {
     }
   },
   rules: {
-    // ts
+    // TS
     "@typescript-eslint/no-explicit-any": "off",
     "no-debugger": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
@@ -55,7 +55,7 @@ module.exports = {
         varsIgnorePattern: "^_"
       }
     ],
-    // vue
+    // Vue
     "vue/no-v-html": "off",
     "vue/require-default-prop": "off",
     "vue/require-explicit-emits": "off",
@@ -72,7 +72,7 @@ module.exports = {
         math: "always"
       }
     ],
-    // prettier
+    // Prettier
     "prettier/prettier": [
       "error",
       {

.gitignore

@@ -1,11 +1,11 @@
-# git 会忽略的文件
+# Git 会忽略的文件
 
 .DS_Store
 node_modules
 dist
 dist-ssr
 
-# local env files
+# Local env files
 *.local
 
 # Logs

.prettierignore

@@ -1,4 +1,4 @@
-# prettier 会忽略的文件
+# Prettier 会忽略的文件
 
 .DS_Store
 node_modules

README.md

@@ -2,9 +2,9 @@
 
 一个免费开源的中后台管理系统基础解决方案，基于 Vue3、TypeScript、Element-Plus、Pinia 和 Vite 等主流技术.
 
-模板代码是从 [v3-admin](https://github.com/un-pany/v3-admin) 迁移而来，脚手架从 vue-cli 5.x 切换到了 vite 2.9.x，并作了一些繁琐的适配.
+模板代码是从 [v3-admin](https://github.com/un-pany/v3-admin) 迁移而来，脚手架从 Vue-Cli 5.x 切换到了 Vite 2.9.x，并作了一些繁琐的适配.
 
-更推荐大家使用该 vite 版本！以后的重心也会从 [v3-admin](https://github.com/un-pany/v3-admin) 偏向本仓库.
+更推荐大家使用该 Vite 版本！以后的重心也会从 [v3-admin](https://github.com/un-pany/v3-admin) 偏向本仓库.
 
 - Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "v3-admin-vite",
-  "version": "3.1.9",
+  "version": "3.1.10",
   "description": "一个免费开源的中后台管理系统基础解决方案，基于 Vue3、TypeScript、Element-Plus、Pinia 和 Vite 等主流技术.",
   "author": {
     "name": "pany",

prettier.config.js

@@ -2,9 +2,9 @@
 module.exports = {
   /** 每一行的宽度 */
   printWidth: 120,
-  /** tab 健的空格数 */
+  /** Tab 键的空格数 */
   tabWidth: 2,
-  /** 在对象中的括号之间用空格来间隔 */
+  /** 在对象中的括号之间是否用空格来间隔 */
   bracketSpacing: true,
   /** 箭头函数的参数无论有几个，都要括号包裹 */
   arrowParens: "always",
@@ -14,8 +14,8 @@ module.exports = {
   singleQuote: false,
   /** 对象或者数组的最后一个元素后面不要加逗号 */
   trailingComma: "none",
-  /** 不加分号 */
+  /** 是否加分号 */
   semi: false,
-  /** 不使用 tab 格式化 */
+  /** 是否使用 Tab 格式化 */
   useTabs: false
 }

src/App.vue

@@ -2,8 +2,8 @@
 import { useAppStore } from "@/store/modules/app"
 import zhCn from "element-plus/lib/locale/lang/zh-cn"
 
-useAppStore().initTheme() // 初始化 theme
-const locale = zhCn // element-plus 设置为中文
+useAppStore().initTheme() // 初始化主题
+const locale = zhCn // 将 Element-Plus 的语言设置为中文
 </script>
 
 <template>

src/config/layout.ts

@@ -1,16 +1,16 @@
 /** 布局配置 */
 interface ILayoutSettings {
-  /** 控制 settings panel 显示 */
+  /** 是否显示 Settings Panel */
   showSettings: boolean
-  /** 控制 tagsview 显示 */
+  /** 是否显示标签栏 */
   showTagsView: boolean
-  /** 控制 siderbar logo 显示 */
+  /** 是否显示侧边栏 Logo */
   showSidebarLogo: boolean
-  /** 如果为真，将固定 header */
+  /** 是否固定 Header */
   fixedHeader: boolean
-  /** 控制 换肤按钮 显示 */
+  /** 是否显示切换主题按钮 */
   showThemeSwitch: boolean
-  /** 控制 全屏按钮 显示 */
+  /** 是否显示全屏按钮 */
   showScreenfull: boolean
 }
 

src/directives/permission/index.ts

@@ -15,7 +15,7 @@ export const permission: Directive = {
         el.style.display = "none"
       }
     } else {
-      throw new Error("need roles! Like v-permission=\"['admin','editor']\"")
+      throw new Error(`need roles! Like v-permission="['admin','editor']"`)
     }
   }
 }