推荐项目:Theme Check - Shopify 主题的 Linter 工具
2024-05-20 19:03:00作者:昌雅子Ethen
🎉 如果你是 Shopify 的主题开发者,那么 Theme Check 将是你不可或缺的代码质量检查利器。它借鉴了 RuboCop 和 eslint 的思想,专注于 Shopify 主题和 Liquid 模板的语法与最佳实践。
项目介绍
Theme Check 是一个命令行工具,它能帮你遵循 Shopify 的主题开发规范,通过分析你的主题中的 Liquid 和 JSON 文件,找出潜在的问题。该工具甚至在某些代码编辑器中也有集成,为你的开发工作提供实时反馈。
技术分析
Theme Check 支持以下功能:
- 检查 Liquid 语法错误
- JSON 语法错误检测
- 缺失的 snippet 和 section 模板提醒
- 未使用的变量分配
{% assign ... %}
- 未使用的 snippet 模板
- 模板长度控制
- 过时的标签
- 未知标签
- 未知过滤器
{{ content_for_* }}
在theme.liquid
中的缺失- 过度嵌套的 snippet
- 标签内的多余或缺失空格
- 缺失默认语言文件
- 本地化文件翻译键不匹配
- 使用未知的翻译键
- 使用多个
{% ... %}
而非{% liquid ... %}
- 未定义的对象引用
- 过时的过滤器
- 大量阻塞解析的 JavaScript
- 非 Shopify 域名的资产引用
- 图片标签缺少宽度和高度属性
- JavaScript 与 CSS 文件过大
这些检查可以防止一些明显的性能问题,并且,随着社区的发展,更多检查规则将会不断添加。
应用场景
无论是新手还是经验丰富的 Shopify 开发者,Theme Check 都能在以下几个方面大展身手:
- 快速定位并修复代码错误
- 提升代码质量和可维护性
- 优化主题性能,提升用户体验
- 在持续集成(CI)流程中自动化代码审查
项目特点
- 易用性:通过简单的安装和命令行调用,Theme Check 可以快速集成到你的开发环境中。
- 可配置性:你可以通过
.theme-check.yml
文件自定义检查规则,满足不同的项目需求。 - 智能注释:可以在代码中使用特定注释临时禁用或启用检查,提高开发效率。
- 兼容性:支持 Ruby 2.7+,并且可以通过 Homebrew 或 RubyGems 安装。
- 社区驱动:欢迎贡献新的检查规则,一起完善这个工具。
现在就开始使用 Theme Check 提升你的 Shopify 主题代码质量吧!如需了解更多详情,请参考项目文档和示例。
安装
# 使用 Homebrew
brew tap shopify/shopify
brew install theme-check
# 或者使用 RubyGems
gem install theme-check
使用
# 指定主题目录运行
theme-check /path/to/your/theme
# 在主题目录内运行
cd /path/to/your/theme
theme-check
为了确保你的代码达到行业最佳实践标准,让我们一起让 Theme Check 成为你开发过程中的得力助手吧!
热门项目推荐
- 国产编程语言蓝皮书《国产编程语言蓝皮书》-编委会工作区017
- nuttxApache NuttX is a mature, real-time embedded operating system (RTOS).C00
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTSX027
- 每日精选项目🔥🔥 01.17日推荐:一个开源电子商务平台,模块化和 API 优先🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~026
- Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie045
- 毕方Talon工具本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python039
- PDFMathTranslatePDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython05
- mybatis-plusmybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript0108
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript09
热门内容推荐
最新内容推荐
项目优选
收起
Python-100-Days
Python - 100天从新手到大师
Python
266
55
国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区
65
17
Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
196
45
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
53
44
HarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
268
69
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
333
27
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
896
0
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
419
108
MateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
144
24
HarmonyOS-Cangjie-Cases
参考 HarmonyOS-Cases/Cases,提供仓颉开发鸿蒙 NEXT 应用的案例集
Cangjie
58
4