为什么文档中 `mode` 属性的类型标记为 `Mode`？

[EmptyDreams]

Consultation Description

我注意到在文档（及代码中的类型标记）中，mode 属性被设置为 Mode 类型，我有以下几个问题：

1. 为什么文档中使用 Mode 类型，但 demo 中却将 mode 填入 string 类型？
2. 为什么 json-editor-vue 没有内置 Mode 类型？如果我想使用这个类型，为什么还需要额外安装一个库？
3. 这里的设计是否存在问题？是否应该在类型定义时就同时允许这两种类型？按照当前的设计，我只能在以下两种方案中二选一：
   • 安装一个额外的库（仅为了使用 Mode 类型），或者
   • 忍受代码静态检查抛出的警告（因为类型标记不允许传入 string 类型，而静态检查器不支持屏蔽此类警告）。

Validation

• ⚠️ I understand that using this for unrelated purposes can lead to it being closed without further notice

[cloydlau]

1. Mode 是 string 的枚举，而枚举是 TS 的概念，在 JS 中就是个 plain object，所以直接使用 string 是合法合规的
2. 没有内置的原因是这个值也是从底层库里面暴露出来的，json-editor-vue 是做一个透传分发，没有去魔改它，内置就无法解决同步不及时
3. 文档里之所以这么写，是出于可维护性、灵活性、前瞻性的考虑，因为枚举的值是可能发生变化的（比如新增了模式、移除了模式、变更了模式）
4. “忍受代码静态检查抛出的警告”：你的意思是你想在 TS 中直接使用 string 而不是枚举对吧，你觉得这个兼容处理要怎么做呢？如果我允许 string 类型，你传了一个错误的值进来就会有问题，TS 在此时发出警告其实也是符合预期的

那看来现状似乎也是合理的：
在 JS 中不安装额外的依赖直接使用 string，或者在 TS 中安装额外的依赖（只是间接依赖还是直接依赖的区别）使用枚举。

[EmptyDreams]

我看到您已经修改了文档，额外标注了可以直接使用字面量。但是由于我们项目添加了强制的类型检查，直接写字符串的字面量会被类型检查卡主构建。

现在的情况会导致两个问题：

1. 代码无法通过类型检查，想要通过的话只能将字面量转换为 any 类型，这非常的不友好
   例如：<JsonEditorVue :mode="'text' as any" />
2. 即使没有类型检查，也会导致 IDE 无法通过类型对代码提供自动补全等服务，影响开发体验

综上，我希望能够把需要对外暴露的类型定义在 json-editor-vue 中复制一份。

[cloydlau]

我看到您已经修改了文档，额外标注了可以直接使用字面量。但是由于我们项目添加了强制的类型检查，直接写字符串的字面量会被类型检查卡主构建。

请注意文档里写的是在 JS 的上下文中，您这种类型检查的情况仍然建议使用枚举类型。

如果我想使用这个类型，为什么还需要额外安装一个库？

请补充信息，我并不清楚您的技术栈。您说的这个情况，是 Vite 预构建导致的还是其他原因？

如果是 Vite 预构建导致的，有无尝试过除了显式安装之外的方法（不保证可行性）：

// vite.config.js
export default {
  optimizeDeps: {
    include: ['vanilla-jsoneditor'],
  },
}

[EmptyDreams]

请补充信息，我并不清楚您的技术栈。您说的这个情况，是 Vite 预构建导致的还是其他原因？

我们项目在执行 vite 构建任务前会通过 eslint 等工具对代码进行静态检查，如果出现问题会直接拒绝构建，所以如果我没有安装 vanilla-jsoneditor 的话在 js 中除非手动强转，不然的话无法通过检查。

请注意文档里写的是在 JS 的上下文中，您这种类型检查的情况仍然建议使用枚举类型。

如果能够将枚举类型在 json-editor-vue 中也提供一份会方便的多，就不需要手动再安装一个额外的依赖了。

[cloydlau]

如果在源码中增加这一句：
export * from 'vanilla-jsoneditor'

则可以实现：
import JsonEditorVue, { Mode } from 'json-editor-vue'

但我并不确定这样做是不是一个好的设计。且这么做有一个缺点，暗色主题等情况没法解决：
import 'vanilla-jsoneditor/themes/jse-theme-dark.css'

欢迎集思广益，征求更多人的意见（我重开一下，欢迎留言）。

如果能够将枚举类型在 json-editor-vue 中也提供一份会方便的多，就不需要手动再安装一个额外的依赖了。

这个事情不建议这么粗暴地处理，除了我之前说的可维护性、灵活性、前瞻性问题。还有如果复制了 A，那么别人会问为什么 B 不复制，我并不排斥只安装一个依赖，但最好能通过一个系统性的而不是打补丁的方案来达成。