Skip to content

feat: add ast-grep code quality checker framework#176

Open
suyiiyii wants to merge 8 commits into
mainfrom
feat/ast-grep-integration
Open

feat: add ast-grep code quality checker framework#176
suyiiyii wants to merge 8 commits into
mainfrom
feat/ast-grep-integration

Conversation

@suyiiyii

@suyiiyii suyiiyii commented Jan 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

📋 Summary

添加基于 ast-grep 的 Python 代码质量检查脚本框架。

当前版本实现了一个可用的检查规则：

  • ⚠️ 检测 print() 语句 - 发现代码中使用 print() 的地方，应使用 logger

✨ 新增功能

ast-grep 代码质量检查脚本 (scripts/ast_grep_check.py)

当前规则：

  • ⚠️ 检测 print() 语句 - 应使用 logger 而非 print()

特性：

  • ✅ 符合项目约定（与 lint.py 设计模式一致）
  • ✅ 仅检查模式（不修改代码）
  • ✅ 简洁输出（✅/❌ + 详细位置信息）
  • ✅ 完善的错误处理
  • ✅ 集成到 CI/CD 工作流（阻塞式检查）

技术细节：

  • 使用 sg run -p 参数传递简单表达式
  • 378 行 Python 代码
  • 使用 dataclass 配置
  • Python 3.10+ 类型注解

🔧 使用方法

运行检查

# 检查所有规则
uv run python scripts/ast_grep_check.py

# 列出所有规则
uv run python scripts/ast_grep_check.py --list

本地测试结果

当前版本发现了 47 处使用 print() 的代码：

❌ ⚠️  检测 print() 语句
   📍 AutoGLM_GUI/agents/mai/agent.py:xxx
   📍 AutoGLM_GUI/parsers/phone_parser.py:xxx
   ... 还有 42 个匹配

🔮 未来改进

这是一个框架性质的 PR，当前实现了：

  • ✅ ast-grep 检查脚本的基础架构
  • ✅ 集成到 CI/CD 工作流
  • ✅ 一个可用的检查规则（print 检测）

未来规划：

  • 添加更多简单规则（如 TODO/FIXME 检测）
  • 研究如何实现复杂规则（类型注解、海象运算符等）
  • 考虑添加配置文件支持
  • 扩展到 TypeScript 代码检查

📝 技术细节

依赖：

  • ast-grep (sg) CLI 工具 (0.40.5+)
  • Python 3.10+
  • 集成到 .github/workflows/pr-lint.yml

限制：

  • ast-grep CLI 对复杂规则的支持有限，当前只能使用简单表达式
  • 不支持自动修复功能
  • 某些高级检查（如未使用的导入）需要数据流分析，不适合 AST 检查

📚 相关文档

Co-authored-by: Claude Code claude@anthropic.com

@suyiiyii @claude
feat: add ast-grep code quality checker
142aeb6 
Add ast-grep based Python code quality checker with 5 rules:
- Type annotation upgrade (Optional[Type] → Type | None)
- Walrus operator optimization (:= simplification)
- Print statement detection (should use logger)
- Empty except block detection
- Broad exception catch detection

Also include automated fix script for applying type hint updates.

Files added:
- scripts/ast_grep_check.py: Main checker script (374 lines)
- apply-ast-grep-fixes.sh: Automated type hint upgrade script

Co-authored-by: Claude Code <claude@anthropic.com>
@vercel

vercel Bot commented Jan 13, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
autoglm-gui Ready Ready Preview, Comment Jan 13, 2026 3:56am

@github-actions

github-actions Bot commented Jan 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🚀 Lint & Format Check Results: ❌ FAILED

What was checked:

  • 🔍 Code Quality: ast-grep pattern matching (5 rules)
  • 🐍 Backend: Ruff linting + formatting
  • 📱 Frontend: ESLint + Prettier + TypeScript types
  • 🔧 Unified: Custom lint script validation

❌ Some checks failed!

How to fix:

  1. Run locally to auto-fix most issues:
uv run python scripts/lint.py
  1. Commit the fixes and push:
git add .
git commit -m "fix: apply lint and format fixes"
git push
  1. The checks will run again automatically.

Individual fix commands:

Code Quality (ast-grep):

uv run python scripts/ast_grep_check.py
# Review reported issues and fix manually

Backend (Ruff):

uv run ruff check --fix
uv run ruff format

Frontend:

cd frontend
pnpm lint --fix
pnpm format
cd ..

This is an automated check. For questions, ask in the PR discussion.

@suyiiyii
chore: remove auto-fix script (check-only approach)
a803e55 
Remove apply-ast-grep-fixes.sh to maintain check-only approach.
The ast-grep checker scripts/ast_grep_check.py is designed for
code quality checking only, without auto-fix capability.

Users should manually review and fix issues reported by the checker.
@suyiiyii @claude
ci: add ast-grep check to PR lint workflow
f89cfa3 
Add ast-grep code quality check to CI/CD pipeline:

Changes:
- Install ast-grep CLI tool
- Run ast-grep checker (non-blocking)
- Update PR comment to include ast-grep results

The ast-grep check is informational (non-blocking) to avoid
failing PRs for style improvements, while still alerting developers
to potential code quality issues.

Co-authored-by: Claude Code <claude@anthropic.com>
@suyiiyii @claude
fix: make ast-grep check blocking in CI
3eab89a 
Remove the non-blocking `|| echo` wrapper from ast-grep check
to align with other lint checks (ruff, eslint, etc.).

The ast-grep check should fail the PR if code quality issues are found,
consistent with the blocking nature of all other lint checks.

Co-authored-by: Claude Code <claude@anthropic.com>
@suyiiyii @claude
fix: simplify ast-grep checker to one working rule
d4b9c19 
Remove complex YAML-based rules that don't work with ast-grep CLI.
Keep only the no-print rule which uses a simple expression pattern.

Changes:
- Simplify RULES to only include no-print check
- Fix check_rule to use direct -p parameter
- Remove tempfile and os imports (no longer needed)
- Fix pattern extraction logic

This makes the checker functional but limited.
We can add more rules later with correct ast-grep syntax.

Co-authored-by: Claude Code <claude@anthropic.com>
@suyiiyii suyiiyii changed the title feat: add ast-grep code quality checker feat: add ast-grep code quality checker framework Jan 13, 2026
@suyiiyii
fix: correct ast-grep pattern and JSON field in checker script
4f9ad2c 
- Fix pattern from `print($_)` to `print($$$)` to properly match print calls
  - `$_` only matches a single node, causing ERROR nodes in ast-grep
  - `$$$` matches zero or more arguments, which is correct for print()
- Fix JSON field from `path` to `file` to match ast-grep's output format
- This allows the checker to correctly identify print() statements in codebase
@suyiiyii
refactor: replace all print() statements with logger calls
21bada9 
- AutoGLM_GUI/__main__.py:
  - Add logger import
  - Replace startup banner print statements with logger.info
  - Replace browser error print with logger.warning
  - Replace port detection/error prints with logger.info/error

- AutoGLM_GUI/adb/connection.py:
  - Add logger import
  - Replace error print with logger.error

- AutoGLM_GUI/agents/glm/agent.py:
  - Replace verbose mode prints with logger.info
  - Replace print_chunk function to use logger.info

- AutoGLM_GUI/agents/mai/agent.py:
  - Replace verbose mode prints with logger.info
  - Replace traceback.print_exc() with logger.exception()
  - Replace performance stats prints with logger.info

All changes ensure proper logging through the project's logger
instead of using print() statements, which improves log management
and consistency.
@suyiiyii
refactor(ast-grep-checker): improve code formatting and consistency
0ccbf74 
- Format command list with proper indentation for better readability
- Add trailing commas to RuleResult initialization calls for
  consistency
- Simplify JSON decode error handling by keeping all parameters
  on single line when appropriate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@suyiiyii