检查参考

作为主题检查的一部分,您可以运行以下检查。每个检查都能识别代码中未遵循最佳实践的特定错误或位置。

检查按类别分组,以帮助您了解其目的。有些检查包含多个类别。

包括或不包括检查类别

使用 –category 或 –exclude-category 标志,可以包含或排除某些类别的检查。该标记接受以下值:

  • html
  • json
  • liquid
  • performance
  • translation

例如,要只对主题运行 Liquid 检查,请使用 shopify theme check –category liquid 命令。要禁用翻译检查,请使用 shopify theme check –exclude-category translation 命令。
您可以使用多个标志实例指定多个类别:

shopify theme check --category liquid --category performance

HTML 检查

这些检查会分析 HTML 文件的内容

检查严重性目的
AssetPreload建议鼓励使用 Liquid 过滤器而不是 HTML 属性预载资产。
AssetSizeCSS错误防止主题使用大于配置阈值的 CSS 文件。
AssetSizeJavaScript错误防止使用压缩大小大于配置阈值的主题 JavaScript 文件和外部脚本。
DeprecateBgsizes建议不鼓励使用bgset扩展替代image-set加载背景图片
DeprecateLazysizes建议不鼓励使用 lazysizes 库来懒加载图片、iframe 和脚本。
HtmlParsingError错误报告主题检查无法解析和分析 HTML 的错误。
ImgLazyLoading建议建议对图片进行懒加载,以提高性能。
ImgWidthAndHeight错误强制设置 img 标记的宽度和高度属性。
ParserBlockingJavaScript错误识别没有 defer 或 async 属性的脚本标记,避免解析器阻塞 JavaScript。
RemoteAsset建议不鼓励使用第三方域名托管资产。

JSON检查

这些检查会分析 JSON 文件的内容和结构以及语法。

检查严重性目的
ValidJson错误识别主题中无效的 JSON 文件
ValidSchema建议识别 {% schema %} 标记中的无效 JSON。
ValidHTMLTranslation建议识别翻译中的无效 HTML。

Liquid 检查

这些检查分析 Liquid 代码的样式和有效性。其中一些检查支持使用 –auto-correct 标志进行自动更正。

检查严重性目的自动更正
AppBlockValidTags错误识别主题程序扩展程序块和程序嵌入块代码中被禁止的 Liquid 标记。
AssetSizeCSSStyleSheetTag错误防止主题使用 Liquid引用的CSS大于配置阈值的 CSS 文件。
AssetUrlFilters错误鼓励使用 asset_url 或 image_url 过滤器提供资产
ContentForHeaderModification错误识别尝试解析 content_for_header 的代码
ConvertIncludeToRender建议不鼓励使用过时的 include 标签,应该使用 render 标签。
DeprecatedFilter建议不鼓励在主题中使用过时的过滤器是(仅img_url)
DeprecatedGlobalAppBlockType错误确保主题部分不使用已废弃的 @global 块类型来支持或呈现分区中的应用块。
DeprecatedTags错误不鼓励在主题中使用过时的标签
LiquidTag建议如果发现四个或更多连续的 Liquid 标记({% … %}),建议使用 {% liquid … %}。
MissingEnableComment错误保证在模板中存在 theme-check-disable,相应的theme-check-enable也存在
MissingRequiredTemplateFiles错误确保 Shopify 主题商店所需的所有模板文件都已存在。
MissingAsset错误确保 asset_url 过滤器引用的所有资产文件都存在。
MissingTemplate建议当使用 render、section 或 include 标记引用资源,但该资源并不存在时进行识别。
NestedSnippet建议报告深度嵌套的render 标记或include标记。
ParserBlockingScriptTag错误是否使用script_tag过滤器
RequiredDirectories错误确保 Shopify 主题商店所需的所有模板文件都已存在。
RequiredLayoutThemeObject错误确保 theme.liquid 布局文件包含所需的 {{ content_for_header }} 和 {{ content_for_layout }} 对象。
SchemaJsonFormat样式识别 {% schema %} 标记中格式不当的 JSON
SpaceInsideBraces样式识别 Liquid 标记和变量内部不一致的间距。
SyntaxError错误识别 Liquid 语法错误
TemplateLength建议识别大型 Liquid 模板文件
UndefinedObject错误识别对未定义的 Liquid 对象的引用
UnknownFilter错误识别未知Liquid过滤器的引用
UnusedAssign建议识别未使用的变量定义。
UnusedSnippet建议识别未使用的片段

性能检查

这些检查可查找主题代码中常见的性能问题。

检查严重性目的
AssetPreload建议鼓励使用 Liquid 过滤器而不是 HTML 属性预载资产。
AssetSizeAppBlockCSS错误防止主题使用 Liquid 样式表标签引用大于配置阈值的 CSS 文件。
AssetSizeAppBlockJavascript错误防止主题应用程序扩展使用压缩大小大于配置阈值的 JavaScript 文件和外部脚本。
AssetSizeCSS错误防止主题使用大于配置阈值的 CSS 文件。
AssetSizeCSSStyleSheetTag错误防止主题使用 Liquid 样式表标签引用大于配置阈值的 CSS 文件。
AssetSizeJavaScript错误不鼓励在主题中使用过时的过滤器
AssetUrlFilters错误鼓励使用 asset_url 或 image_url 过滤器提供资产
DeprecateBgsizes建议不鼓励使用 bgset 扩展名而应该使用 image-set 属性加载背景图片
DeprecateLazysizes建议不鼓励使用 lazysizes 库来懒加载图片、iframe 和脚本。
ImgLazyLoading建议建议对图片进行懒加载,以提高性能。
ImgWidthAndHeight错误强制设置 img 标记的宽度和高度属性
PaginationSize建议确保对象的分页大小符合性能要求,从而避免一次加载过多对象。
ParserBlockingJavaScript错误识别没有 defer 或 async 属性的脚本标记。
ParserBlockingScriptTag错误标识 script_tag 过滤器的使用情况,该过滤器未封装在带有 defer 或 async 属性的脚本标记中。
RemoteAsset建议不鼓励使用第三方域名托管资产

翻译检查

这些检查可确保翻译的完整性。其中一些检查支持使用 –auto-correct 标志进行自动校正。

检查严重性目的自动更正
DefaultLocale建议确保主题有默认的本地文件
MatchingSchemaTranslations建议识别 {% schema %} 标记中缺失或额外的翻译。
MatchingTranslations建议识别本地文件中缺失或额外的翻译
TranslationKeyExists错误识别不存在的翻译引用

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注