Giảm độ phức tạp Cyclomatic với Claude

Skill Cyclomatic Complexity là gì?

cyclomatic-complexity là một skill của Claude được thiết kế để giảm việc phân nhánh quá mức trong mã nguồn hiện có. Skill này đặc biệt hữu ích với mã do AI tạo ra, vốn hoạt động chính xác nhưng đã tích lũy các điều kiện lồng nhau sâu, nhiều luồng quyết định hoặc các hàm khó bảo trì đối với con người.

Skill hướng dẫn Claude thực hiện một quy trình có cấu trúc: đo độ phức tạp theo từng hàm, xác định các điểm nóng nghiêm trọng nhất, tái cấu trúc những điểm nóng đó, xác minh hành vi và tóm tắt kết quả bằng các giá trị độ phức tạp trước và sau.

Thay vì tối ưu điểm số bằng các biểu thức rút gọn hoặc những dòng lệnh ngắn nhưng khó hiểu, skill chuyển logic quyết định vào các hàm rõ ràng, được đặt tên dễ hiểu. Mục tiêu của skill là nâng cao khả năng bảo trì đồng thời giảm chỉ số độ phức tạp.

Tính năng chính

• Đo theo từng hàm: Có thể đo độ phức tạp bằng Radon, ESLint, gocyclo, Lizard hoặc đếm thủ công.
• Ngưỡng phù hợp với dự án: Skill tôn trọng các giới hạn độ phức tạp đã được cấu hình trong linter của dự án.
• Ưu tiên điểm nóng: Skill tái cấu trúc các hàm phức tạp nhất trước thay vì thay đổi mã nguồn một cách thiếu chọn lọc.
• Mẫu tái cấu trúc đã được thiết lập: Skill sử dụng các mệnh đề kiểm tra sớm, hàm được tách riêng, bảng tra cứu và các vị từ được đặt tên.
• Không thao túng chỉ số: Độ phức tạp được tổ chức lại thành các đơn vị dễ hiểu thay vì bị che giấu trong cú pháp dày đặc.
• Báo cáo rõ ràng: Mỗi lần tái cấu trúc đều kết thúc bằng báo cáo độ phức tạp trước và sau.

Cài đặt

Cài đặt trong Claude Code

Thêm marketplace plugin của dự án, sau đó cài đặt skill:

/plugin marketplace add saurabhkumar8112/cyclomatic-complexity-skill
/plugin install cyclomatic-complexity@cyclomatic-complexity-skill

Sau khi cài đặt, Claude Code có thể kích hoạt skill khi xử lý các yêu cầu tái cấu trúc, dọn dẹp và đánh giá mã nguồn phù hợp.

Cài đặt trong Claude.ai

1. Mở mục Releases của kho lưu trữ và tải xuống tệp .skill. Ngoài ra, bạn có thể tạo tệp ZIP từ thư mục skills/cyclomatic-complexity.
2. Mở Claude.ai và đi đến Settings, sau đó chọn Capabilities rồi Skills.
3. Tải lên tệp skill hoặc tệp ZIP đã tải xuống.

Cài đặt bằng Claude API

Đối với quy trình dựa trên API, hãy tải skill lên thông qua Claude Skills API. Làm theo hướng dẫn API để biết quy trình tải lên và cấu hình hiện tại.

Cách sử dụng cơ bản

Skill tự động kích hoạt khi yêu cầu của bạn liên quan đến việc tái cấu trúc, dọn dẹp hoặc đánh giá mã nguồn. Để kiểm soát nhiều hơn, hãy nêu rõ tên skill và xác định tệp bạn muốn Claude kiểm tra.

Sử dụng skill cyclomatic complexity để tái cấu trúc parser.py

Yêu cầu trực tiếp này xác định cả quy trình mong muốn lẫn tệp mục tiêu. Sau đó, Claude có thể đo độ phức tạp, tìm các hàm có vấn đề nhất và áp dụng những mẫu tái cấu trúc phù hợp.

Yêu cầu đánh giá mã nguồn tập trung

Bạn cũng có thể trình bày tác vụ dưới dạng đánh giá tập trung vào độ phức tạp:

Đánh giá parser.py bằng skill cyclomatic complexity. Đo độ phức tạp theo từng hàm và tái cấu trúc các điểm nóng nghiêm trọng nhất trước.

Nếu dự án của bạn đã định nghĩa ngưỡng linter, hãy giữ cấu hình đó trong kho lưu trữ để skill có thể tuân thủ tiêu chuẩn hiện có của dự án.

Tìm hiểu quy trình tái cấu trúc

1. Đo từng hàm: Skill sử dụng một công cụ phân tích được hỗ trợ phù hợp, chẳng hạn như Radon, ESLint, gocyclo hoặc Lizard. Skill cũng có thể đếm thủ công.
2. Kiểm tra ngưỡng của dự án: Các giới hạn linter hiện có được ưu tiên khi đã được cấu hình.
3. Xếp hạng điểm nóng: Các hàm có độ phức tạp cao nhất được xử lý trước.
4. Áp dụng các biến đổi dễ đọc: Claude thêm các mệnh đề kiểm tra sớm, tách hàm, tạo bảng tra cứu hoặc đặt tên cho các vị từ phức tạp khi phù hợp.
5. Xác minh hành vi: Việc tái cấu trúc phải bảo toàn hành vi hiện có, sử dụng bộ kiểm thử sẵn có để xác minh.
6. Báo cáo kết quả: Phản hồi cuối cùng hiển thị độ phức tạp trước và sau khi thay đổi.

Đọc kết quả

Một lần tái cấu trúc hoàn tất sẽ bao gồm báo cáo tương tự như sau:

## Báo cáo độ phức tạp
| Hàm | Trước | Sau |
|----------|--------|-------|
| parseOrder | 14 | 4 |

Đã tách: validateHeader, resolveDiscount
Đã xác minh hành vi: bộ kiểm thử hiện có đã vượt qua

Trong ví dụ này, parseOrder được giảm độ phức tạp từ 14 xuống 4. Báo cáo cũng nêu tên các hàm được tách là validateHeader và resolveDiscount, đồng thời ghi nhận rằng các bài kiểm thử hiện có đều đạt.

Danh sách các hàm được tách rất quan trọng vì chỉ riêng một con số thấp hơn không chứng minh rằng mã nguồn dễ bảo trì hơn. Tên rõ ràng cho thấy trách nhiệm đã được chuyển đến đâu và giúp người đánh giá hiểu cấu trúc mới.

Kỹ thuật tái cấu trúc được skill sử dụng

Mệnh đề kiểm tra sớm

Các mệnh đề kiểm tra sớm xử lý điều kiện không hợp lệ hoặc ngoại lệ ngay từ đầu. Điều này có thể giảm mức độ lồng nhau và giúp dễ theo dõi luồng thực thi chính hơn.

Hàm được tách riêng

Khi một hàm thực hiện nhiều quyết định hoặc đảm nhiệm nhiều trách nhiệm, skill có thể chuyển các phần mạch lạc vào những hàm được đặt tên rõ ràng. Cách này phân bổ độ phức tạp vào các đơn vị thể hiện ý định của chúng.

Bảng tra cứu

Các nhánh lặp lại ánh xạ những đầu vào đã biết với các kết quả đã biết có thể được thay thế bằng bảng tra cứu. Kỹ năng này sử dụng cách tiếp cận đó khi nó giúp mã rõ ràng hơn, thay vì chỉ rút ngắn mã.

Vị từ có tên

Các điều kiện phức tạp có thể được đặt trong những hàm có tên giải thích quy tắc nghiệp vụ. Điều này giúp các điểm ra quyết định dễ đọc hơn và tránh các biểu thức điều kiện khó hiểu.

Mẹo nâng cao

Bắt đầu với phạm vi mục tiêu hẹp

Đối với một cơ sở mã lớn, hãy bắt đầu với một tệp hoặc một khu vực có vấn đề đã xác định. Một chỉ dẫn tập trung như refactor parser.py cung cấp cho kỹ năng này một ranh giới rõ ràng và giúp báo cáo kết quả dễ xem xét hơn.

Đảm bảo có cấu hình linter

Nếu dự án của bạn có ngưỡng độ phức tạp riêng, hãy đảm bảo cấu hình liên quan hiện diện khi Claude thực hiện tác vụ. Kỹ năng này được thiết kế để tuân theo các giới hạn do dự án định nghĩa thay vì áp đặt một tiêu chuẩn không liên quan.

Yêu cầu xử lý các điểm nóng tệ nhất trước

Ưu tiên những hàm có độ phức tạp cao nhất sẽ tập trung nỗ lực vào nơi có thể tạo ra tác động lớn nhất đến khả năng bảo trì. Cách này cũng tránh những thay đổi không cần thiết đối với các hàm vốn đã đơn giản.

Xem xét tên, không chỉ điểm số

Hãy kiểm tra tên của các hàm và vị từ được tách ra, bên cạnh các con số cuối cùng. Những tên như validateHeader và resolveDiscount giải thích rõ trách nhiệm; các tên trợ giúp mơ hồ sẽ khiến việc tái cấu trúc kém hữu ích hơn, ngay cả khi điểm số đo được giảm xuống.

Dùng kiểm thử để kiểm tra an toàn

Việc giảm độ phức tạp cần bảo toàn hành vi. Hãy duy trì bộ kiểm thử hiện có và xác nhận báo cáo cuối cùng ghi nhận liệu bộ kiểm thử có đạt hay không. Điểm độ phức tạp tốt hơn không nên phải đánh đổi bằng tính đúng đắn.

Tránh các yêu cầu khuyến khích tối ưu chỉ số

Hãy yêu cầu những thay đổi dễ đọc, dễ bảo trì thay vì điểm số nhỏ nhất có thể. Kỹ năng này chủ động tránh che giấu các quyết định trong những dòng lệnh một dòng cầu kỳ, vì vậy câu lệnh nên củng cố tính rõ ràng và khả năng bảo trì lâu dài.

Kết luận

Kỹ năng về độ phức tạp chu trình cung cấp cho Claude một quy trình có thể lặp lại để cải thiện mã có nhiều nhánh. Kỹ năng này đo lường độ phức tạp, tuân theo các ngưỡng của dự án, xử lý trước những hàm tệ nhất, áp dụng các mẫu tái cấu trúc dễ đọc, xác minh hành vi và kết thúc bằng một báo cáo cụ thể trước và sau. Dự án được phân phối theo giấy phép Apache 2.0.