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: implement walkthroughs contribution API #1902

Merged
merged 22 commits into from
Nov 28, 2022

Conversation

Ricbet
Copy link
Member

@Ricbet Ricbet commented Nov 2, 2022

Types

  • 🎉 New Features

Background or solution

说明: 该 api 主要是用来让插件很方便的提供一种交互式的界面向用户介绍自身插件的功能。更详细的说明见 api
示例模版: getting-started-sample 插件
演示效果:

Kapture.2022-11-07.at.14.16.17.mp4

Changelog

实现 walkthroughs contribution API

@Ricbet Ricbet self-assigned this Nov 2, 2022
@Ricbet Ricbet linked an issue Nov 2, 2022 that may be closed by this pull request
@github-actions github-actions bot added the 🎨 feature feature required label Nov 2, 2022
@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch 2 times, most recently from d661c7b to 98ca6dd Compare November 4, 2022 05:10
@Ricbet
Copy link
Member Author

Ricbet commented Nov 4, 2022

  • 基础 walkthroughs 贡献点渲染(标题、step、media)
  • step description 渲染并支持 command、when
  • media image 渲染
  • media svg 渲染
  • media svg command 事件处理
  • media markdown 渲染(需支持资源以相对路径的方式打开)
  • completionEvents 机制(例如当用户做了某些操作之后给当前 step 设置成 completion 的状态,也就是会在左边的 checkbox 打勾勾)
  • 主题适配

@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch from e48f186 to cbea4bc Compare November 7, 2022 05:36
@Ricbet Ricbet changed the title WIP: feat: implement walkthroughs contribution API feat: implement walkthroughs contribution API Nov 7, 2022
@Ricbet
Copy link
Member Author

Ricbet commented Nov 7, 2022

  • 基础 walkthroughs 贡献点渲染(标题、step、media)
  • step description 渲染并支持 command、when
  • media image 渲染
  • media svg 渲染
  • media svg command 事件处理
  • media markdown 渲染(需支持资源以相对路径的方式打开)
  • completionEvents 机制(例如当用户做了某些操作之后给当前 step 设置成 completion 的状态,也就是会在左边的 checkbox 打勾勾)
  • 主题适配

针对 media svg 的 command 事件处理和 color token 另开 pr 解决
相关 issue:#1928

@codecov
Copy link

codecov bot commented Nov 7, 2022

Codecov Report

Base: 57.43% // Head: 57.46% // Increases project coverage by +0.02% 🎉

Coverage data is based on head (423113c) compared to base (1a8bb50).
Patch coverage: 61.82% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1902      +/-   ##
==========================================
+ Coverage   57.43%   57.46%   +0.02%     
==========================================
  Files        1291     1292       +1     
  Lines       80630    80861     +231     
  Branches    16831    16885      +54     
==========================================
+ Hits        46313    46467     +154     
- Misses      31193    31267      +74     
- Partials     3124     3127       +3     
Flag Coverage Δ
jsdom 52.32% <60.99%> (+0.04%) ⬆️
node 15.74% <6.22%> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
packages/extension/src/common/vscode/extension.ts 52.00% <ø> (ø)
packages/i18n/src/common/en-US.lang.ts 100.00% <ø> (ø)
packages/i18n/src/common/zh-CN.lang.ts 100.00% <ø> (ø)
packages/markdown/src/common/index.ts 100.00% <ø> (ø)
packages/extension/src/browser/extension.ts 54.20% <28.57%> (-2.24%) ⬇️
...ges/extension/src/node/extension.service.client.ts 65.78% <50.00%> (-1.34%) ⬇️
...ages/extension/src/browser/walkthroughs.service.ts 57.71% <57.71%> (ø)
packages/components/src/utils/marked.ts 81.81% <100.00%> (ø)
packages/core-common/src/command.ts 87.55% <100.00%> (+0.39%) ⬆️
...s/extension/src/browser/vscode/builtin-commands.ts 100.00% <100.00%> (ø)
... and 7 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Ricbet
Copy link
Member Author

Ricbet commented Nov 8, 2022

/publish

@github-actions
Copy link
Contributor

github-actions bot commented Nov 8, 2022

🎉 PR Next Release version 2.21.2-next-1667875132.0 publish successful! You can install prerelease version via npm install package@2.21.2-next-1667875132.0 @Ricbet

2.21.2-next-1667875132.0

@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch 2 times, most recently from 4fb1ad1 to f3ec3f1 Compare November 9, 2022 02:29
@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch from 32deab1 to fc65deb Compare November 11, 2022 08:38
@erha19 erha19 added this to the 2.22 milestone Nov 14, 2022
@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch from fc42d34 to 57fafa1 Compare November 21, 2022 02:53
@erha19
Copy link
Member

erha19 commented Nov 24, 2022

@Ricbet 这个修一下,补点测试

@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch from 36d270a to ad268c2 Compare November 24, 2022 11:27
@Ricbet Ricbet force-pushed the feat/implement-walkthroughs-api branch from a229f02 to 18cfd41 Compare November 28, 2022 06:50
@erha19 erha19 merged commit 31eed68 into main Nov 28, 2022
@erha19 erha19 deleted the feat/implement-walkthroughs-api branch November 28, 2022 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎨 feature feature required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support walkthroughs contributionPoint
2 participants