Playground code runner UX is confusing
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 38/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript, typescript
调研方向
从链接的 TypeScript Playground handbook 开始，重现 issue 中描述的 Run-button、TSConfig Module 和 npm import 用例。在决定每个用例是否需要更清晰的 UI 反馈、文档说明或两者都需要之前，检查 Playground settings、runner 和 .js output 的行为。完成标准是：在上下文中解释不兼容的设置和依赖错误，并且 handbook 描述预期的 runner 行为。
由索引模型根据 Issue 内容生成。
描述
The TypeScript Playground is confusing when trying to run code. It would be great to update the handbook and better yet to update the interface to make the expected behavior more clear.
-
If Settings -> "Run JavaScript in Browser" is disabled, the "Run" button is still enabled. Clicking it creates an error in the native browser console "can't access property "id", plugin is undefined". It's unclear what the "Run JavaScript in Browser" checkbox supposed to do (is there a way for the browser interface to run javascript out of browser? I think maybe it's from a previous version of the playground where JavaScript would auto-run instead of having a run button?)
-
Running code seems to fail if TSConfig Module is not "CommonJS", "None", or "Preserve".
It fails silently if Module is "AMD" or "UMD". There is a helpful error if you have top-level exports ("[WRN]: "Tip: Change the Module setting to "CommonJS" in TS Config settings to allow top-level exports to work in the Playground"). I expect to see a warning or error if the settings are incompatible with the runner, and it's not clear which settings are compatible with the runner (e.g. I expect ES modules to work but not CommonJS in the browser, but the opposite appears true) -
Attempting to import a package from npm often shows type hints. But running the code results in a misleading error, which is contextually inappropriate. (there is no "dependency list" that I know of to check and the import declarations are at the top of the user code in the code displayed under the
.jstab).
[ERR]: "Executed JavaScript Failed:"
[ERR]: Check dependency list! Synchronous require cannot resolve module 'jest'. This is the first mention of this module!
Or:
[ERR]: "Executed JavaScript Failed:"
[ERR]: import declarations may only appear at top level of a module
- 主要语言
- TypeScript
- 星标
- 2.6k
- 派生
- 1.5k
- 平均合并
- 2 天 21 小时
- 30 天内合并 PR
- 7
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
microsoft/TypeScript-Website 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
microsoft/TypeScript-Website#3607 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 65/100
microsoft/TypeScript-Website#3039 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
microsoft/TypeScript-Website#2998 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
microsoft/TypeScript-Website#3614 ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 25/100
microsoft/TypeScript-Website#3583 · 3 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
查看 microsoft/TypeScript-Website 的全部 Issue
相似的 Issue
-
triage
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
mermaid-js/mermaid-live-editor#2053 ·
维护者通常 1 天内回复
-
factory
难度 2/5 1-3 小时 新手友好度 82/100
jessepollak/home#1455 ·
维护者通常 1 天内回复
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
难度 1/5 1 小时以内 新手友好度 95/100
lingdojo/kana-dojo#31227 · 1 条评论 · 5 个 reaction ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 92/100
appandflow/stim#1838 ·
维护者通常 1 天内回复