Files
CODE_ASSISTANT/docs/snippets/README.md
T

2.0 KiB

스니펫 메타 검토 · 반영

snippet_meta_review.csv — 공용 스니펫 143개의 한글 설명 초안과, 옛 규칙 이름(-ABAP 꼬리) 11개의 새 이름. 2026-09-23 에 본문(코드·★ 머리줄·주석)을 읽고 AI 가 만든 초안이라 사람 검토가 필요함.

검토

  • 엑셀로 열림(UTF-8 BOM). 열: name(지금 이름) · new_name(비어 있으면 안 바꿈) · desc(한글 설명).
  • 설명은 사용자가 검색창에 칠 말이 들어가게: 한글 업무 용어(전표·코스트센터·팝업·엑셀) + 핵심 ABAP 키워드.
  • 새 이름 규칙: 영문 대문자·숫자·_, 문자로 시작, 3~50자, 권장 모양 영역_대상_동작.
  • 고친 뒤 UTF-8 CSV 로 저장(엑셀 "CSV UTF-8").

반영 (서버마다 한 번)

cd <repo>/code-assistant/5_django_backend      # 우리 서버 도커면: docker compose exec be python manage.py ...
.venv/bin/python manage.py apply_snippet_meta ../docs/snippets/snippet_meta_review.csv --dry-run   # 바뀔 것만 출력
.venv/bin/python manage.py apply_snippet_meta ../docs/snippets/snippet_meta_review.csv             # 반영
  • 설명은 비어 있거나 한글이 없는 것만 채움(사용자가 이미 한글로 고친 건 안 건드림). --overwrite 면 덮어씀.
  • 이름 변경은 사람별 사용 기록도 같이 옮김. 새 이름이 이미 있으면 건너뜀. 여러 번 돌려도 결과 같음.
  • 로컬 실데이터 실측(143개): 설명 143 · 이름 변경 11 · 규칙 위반 0. 한글 검색 '팝업' 0→8건, '전표' 0→6건.

관련 규칙 (코드)

  • 이름 규칙: 2_frontend/src/features/snippets/core/name.ts = 5_django_backend/apps/snippets/views.py (normalize_name, NAME_RE)
  • 검색: 이름 + 설명 + 본문의 ★ 머리줄·주석줄(core/search.ts). 본문 코드 줄은 안 봄.
  • import_snippets 는 스니펫이 하나도 없을 때만 돎(처음 채우기). 배포마다 불려도 중복·옛 이름 부활 없음.