코드 변경 시 자동 업데이트되는 퍼널 문서, AST로 구현!
by DD
5개월 전
조회수 23
AST를 활용하여 코드로부터 자동으로 퍼널 문서를 생성함
39개 페이지의 복잡한 분기 로직을 정적 분석으로 해결
신규 입사자 온보딩 시간 단축 및 코드 변경 시 자동 문서 업데이트 지원
AST 기반 문서 자동화 원리
구체적으로 ts-morph 라이브러리를 사용하여 AST(Abstract Syntax Tree)를 생성한다. 따라서 코드 구조를 트리 형태로 파악하여 Navigation 정보를 추출한다. 결과적으로 조건부 분기 및 훅 내부 호출까지 분석하여 정확한 퍼널 흐름을 파악한다.
정적 분석 vs 런타임 분석 비교
정적 분석은 AST 파싱을 통해 모든 경로를 한 번에 파악한다. 반면 런타임 분석은 실행 시점에 경로를 기록하므로 모든 케이스 실행이 필요하다. 따라서 정적 분석은 빠르고 안전하며, 동적 로직 파악에는 어려움이 있다.
자동 문서화의 실질적 효과
자동 문서화는 신규 입사자 온보딩 시간 단축을 가져온다. 또한 코드 변경 시 스크립트 재실행만으로 문서 자동 업데이트가 가능하다. 따라서 데드엔드 페이지 발견 및 영향 범위 파악이 용이해져 개발 생산성을 향상시킨다.
