@ capgo/ seo检查器
静态 SEO 检查器,用于分析 Dist 文件夹中已建的 HTML 文件 。 以1000+规则进行综合的SEO分析,涵盖元数据、内容质量、可访问性、结构化数据等.
受Ahrefs SEO审计和灯塔SEO审计的启发,但专注于用Astro,Next.js,SvelteKit等框架所建的静态站点.
安装
npm install @capgo/seo-checker
# or
bun add @capgo/seo-checker
CLI 使用量
# Run with default settings (scans ./dist)
npx @capgo/seo-checker
# Specify dist path
npx @capgo/seo-checker --dist ./build
# Output as JSON
npx @capgo/seo-checker --output json
# Generate a sample config file
npx @capgo/seo-checker --generate-config
CLI 选项
| 选项 | 说明 | 默认 |
|---|---|---|
--dist <path> | Dist 文件夹的路径 | ./dist |
--config <path> | 配置文件的路径 | seo-checker.config.json |
--output <format> | 输出格式:控制台、json、sarif、github | console |
--report <path> | 写入报表文件的路径 | - 说吧 |
--fail-on <level> | 失败: 错误、 警告、 通知 | error |
--max-issues <n> | 停止前的最大问题 | 0 (无限制) |
--generate-config | 生成一个样本配置文件 | - 说吧 |
配置
创建一个 seo-checker.config.json 文件 :
{
"distPath": "./dist",
"baseUrl": "https://example.com",
"languages": ["en", "es", "fr"],
"defaultLanguage": "en",
"rules": {
"disabled": ["SEO00186", "SEO00189"],
"severityOverrides": {
"SEO00135": "notice"
}
},
"exclusions": [
{
"ruleId": "SEO00147",
"filePath": "404.html",
"reason": "404 page intentionally has broken link examples"
}
],
"failOn": ["error"],
"maxIssues": 0,
"outputFormat": "console"
}
程序用途
import {
checkDuplicates,
printReport,
runPageChecks,
scanDistFolder
} from '@capgo/seo-checker'
const config = {
distPath: './dist',
baseUrl: 'https://example.com',
languages: ['en'],
defaultLanguage: 'en',
}
// Scan the dist folder
const siteData = await scanDistFolder(config)
// Run checks on each page
const issues = []
for (const page of siteData.pages.values()) {
issues.push(...runPageChecks(page, config, siteData))
}
// Check for duplicates
issues.push(...checkDuplicates(siteData, config))
console.log(`Found ${issues.length} SEO issues`)
规则类别
检查器包含1000+规则,跨越这些类别:
- 元数据: 标题,描述,词条,字符集,朗语
- 内容长度: 标题/说明/标题长度限制
- 内容格式: 白空间,编码,盖子,平分
- 标题: H1 存在,分级,重复
- 指数:机器人指令、犬类问题
- 链接: 断开链接、 锁定文本、 无后续使用
- 图像: 备选案文文本、文件大小、已损坏的引用
- 社会标记: OpenGraph, 推特卡
- 国际机会均等组织: Hreflang, lang 属性
- 结构数据: JSON- LD 验证
- 无障碍: 地标,跳过链接, ARIA
- 机器人.txt & Siteap: 审定和一致性
输出格式
控制台( 默认)
按类别和严重程度指标分类的有色终端产出.
贾森
机器可读 JSON 与所有的问题和统计.
沙特阿拉伯
用于CI/CD整合的静态分析结果互换格式.
GitHub 图像
GitHub 动作工作流程命令格式. 问题作为说明列入公关/承诺.
# Use in GitHub Actions
npx @capgo/seo-checker --output github
工作流程示例:
- name: SEO Check
run: npx @capgo/seo-checker --output github --fail-on error,warning
许可证
麻省理工学院