返回技能列表

repair-broken-references

pjt222
更新于 2 days ago
8 次查看
17
2
17
在 GitHub 上查看
文档wordai

关于

This skill automatically detects and fixes broken references in codebases, including dead links, stale imports, and orphaned files. It's designed for maintenance tasks when documentation links fail, imports reference missing modules, or cross-references become outdated. Use it to ensure all project references remain valid without manual hunting.

快速安装

Claude Code

推荐
主要方式
npx skills add pjt222/agent-almanac -a claude-code
插件命令备选方式
/plugin add https://github.com/pjt222/agent-almanac
Git 克隆备选方式
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/repair-broken-references

在 Claude Code 中复制并粘贴此命令以安装该技能

技能文档

修斷之引

用時

項目之諸引已陳乃用此技:

  • 文檔含斷之內鏈
  • 外 URL 返 404 誤
  • import 陳述引已移或已刪之模
  • 文間之交引脫同
  • 文存而無處引之

勿用於重構模之依或重設信構。本技修現引,非重構之。

project_path項目根之絕路
check_external驗外 URL(默:是,緩)
fix_modeauto(修明顯)、report(獨書)、interactive(問)
orphan_threshold距末改之日,標為孤(默:180)

第一步:掃斷之內鏈

尋諸 markdown 鏈指不存之文。

# Find all markdown files
find . -name "*.md" -type f > markdown_files.txt

# Extract all markdown links: [text](path)
grep -oP '\[.*?\]\(\K[^)]+' *.md | sort | uniq > all_links.txt

# For each link:
while read link; do
  # Skip external URLs (http/https)
  if [[ "$link" =~ ^https?:// ]]; then
    continue
  fi

  # Resolve relative path
  target=$(realpath -m "$link")

  # Check if target exists
  if [ ! -e "$target" ]; then
    echo "BROKEN: $link (referenced in $file)" >> broken_internal.txt
  fi
done < all_links.txt

得:broken_internal.txt 列諸斷之內引

敗則:若 realpath 不可得,手察各鏈

第二步:察外 URL

驗外鏈仍可訪(HTTP 200 之應)。

# Extract external URLs
grep -ohP 'https?://[^\s\)]+' *.md | sort | uniq > external_urls.txt

# Check each URL (rate-limit to avoid bans)
while read url; do
  status=$(curl -o /dev/null -s -w "%{http_code}" "$url")

  if [ "$status" -ge 400 ]; then
    echo "DEAD ($status): $url" >> dead_urls.txt
  fi

  sleep 0.5  # Rate limit
done < external_urls.txt

得:dead_urls.txt 列返 4xx/5xx 誤之 URL

敗則:若 curl 不可得或被阻,用線之鏈察器或略

:某 URL 或因察機之拒返 403 然於覽器中行之。需手審。

第三步:尋斷之 import

察諸 import/require 之陳述引存之模。

JavaScript/TypeScript

# Find all import statements
grep -rh "^import.*from ['\"]" . | sed -E "s/.*from ['\"]([^'\"]+)['\"].*/\1/" > imports.txt

# For each import:
while read import; do
  # Skip node_modules and external packages
  if [[ "$import" =~ ^[./] ]]; then
    # Resolve to file path
    target="${import}.js"  # Try .js, .ts, .jsx, .tsx

    if [ ! -e "$target" ]; then
      echo "BROKEN IMPORT: $import" >> broken_imports.txt
    fi
  fi
done < imports.txt

Python

# Find all import statements
grep -rh "^from .* import\|^import " . --include="*.py" | \
  sed -E "s/from ([^ ]+) import.*/\1/" | \
  sed -E "s/import ([^ ]+)/\1/" > imports.txt

# For each local import (starts with .)
# Check if module file exists

R

# Find library() and source() calls
grep -rh "library(\\|source(" . --include="*.R" | \
  sed -E 's/.*library\("([^"]+)"\).*/\1/' > packages.txt

# For source() calls, check if file exists
# For library() calls, check if package installed
Rscript -e "installed.packages()[,'Package']" > installed_packages.txt

得:broken_imports.txt 列諸引已刪/已移之模

敗則:若語特之具不可得,手審近之重構之提交

第四步:尋孤文

識文存而無處引之。

# Find all code files
find . -type f \( -name "*.js" -o -name "*.py" -o -name "*.R" \) > all_files.txt

# For each file:
while read file; do
  basename=$(basename "$file")

  # Search for references (import, require, source, href, link)
  refs=$(grep -r "$basename" . --exclude-dir=node_modules --exclude-dir=.git | wc -l)

  # If only 1 reference (itself):
  if [ "$refs" -le 1 ]; then
    # Check last modified date
    last_mod=$(git log -1 --format="%ci" "$file")

    # If modified more than orphan_threshold days ago
    # Flag as potential orphan
    echo "ORPHAN: $file (last modified: $last_mod)" >> orphans.txt
  fi
done < all_files.txt

得:orphans.txt 列無處引之文

敗則:若 git log 敗,用文系之 mtime 代之

:某文(如 CLI 入點、頂層之文)合而無引,非孤也。需手審。

第五步:修內鏈

以三策之一修斷之內引:

策一:尋已移之文

# For each broken link, search for file by name
while read broken_link; do
  filename=$(basename "$broken_link")

  # Search for file in project
  found=$(find . -name "$filename" | head -1)

  if [ -n "$found" ]; then
    # Update link to new path
    old_path="$broken_link"
    new_path="$found"

    # Use Edit tool to replace in all markdown files
    echo "FIX: $old_path -> $new_path"
  fi
done < broken_internal.txt

策二:立轉之短

# If file was deleted intentionally, create redirect stub
echo "# Moved" > "$broken_link"
echo "This content moved to [new location](new_path.md)" >> "$broken_link"

策三:除死之鏈

# If content no longer exists, remove link (keep text)
# Replace [text](broken_link) with text (plain)

得:諸斷內鏈或修、或轉、或除

敗則:若自動之修破境,升以行手審

第六步:修斷之 import

更 import 陳述以引移後之正路。

JavaScript 例

// Before (broken)
import { helper } from './utils/helper';

// After (fixed — file moved to lib/)
import { helper } from './lib/helper';

各斷之 import:

  1. 定移之模(似第五步)
  2. 於諸引之文中更 import 路
  3. 行 linter/類察以驗修

得:諸 import 解正;無 module-not-found 之誤

敗則:若模真已刪,升以定其能否仍需

第七步:書孤文

於標為孤之文,定處:

  1. :合而無引(入點、文、樣)
  2. :舊碼不需而存其史
  3. :死碼無值
# Orphaned Files Review

| File | Last Modified | Recommendation | Reason |
|------|---------------|----------------|--------|
| scripts/old_deploy.sh | 2024-01-05 | Archive | Replaced by CI/CD |
| src/legacy_api.js | 2023-06-12 | Delete | API v1 fully deprecated |
| bin/cli.py | 2025-12-01 | Keep | CLI entry point (unreferenced by design) |

得:孤審文檔已立;自動之決標待人承

敗則:(無——雖無清處仍書之)

第八步:生修報

摘諸斷引與所施修。

# Reference Repair Report

**Date**: YYYY-MM-DD
**Project**: <project_name>
**Fix Mode**: auto | report | interactive

## Broken Internal Links

- Total: X
- Fixed: Y
- Redirected: Z
- Escalated: W

Details:
- [file.md](file.md) line 45: Fixed broken link to moved doc
- [another.md](another.md) line 12: Created redirect stub

## Dead External URLs

- Total: X
- Fixed (wayback machine): Y
- Removed: Z

Details:
- https://example.com/old-page (404) → Removed
- https://api.old.com/docs (gone) → Replaced with new docs

## Broken Imports

- Total: X
- Fixed: Y
- Escalated: Z

Details:
- src/main.js line 3: Updated import path after refactor

## Orphaned Files

- Total: X
- Kept: Y
- Archived: Z
- Escalated for review: W

See ORPHAN_REVIEW.md for full analysis.

## Validation

- [x] All tests pass after fixes
- [x] Linter reports no module-not-found errors
- [x] Dead links documented in report

得:報存於 REFERENCE_REPAIR_REPORT.md

敗則:(無——雖然亦書之)

修後:

  • 文檔無斷之內鏈
  • 死之外 URL 已書(非皆可修)
  • 諸 import 解正
  • 孤文已審且已決
  • import 修後試過
  • linter 報無未解之引
  • git 史已存(諸移用 git mv

  1. 自動 URL 修破境:以 web.archive.org 之 URL 代死鏈或非著者所欲。某鏈宜除
  2. 過烈刪孤:入點、CLI 之文、樣常合而無引。勿無審而刪
  3. import 路之假:假諸相對 import 用同基路。異模系(CommonJS、ES6、TypeScript)異路
  4. 外 URL 之假陽:某站阻 curl/察機而於覽器中行之。必手驗死 URL
  5. 環引之陷:文 A 引 B,B 引 A。更一破他。需同時修
  6. 忽片識:修 [link](#section) 須察 #section 錨存乎,非獨察文存
  7. 混系之 R 二進制誤:於 WSL 或 Docker,Rscript 或解至跨台之裹而非原 R。以 which Rscript && Rscript --version 察。為信宜用原 R 二進制(如 Linux/WSL 之 /usr/local/bin/Rscript)。R 路之設見 Setting Up Your Environment

GitHub 仓库

pjt222/agent-almanac
路径: i18n/wenyan/skills/repair-broken-references
0
agentsagentskillsai-assisted-developmentclaude-codeskillsteams

相关推荐技能

railway-docs

文档

Railway Docs Skill可实时获取最新的Railway官方文档,确保回答的准确性。当开发者询问Railway功能特性、工作原理或分享docs.railway.com链接时,应优先使用此技能。它通过专门的LLM优化文档源提供最新信息,避免依赖过时记忆来回答技术问题。

查看技能

n8n-code-python

文档

该Skill为在n8n平台的Python代码节点中编写代码提供专家指导,特别适用于需要使用_input/_json/_node语法、Python标准库或了解n8n中Python限制的场景。它强调JavaScript应作为首选方案,仅当需要特定Python功能或对Python语法更熟悉时才使用Python。Skill提供了快速入门模板和关键注意事项,帮助开发者在n8n中高效编写Python代码。

查看技能

archon

文档

Archon Skill为开发者提供了基于RAG的语义搜索和项目任务管理功能,可通过REST API访问知识库。它支持文档搜索、网站爬取、文件上传和版本控制,适用于技术文档查询和项目管理场景。首次使用时需要配置Archon主机地址,建议在处理外部文档时优先使用该Skill。

查看技能

n8n-code-javascript

文档

这个Skill为n8n工作流中的JavaScript代码节点提供专业指导,涵盖数据处理、HTTP请求和日期操作等核心场景。它详细解释了如何正确使用n8n特有的`$input`/`$json`语法、`$helpers`工具以及DateTime对象,并包含关键的错误排查和模式选择建议。开发者通过该Skill能快速掌握Code节点的正确返回格式、数据访问方法和常见陷阱解决方案。

查看技能