Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: JsDoc supports preview #635

Merged
merged 4 commits into from
Mar 27, 2024

Conversation

Wxh16144
Copy link
Member

参考 lucide 在 jsdoc 中添加 svg preview:

效果图:

image

@afc163
Copy link
Member

afc163 commented Mar 21, 2024

有点屌啊!

@yoyo837
Copy link

yoyo837 commented Mar 21, 2024

有没有办法直接读svg来预览,data-url 需要多维护一层,容易脱钩

@Wxh16144
Copy link
Member Author

有没有办法直接读svg来预览,data-url 需要多维护一层,容易脱钩

貌似不太行,不过这个 base64 塞进来感觉文件会变大很多🤔

@crazyair
Copy link
Member

vscode 插件,自己根据 icon 名,去渲染一个 html 显示出来?

@Wxh16144
Copy link
Member Author

vscode 插件,自己根据 icon 名,去渲染一个 html 显示出来?

话说 jsDoc 在 ws 里面能不能正常渲染啊🤔

@Wxh16144
Copy link
Member Author

image

@afc163
Copy link
Member

afc163 commented Mar 21, 2024

https://www.npmjs.com/package/lucide-react 整体 install size 是 22MB,看上去还好。

@afc163
Copy link
Member

afc163 commented Mar 21, 2024

7.55 MB => 11.3MB 感觉能接受

@Wxh16144
Copy link
Member Author

vscode 插件,自己根据 icon 名,去渲染一个 html 显示出来?

话说 jsDoc 在 ws 里面能不能正常渲染啊🤔

看起来ws不支持 https://youtrack.jetbrains.com/issue/WEB-52274/JSDoc-tooltip-doesnt-support-svg-data-urls-for-icon-preview

@Wxh16144
Copy link
Member Author

Kapture.2024-03-22.at.11.18.27.mp4

@Wxh16144
Copy link
Member Author

vscode 插件,自己根据 icon 名,去渲染一个 html 显示出来?

话说 jsDoc 在 ws 里面能不能正常渲染啊🤔

看起来ws不支持 https://youtrack.jetbrains.com/issue/WEB-52274/JSDoc-tooltip-doesnt-support-svg-data-urls-for-icon-preview

或者可以在 jsDoc 中用 cdn 显示svg #635 (comment) 🤔

@Wxh16144
Copy link
Member Author

cdn 形式还是算了,预览也有问题,并且还需要考虑版本问题。
image

思考一下, src/xxx.tsx 内容都是用 ./scripts/generate.ts 脚本根据模板生成的,不存在手动修改维护的情况。
至于更多的内容提交到了 git 仓库,先前想法是写 feather 插件实现,但是有一定门槛,精力不足以去研究了,pr 先挂这里了~

@Wxh16144
Copy link
Member Author

7.55 MB => 11.3MB 感觉能接受

大多数用户不会在意 node_modules 在本地占用,生产环境也不会把注释构建进去。
唯一担心的是用户在意可能因为网络原因导致安装依赖失败或导致 CI/CD 时间变长 🤔

@afc163
Copy link
Member

afc163 commented Mar 27, 2024

先合了,有问题再说。

@afc163 afc163 merged commit d23967f into ant-design:master Mar 27, 2024
4 checks passed
@hellohejinyu
Copy link

今天更新完依赖用的时候就看到了这个 feature,赶紧来看看是哪位大佬的杰作。牛逼的👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants