bklog-utils

Map change propagation across core bklog utility modules.

88|138|Updated Oct 26, 2023

Search Tags:#refactoring #codebase #dependencies #utilities #map #change-impact #bk-monitor

Ready to run

npx skills add https://github.com/TencentBlueKing/bk-monitor --skill bklog-utils

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bklog-utils
Source: https://github.com/TencentBlueKing/bk-monitor/tree/main/bklog/web/.ai-shared/skills/bklog-utils
Command: npx skills add https://github.com/TencentBlueKing/bk-monitor --skill bklog-utils

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a way to map the touchpoints, boundaries, and change radii of core utilities across the bk-monitor codebase, helping teams reason about the impact of changes before they are implemented.

Core Features & Use Cases

Utility mapping: Visualize core utilities (src/common/util.js, src/common/bkmagic.js, src/common/bus.js, src/common/field-resolver.ts, src/global/utils/) and how changes propagate.
Change impact planning: Identify ripple effects and plan safely when evolving shared interfaces.
Boundaries & constraints: Enforce guidelines to avoid duplications, unintended side-effects, and improper util usage in code.

Quick Start

Use bklog-utils to map the utilities touched by a change and assess downstream impact before implementing changes.

Frequently Asked Questions about bklog-utils

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I analyze change impact for shared utilities before refactoring a codebase?▼

To analyze change impact, map the touchpoints and boundaries of core utilities to identify ripple effects across dependent modules. This visualizes how changes propagate, helping teams reason about safe evolution of internal interfaces before implementation.

What is utility mapping and how does it help manage dependencies?▼

Utility mapping visualizes core utilities like util.js and bus.js to show how changes propagate across dependent modules. It tracks dependency boundaries and constraints, preventing duplications and unintended side-effects during codebase maintenance and interface evolution.

How do I track ripple effects when evolving shared interfaces in bk-monitor utilities?▼

Track ripple effects by mapping the touchpoints of core utilities like field-resolver.ts and bkmagic.js to assess downstream impact. This identifies how changes ripple through dependent modules, enabling safe planning when evolving shared interfaces.

Can I use this to enforce boundaries and prevent improper utility usage in my code?▼

Yes, you can enforce boundaries and constraints to avoid duplications and unintended side-effects from improper utility usage. It maps core utilities to maintain clear guidelines, ensuring safe evolution of internal interfaces across the codebase.

What is the best way to plan safe refactoring across core utility modules?▼

The best way to plan safe refactoring is to map the utilities touched by a change and assess downstream impact before implementing. Identifying change radii and touchpoints of core utilities prevents unintended side-effects during maintenance and interface evolution.