首页
/ 推荐项目: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 成为你开发过程中的得力助手吧!

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
33
24
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
830
0
redis-sdkredis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
376
32
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.92 K
19.09 K
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.62 K
1.45 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
19
2
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
9
1
Yi-CoderYi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
57
7
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
147
26
anqicmsanqicms
AnQiCMS 是一款基于Go语言开发,具备高安全性、高性能和易扩展性的企业级内容管理系统。它支持多站点、多语言管理,能够满足全球化跨境运营需求。AnQiCMS 提供灵活的内容发布和模板管理功能,同时,系统内置丰富的利于SEO操作的功能,帮助企业简化运营和内容管理流程。AnQiCMS 将成为您建站的理想选择,在不断变化的市场中保持竞争力。
Go
78
5