gper/Gnuboard7
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
Gnuboard7/docs/extension/README.md
T
HeuJung 11175d35d6 feat(core,docs): 확장별 개발자 문서 생성기와 검사 하네스 구축 
번들 확장 20개 중 에이전트·확장개발자가 읽을 수 있는 문서를 가진 확장이 0개였다.
`docs/api/**` 는 "엔드포인트가 무엇을 받고 무엇을 돌려주는가" 만 답하고, 확장을 고치려는
쪽이 실제로 묻는 것(왜 이렇게 설계됐는가 / 어디를 확장해야 하는가 / 무엇을 건드리면 안
되는가)은 어디에도 없었다. 그 결과 확장이 발행하는 훅은 확장점인데도 사실상 비공개였다.

이 커밋은 인프라만 담는다. 문서 집필은 확장별로 순차 진행한다.

- `php artisan ext:docgen` — 진입 클래스의 선언형 getter 를 실제로 호출하고 소스를 스캔해
 훅·라우트·권한·메뉴·설정·모델·레이아웃·핸들러·테스트 경로·의존 관계를 실측한다.
 `_bundled` 를 읽는다 (활성 디렉토리에 같은 FQCN 이 로드돼 있으면 eval-rename 으로 우회).
- 자동 생성 블록은 **안쪽만** 교체한다. 사람 서술이 소실될 경로를 만들지 않으려고 파괴적
 재생성 플래그를 두지 않았고, 문서에 없는 블록 키는 주입하지 않고 누락으로 보고한다.
- 필수 문서·섹션·블록 목록은 `ExtensionDocScaffolder::DOCUMENTS` 단일 SSoT 다. 검사
 스크립트는 이를 복제하지 않고 `--check --json` 을 소비하며, PHP 를 못 돌리면 "이상 0건"
 이 아니라 "점검 불가" 로 구분 보고한다.
- 두 audit 룰은 도입 시점 전수가 공허 통과하므로(대상 문서 0건) 픽스처 테스트가 판정식을
 잠근다. 스캐너·mermaid·검사 스크립트 축도 같은 이유로 픽스처를 함께 둔다.

동반 수정: 훅이 넘기는 `file_path` 는 항상 절대경로인데 `FILE_RULES` 다수가 루트로
앵커해 있어 그 규칙들이 조용히 죽어 있었다(추적 파일 440개가 절대경로에서 0건 매치).
`toRepoRelative` 로 정규화하고 세 경로 형태의 판정 일치를 테스트로 고정했다.
문서 인덱스 생성기의 CRLF 문서 제목·TL;DR 추출 누락도 같은 성격이라 함께 고쳤다.
2026-08-31 07:58:44 +09:00

6.1 KiB
Raw Permalink Blame History

그누보드7 확장 시스템 개발 가이드

이 문서는 그누보드7의 확장 시스템 전체 개요와 각 상세 문서에 대한 링크를 제공합니다.

핵심 원칙

필수: /modules, /plugins 디렉토리 스캔으로 자동 발견 (composer.json 하드코딩 금지)
필수: 모든 확장 작업은 Artisan 커맨드로 수행
✅ 필수: 훅 시스템을 통한 코어 수정 최소화

확장 시스템 개요

G7은 동적 로딩 기반의 확장 시스템을 제공합니다:

  • 모듈: 독립적인 비즈니스 기능 단위 (예: 이커머스, 블로그)
  • 플러그인: 특정 기능 확장 (예: 결제, 배송)
  • 템플릿: UI 렌더링 및 레이아웃 정의 (Admin, User)
  • 훅 시스템: 코어 수정 없이 로직 확장

문서 구조

훅 시스템

문서 설명
hooks.md Action/Filter Hook, 리스너 구현, 우선순위

모듈 개발

문서 설명
module-basics.md AbstractModule, 디렉토리 구조, 네이밍 규칙
module-routing.md API/Web 라우트, 자동 Prefix, routes.json
module-layouts.md 레이아웃 등록, 오버라이드, 상속
module-commands.md Artisan 커맨드 (install, activate, uninstall)
module-i18n.md 백엔드/프론트엔드 다국어 분리

레이아웃 확장

문서 설명
layout-extensions.md 동적 UI 주입 (Overlay, Extension Point), 템플릿 오버라이드

플러그인 개발

문서 설명
plugin-development.md PluginInterface, 격리성, 의존성 원칙

확장 관리자

문서 설명
extension-manager.md Composer 오토로드, 서비스 등록, hidden 필터링

학습용 샘플

문서 설명
sample-extensions.md 학습용 최소 샘플 확장 4종 (gnuboard7-hello_*) — 계층 1:1 비교 레퍼런스

템플릿 시스템

문서 설명
template-basics.md Admin/User 템플릿, 메타데이터, 버전 히스토리
template-routing.md 라우트 정의, 언어 파일 경로 규칙
template-security.md API 서빙, 파일 확장자 화이트리스트
template-caching.md 캐시 계층, 무효화 전략
template-commands.md Artisan 커맨드 (install, activate)

권한 및 메뉴 시스템

문서 설명
permissions.md Role, Permission, 자동 관리
menus.md 메뉴 권한, 시더

확장 문서화

문서 설명
extension-documentation.md AGENTS.md/README.md/docs 역할 경계, 자동 생성 블록 규약, ext:docgen
changelog-rules.md 버전 상향 시 CHANGELOG 기재 의무

확장 타입별 네이밍 규칙

타입 디렉토리명 네임스페이스 Composer 경로
모듈 vendor-module Modules\Vendor\Module\ modules/vendor-module
플러그인 vendor-plugin Plugins\Vendor\Plugin\ plugins/vendor-plugin
템플릿 vendor-template - templates/vendor-template

예시:

  • 모듈: sirsoft-ecommerce → Modules\Sirsoft\Ecommerce\
  • 플러그인: sirsoft-payment → Plugins\Sirsoft\Payment\
  • 템플릿: sirsoft-admin_basic

훅 네이밍 규칙

[vendor-module].[entity].[action]_[timing]

타이밍 접미사:

  • before_*: 작업 실행 전
  • after_*: 작업 실행 후
  • on_*: 특정 이벤트 발생 시
  • filter_*: 데이터 필터링

예시:

sirsoft-ecommerce.product.before_create
sirsoft-ecommerce.product.after_update
sirsoft-ecommerce.product.filter_create_data
sirsoft-ecommerce.order.on_payment_success

주요 Artisan 커맨드

모듈 관련

php artisan module:list                    # 모듈 목록 조회
php artisan module:install [identifier]    # 모듈 설치
php artisan module:activate [identifier]   # 모듈 활성화
php artisan module:deactivate [identifier] # 모듈 비활성화
php artisan module:uninstall [identifier]  # 모듈 제거
php artisan module:cache-clear             # 모듈 캐시 정리

템플릿 관련

php artisan template:list                    # 템플릿 목록 조회
php artisan template:install [identifier]    # 템플릿 설치
php artisan template:activate [identifier]   # 템플릿 활성화
php artisan template:deactivate [identifier] # 템플릿 비활성화
php artisan template:uninstall [identifier]  # 템플릿 제거
php artisan template:cache-clear             # 템플릿 캐시 정리

확장 관리자

php artisan extension:update-autoload   # Composer 오토로드 업데이트

빠른 시작 가이드

새 모듈 개발 시

  1. module-basics.md - 기본 구조 이해
  2. module-routing.md - 라우트 설정
  3. module-i18n.md - 다국어 지원
  4. module-layouts.md - 레이아웃 등록 (필요시)
  5. hooks.md - 훅 리스너 구현 (필요시)

새 플러그인 개발 시

  1. plugin-development.md - 플러그인 구조 이해
  2. hooks.md - 훅 리스너 구현

템플릿 커스터마이징 시

  1. template-basics.md - 템플릿 타입 이해
  2. template-routing.md - 라우트/언어 파일
  3. template-security.md - 보안 규칙

관련 문서

Reference in New Issue View Git Blame Copy Permalink