我想给 Ant Design icons 加入 JSDoc 预览,来讨论一下?

293 阅读1分钟

前言

我们都知道 VSCode 的 JSDoc 支持 markdown 语法,比如加粗,代码片段 等等

比如:

image-20240322111012969.png

动机

antd 团队成员经常安利 lucide 图标库,使用过程中我发现库作者在 JSDoc 中嵌入了 base64 图片。开发者体检蛮不错的。

image-20240322111359777.png

antd icon 效果

前往 GitHub 讨论区去查看效果

讨论点

是否应该塞入到 jsdoc?

  1. 这样会增加 npm 包构建体积。npm 安装包大概从 7 MB =>13 MB,但是生产环境构建不影响,会移除注释。
  2. 有同学期望做成一个 vscode 插件。
  3. 我研究后发现,jetbrains 不支持 JSDoc 插入 base64 ,但是 VSCode 支持度挺好

主观意见

我个人主观意见是用 JSDocs 方式。

如果是插件形式则还需开发者去安装,大家应该不太愿意多一个插件拖动 VSCode 启动速度。

但是插件可以解决 jetbrains 无法预览问题。

最后

大家可以去 Ant Design Icon PR 讨论,或者评论区讨论。

最后看结果进一步推进该 PR 实现方式,目前将 data-url 打包到 git 仓库做法感觉不太妥。拟采用 feather 插件,在生成 d.ts 描述文件的时候去插入。

欢迎讨论~