关于 marko-best-practices
面向 Marko 开发者的 Marko 6 指南,适用于新建或修改组件。它强调以官方文档为准,并涵盖语法、类型检查及减少客户端 JavaScript 的实践。
主要功能
- 01Marko 6 语法指导
- 02以官方文档为准
- 03组件与状态建议
- 04事件处理器规范
- 05使用 mtc 进行类型检查
适用场景
- 01检查新建 .marko 文件的语法
- 02审查状态与事件处理
- 03保持组件精简易读
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ marko-js/ marko --skill marko-best-practices安装后在 Claude Code 中输入/marko-best-practices确认已加载。
详细介绍
Marko 最佳实践
Marko 是一个用于构建 Web 应用的现代 UI 框架。它采用声明式、基于组件的语法,具备细粒度响应性和高度优化的编译器。Marko 既适用于服务器渲染,也适用于客户端交互体验,并着重支持流式传输、部分水合,以及尽可能减少每个页面所需的 JavaScript。
Marko 文档
Marko 文档是所有 Marko 相关信息的权威来源。有关语法和行为的信息,请始终参考官方文档。Marko 会不断更新,因此应优先获取最新文档,而不是依赖训练数据。
文档索引列出了所有可用页面及其 URL 和简短说明。
在 URL 后添加 .md,即可获取所有 Marko 文档页面的 Markdown 版本(https://markojs.com/docs/introduction/getting-started.md)
Marko 6 语法
本文档和此技能均针对 Marko 6。不要使用 Marko 5 语法。
新建或编辑 .marko 文件的检查清单
- 仅使用 Marko 6 语法(不使用脚本片段、旧事件语法或 Marko 5 区块)。
- 如果使用状态(
<let>或<const>)即可实现相同行为,则绝不使用<script>。 - 事件处理程序使用函数形式:
onClick() { ... }或函数引用,而非字符串名称。 - 对于需要保留状态的切换内容,使用
<show=cond>;<if>会销毁并重新创建内容。 - 保持组件小巧易读;考虑拆分较大的模板。
- 不添加不必要的客户端 JS;优先使用内置浏览器 API 和 HTML/CSS 功能,而不是脚本。
- 使用导出的
Input接口声明属性,并使用mtc(@marko/type-check)对模板进行类型检查——tsc会跳过.marko文件,且不会报告任何内容。
评论
支持 Markdown