你可以对主题检查进行配置,以覆盖默认检查选项、启用或禁用特定检查,或指向你自己的自定义检查。你可以使用配置文件进行这些更改,使用注释禁用检查,或使用命令行标志有选择地运行检查。要了解有关主题检查命令行标志的更多信息,请参阅主题检查命令。
配置文件
在主题根目录下添加 .theme-check.yml 文件,以覆盖检查默认值。
您可以使用 shopify theme check –init 命令生成新的 .theme-check.yml 文件。
您可以调整以下设置:
设置 | 描述 |
---|---|
root | 如果你的主题没有使用标准的主题目录结构,你可以提供根路径来查找模板、分区和片段目录。例如,如果从 src 目录生成代码,则应将主题检查配置指向相应的 dist 目录。 |
ignore | 将主题中的目录排除在主题检查之外 |
require | 如果要使用自定义校验,则添加每个自定义校验 RB 文件的路径。 |
Check settings | 对于每个检查,将启用设置为 true 或 false,设置检查严重性,为检查设置特定的忽略文件和路径,并配置任何其他检查选项。如果创建了自定义检查,则需要使用此方法启用它。 您可以在检查参考中查看检查选项的默认值。 |
# The directory where theme folders are located
root: dist
# Paths to custom checks
require:
- ./path/to/my_custom_check.rb
# Disable a check
TemplateLength:
enabled: false
severity: suggestion
ignore:
- templates/index.liquid
# Configure options for a check
max_length: 300
# Enable a custom check
MyCustomCheck:
enabled: true
severity: style
检查严重程度
检查严重程度表示检查对主题功能和优化的相对重要性。严重性级别包括error、suggestion和style。你可以在配置文件中更改检查的严重程度。
如果将主题检查作为 CI 流程的一部分来运行,那么检查失败的严重程度会决定你收到的退出代码。默认情况下,当检测到一个或多个严重程度为错误的问题时,主题检查会失败或返回 1 的退出代码。你可以使用 –fail-level 标志配置导致主题检查运行失败的严重程度。
使用 Liquid 注释禁用主题检查
您可以使用注释禁用所有检查或特定检查。您可以对主题代码的特定部分或整个文件禁用检查。
禁用模板某部分的所有检查:
{% # theme-check-disable %}
{% assign x = 1 %}
{% # theme-check-enable %}
在注释中加禁用特定检查
{% # theme-check-disable UnusedAssign %}
{% assign x = 1 %}
{% # theme-check-enable UnusedAssign %}
以逗号分隔的列表形式列出多个检查项,禁用多个检查项:
{% # theme-check-disable UnusedAssign,SpaceInsideBraces %}
{%assign x = 1%}
{% # theme-check-enable UnusedAssign,SpaceInsideBraces %}
将注释放在第一行,禁用对整个文档的检查:
{% # theme-check-disable SpaceInsideBraces %}
{%assign x = 1%}
发表回复