细节修改

.prettier.cjs

@@ -1,20 +1,20 @@
 module.exports = {
-  printWidth: 80, //一行最多 80 字符
+  printWidth: 80, // 一行最多 `80` 字符
-  tabWidth: 2, //使用 2 个空格缩进
+  tabWidth: 2, // 使用 `2` 个空格缩进
-  useTabs: false, //不使用缩进符，而使用空格
+  useTabs: false, // 不使用缩进符, 而使用空格
-  semi: false, //行尾不需要有分号
+  semi: false, // 行尾不需要有分号
-  singleQuote: true, //使用单引号
+  singleQuote: true, // 使用单引号
-  quoteProps: 'as-needed', //对象的key仅在必要时用引号
+  quoteProps: 'as-needed', // 对象的 `key` 仅在必要时用引号
-  jsxSingleQuote: false, //jsx不使用单引号，而使用双引号
+  jsxSingleQuote: false, // `jsx` 不使用单引号, 而使用双引号
-  trailingComma: 'all', //尾随逗号
+  trailingComma: 'all', // 尾随逗号
-  bracketSpacing: true, //大括号内的首尾需要空格
+  bracketSpacing: true, // 大括号内的首尾需要空格
-  jsxBracketSameLine: false, //jsx标签的反尖括号需要换行
+  jsxBracketSameLine: false, // `jsx` 标签的反尖括号需要换行
-  arrowParens: 'always', //箭头函数，只有一个参数的时候，也需要括号
+  arrowParens: 'always', // 箭头函数, 只有一个参数的时候, 也需要括号
-  rangeStart: 0, //每个文件格式化的范围是文件的全部内容
+  rangeStart: 0, // 每个文件格式化的范围是文件的全部内容
   rangeEnd: Infinity,
-  requirePragma: false, //不需要写文件开头的@prettier
+  requirePragma: false, // 不需要写文件开头的 `@prettier`
-  insertPragma: false, //不需要自动在文件开头插入@prettier
+  insertPragma: false, // 不需要自动在文件开头插入 `@prettier`
-  proseWrap: 'preserve', //使用默认的折行标准
+  proseWrap: 'preserve', // 使用默认的折行标准
-  htmlWhitespaceSensitivity: 'css', //根据显示样式决定html要不要折行
+  htmlWhitespaceSensitivity: 'css', // 根据显示样式决定 `html` 要不要折行
-  endOfLine: 'lf', //换行符使用lf
+  endOfLine: 'lf', // 换行符使用 `lf`
 }

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "i18n-ally.localesPaths": [
+    "locales",
+    "src/language"
+  ]
+}

README.md

@@ -34,6 +34,8 @@
 ## 项目结构
 
 ```
+- locales: 国际化多语言入口(本项目采用 `json` 格式)
+
 - assets: 项目静态资源入口
   - images: 项目图片资源
 

src/components/RayScrollReveal/index.tsx

@@ -84,7 +84,7 @@ export default RayScrollReveal
 /**
  *
  * 滚动加载过度组件, 来回滚动时, 可以重复触发效果
- * 只需要将 dom 插入在 RayScrollReveal 组件下即可
+ * 只需要将 `dom` 插入在 `RayScrollReveal` 组件下即可
- * 如果需要使用重新注册加载脚本或者有新的 dom 插入, 调用 scrollRevealCallback 函数即可捕获添加到 dom 的任何新元素
+ * 如果需要使用重新注册加载脚本或者有新的 `dom` 插入, 调用 `scrollRevealCallback` 函数即可捕获添加到 `dom` 的任何新元素
  * 注意: 插件始终是以显示屏为窗口作为判断元素是否显示, 所以自定义滚动条滚动加载元素不生效
  */

src/router/modules/index.ts

@@ -13,5 +13,6 @@ export default routes
 /**
  *
  * 这个方法可以自动载入路由表, 不需要手动进行导入
- * 单个路由表格式可以参考 test.ts
+ * 单个路由表格式可以参考 `test.ts`
+ * 但是如果需要控制路由顺序, 则需要自行处理
  */

src/types/cache.d.ts

@@ -1,5 +1,5 @@
 export {}
 
 declare global {
-  declare type TCacheType = 'sessionStorage' | 'localStorage'
+  declare type CacheType = 'sessionStorage' | 'localStorage'
 }

src/types/index.d.ts

@@ -30,4 +30,6 @@ export global {
   declare type CipherOption = CryptoJS.lib.CipherOption
 
   declare type CipherParams = CryptoJS.lib.CipherParams
+
+  declare type VoidFunc = (...args: unknown[]) => void
 }

src/utils/cache.ts

@@ -6,11 +6,13 @@
 export const useSetCache = <T>(
   key: string,
   value: T,
-  type: TCacheType = 'sessionStorage',
+  type: CacheType = 'sessionStorage',
 ) => {
+  const waitCacheValue = JSON.stringify(value)
+
   type === 'localStorage'
-    ? window.localStorage.setItem(key, JSON.stringify(value))
+    ? window.localStorage.setItem(key, waitCacheValue)
-    : window.sessionStorage.setItem(key, JSON.stringify(value))
+    : window.sessionStorage.setItem(key, waitCacheValue)
 }
 
 /**
@@ -21,7 +23,7 @@ export const useSetCache = <T>(
  */
 export const useGetCache = (
   key: string,
-  type: TCacheType = 'sessionStorage',
+  type: CacheType = 'sessionStorage',
 ) => {
   let data =
     type === 'localStorage'
@@ -37,7 +39,7 @@ export const useGetCache = (
  */
 export const useRemoveCache = (
   key: string | 'all' | 'all-sessionStorage' | 'all-localStorage',
-  type: TCacheType = 'sessionStorage',
+  type: CacheType = 'sessionStorage',
 ) => {
   if (key === 'all') {
     window.window.localStorage.clear()