Báo cáo kiến trúc và JSON

analyze mặc định ghi hai file dưới <gốc-được-phân-tích>/.nklattice-report/:

File	Mục đích
report.html	Mở cục bộ bằng trình duyệt. Style, script và dữ liệu đã nhúng sẵn; không cần server hoặc script từ xa.
analysis.json	Xem dữ liệu có cấu trúc đầy đủ hoặc đưa vào script review/CI riêng.

Dùng --output DIR để chọn thư mục khác. DIR tương đối được resolve từ thư mục làm việc của terminal, không phải từ gốc được phân tích.

Để xem ảnh giao diện với số liệu tổng hợp đã đo và thông tin mã nguồn đã ẩn, hãy mở ví dụ phân tích React đã ẩn danh. Báo cáo gốc không được công bố.

Đọc báo cáo HTML

Hãy xem số module trước. Điểm của một phạm vi quét quá nhỏ hoặc sai đường dẫn không hữu ích. Sau đó xem điểm theo nhóm có trọng số và lọc finding theo mức độ, nhóm hoặc từ khóa. Báo cáo hiển thị 25 finding khớp bộ lọc mỗi lần; nút Show 25 more findings mở thêm 25 mục tiếp theo mà không đổi bộ lọc. Mỗi finding hiện rule ID, file/dòng, bằng chứng quan sát và gợi ý bước xử lý.

Danh sách hotspot xếp file theo điểm ưu tiên đơn giản: error 5, warning 2, info 1. Dòng “estimated recovery” là ước lượng, không phải công thức điểm hoặc số điểm được đảm bảo tăng. Quick wins chọn một số finding info và import lặp. Roadmap refactor nhóm các file ưu tiên để review; nó không tự tạo thay đổi mã.

Đồ thị cho phép chọn bất kỳ module đã quét làm tâm. Mỗi lần, nó hiện tối đa 12 module kết nối trực tiếp, ưu tiên theo số kết nối và phân biệt chiều import vào/ra. Có thể chọn node lân cận hoặc dùng danh sách chọn module để tiếp tục khám phá. Bảng bên cạnh hiện đường dẫn đầy đủ, số dòng và số liên kết vào/ra. Hình vẽ là góc nhìn tập trung; toàn bộ module và cạnh đã resolve vẫn có trong analysis.json.

Cấu trúc JSON

Các trường cấp cao nhất: schema (urn:nklattice:analysis:1), generatedAt, project, graph, findings, score và actions.

• graph.modules có metric theo file và import; graph.edges liệt kê cạnh nội bộ đã resolve.
• findings chứa đầy đủ bằng chứng và gợi ý của rule.
• score có điểm cuối, hạng, mức trừ theo nhóm, trọng số và các điều chỉnh.
• actions có hotspot, quick win và tóm tắt file theo ưu tiên.

Script có thể xem findings[*].severity hoặc score.score. Bản thân lệnh analyze vẫn trả mã 0 khi có finding. Phiên bản 0.4.0 thêm gate kiến trúc, dependency, chất lượng, bảo mật và tương thích qua governance collect và assess.

Governance dependency có kết quả JSON riêng từ lattice governance check --json; lệnh này không tạo report.html hay analysis.json. Trường findings[*].expected chứa range tối thiểu bắt buộc (ví dụ >=19.3.1 trong policy nguồn), cùng declared, lockfileSpecifier, locked và reason. Governance trả mã 7 khi có finding.

governance assess ghi cặp file khác vào .nklattice-governance/: assessment.json và report.html tự chứa. JSON có trạng thái tám miền theo app, finding bảo mật và chất lượng đã đo, độ phủ, phiên bản browser project được đo, cấu hình OS mobile mô phỏng và ngưỡng policy tương ứng, viewport, định danh bằng chứng và giới hạn kết luận. HTML mở bằng tóm tắt theo miền rồi trình bày bằng chứng của từng app. Xem ảnh báo cáo governance mẫu, tạo từ ba app mẫu trong dự án. Báo cáo này không thay đồ thị khám phá của analyze.

Lịch sử và chia sẻ

Trước khi ghi báo cáo mới vào cùng thư mục, NKLattice chuyển report.html và analysis.json cũ vào history/<timestamp>-<id>/. Công cụ chưa tự tính chênh lệch hai lần chạy. Chỉ so báo cáo khi đường dẫn quét và thiết lập .nklattice.json tương đương.

Báo cáo có thể chứa đường dẫn source, tên import, bằng chứng rule và gợi ý policy. Hãy xem trước khi chia sẻ ngoài repository. Nếu chỉ dùng cục bộ, thêm .nklattice-report/ vào .gitignore của app. Giao diện báo cáo sinh ra hiện bằng tiếng Anh; hướng dẫn trên website này có cả hai ngôn ngữ.

Các ảnh đã ẩn danh dẫn ở trên được chụp bằng CLI 0.2.0. Chúng ghi lại lần đo đó; phiên bản 0.5.0 có báo cáo governance tám miền riêng bên cạnh báo cáo kiến trúc.