首页
/ 推荐项目:Theme Check - Shopify 主题的 Linter 工具

推荐项目:Theme Check - Shopify 主题的 Linter 工具

2024-05-20 19:03:00作者:昌雅子Ethen

🎉 如果你是 Shopify 的主题开发者,那么 Theme Check 将是你不可或缺的代码质量检查利器。它借鉴了 RuboCop 和 eslint 的思想,专注于 Shopify 主题和 Liquid 模板的语法与最佳实践。

Theme Check 预览图

项目介绍

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 成为你开发过程中的得力助手吧!

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511