Skip to content

Repository files navigation

Listing Quality Linter

一个用于检查跨境电商商品文案基础质量的 Python 命令行工具,适合在提交标题、五点描述和站点描述前进行快速校验。

当前规则

  • 标题是否为空或超过字符限制
  • 是否出现受限制的平台名称
  • Site Description 是否包含品牌
  • 五点描述数量是否处于允许范围
  • 标题关键词是否过度重复
  • 标题中的车辆类型关键词是否过多
  • 规则配置文件是否合法

基础使用

python linter.py examples/sample_listing.json

使用自定义规则:

python linter.py examples/sample_listing.json --rules examples/rules.json

临时覆盖标题长度:

python linter.py examples/sample_listing.json --rules examples/rules.json --title-limit 120

返回码:

  • 0:未发现错误级问题
  • 1:存在错误级问题,或输入文件、规则文件无效

JSON 规则配置

示例文件:

{
  "title_limit": 150,
  "restricted_platform_terms": [
    "ebay",
    "walmart",
    "aliexpress",
    "temu"
  ],
  "require_brand_in_site_description": true,
  "min_bullets": 3,
  "max_bullets": 7,
  "repeated_keyword_threshold": 3,
  "repeated_keyword_min_length": 4,
  "vehicle_type_keywords": [
    "car",
    "truck",
    "trailer",
    "rv",
    "suv",
    "pickup",
    "van",
    "camper",
    "motorhome"
  ],
  "max_vehicle_type_keywords": 4
}

配置字段

字段 作用
title_limit 标题最大字符数
restricted_platform_terms 不允许出现在文案中的平台词
require_brand_in_site_description Site Description 是否必须包含品牌
min_bullets 五点描述最少数量
max_bullets 五点描述最多数量
repeated_keyword_threshold 同一标题词达到多少次时提示重复
repeated_keyword_min_length 参与重复检查的最短词长
vehicle_type_keywords 需要统计的车辆类型词
max_vehicle_type_keywords 标题允许出现的车辆类型词数量

配置文件出现未知字段、错误数据类型、不合理的数量范围或无效 JSON 时,程序会输出明确错误信息并返回退出码 1

输出示例

[
  {
    "severity": "warning",
    "rule": "title.vehicle_types",
    "message": "Title contains 5 vehicle type keywords; maximum is 4: car, rv, suv, trailer, truck."
  }
]

测试

pytest

GitHub Actions 会在每次 Push 和 Pull Request 时自动运行测试。

About

A Python CLI for checking ecommerce listing quality and common content issues.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages