deuk-agent-rule 1.0.13 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,89 +1,143 @@
1
- # Changelog
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [2.2.1] - 2026-04-06
2
8
 
3
- All notable changes to this project will be documented in this file.
4
-
5
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
-
7
- ## [1.0.13] - 2026-03-28
8
-
9
-
10
- ### Fixed
11
-
12
- - **deuk-agent-rule:** `printHandoffTip` missing in CLI (handoff tip after `init`)
13
-
14
-
15
- ### Changed
16
-
17
- - **docs:** README § Handoffs; GitHub About text; npm keywords; CLI survey adds Claude, Windsurf, JetBrains AI Assistant
18
- - **agents:** optional `.cursor/plans/*.plan.md` mirror for plan-style UI; chat `Path:` line and optional first-line path in handoff files
19
- - **deuk-agent-rule:** `init` prints a short handoff tip after ensuring `.deuk-agent-handoff/`
20
- - **deuk-agent-rule:** default `--rules prefix` overwrites existing `deuk-agent-rule-*.mdc` on repeat `init` (package updates without a separate `merge`)
21
- - **deuk-agent-rule:** `.deuk-agent-rule.config.json` stores interactive choices; later `init` reuses them (`--interactive` to change; `--non-interactive` for CI only)
22
-
23
-
24
- ## [1.0.12] - 2026-03-27
25
-
26
-
27
- ### Fixed
28
-
29
- - **ci:** run release workflow on master; document GitHub is not auto-synced from gplat
30
-
31
-
32
- ### Changed
33
-
34
- - **agents:** require full repo-root paths for handoff file links
35
-
36
- ## [1.0.11] - 2026-03-26
37
-
38
-
39
- ### Added
40
-
41
- - **ci:** GitHub Release on main for chore(release); simplify public RELEASING
42
-
43
- ## [1.0.10] - 2026-03-26
44
-
45
-
46
- ### Added
47
-
48
- - **deuk-agent-rule:** keep a changelog templates without commit links
49
-
50
- ## [1.0.9] - 2026-03-27
51
-
52
- ### Added
53
-
54
- - **deuk-agent-rule:** automated changelog and release tooling
55
- - **deuk-agent-rule:** handoff gitignore, pre-work handoff scan, AGENTS inject newline
56
-
57
- ### Changed
58
-
59
- - **agents:** DeukAgentRules/handoff/LATEST.md handoff path for consumer repos
60
-
61
- ## [1.0.8] - 2026-03-27
62
-
63
- ### Added
64
-
65
- - This changelog and npm `files` entry so releases are traceable.
66
-
67
- ## [1.0.7] - 2026-03-27
68
-
69
- ### Added
70
-
71
- - `init`: create `.deuk-agent-handoff/` and append `.gitignore` rules for local handoffs.
72
- - CLI: pre-work handoff scan; `publish/AGENTS.md` and `multi-ai-workflow.mdc` updates.
73
-
74
- ### Fixed
75
-
76
- - AGENTS tagged-region merge: trailing newline after injected blocks.
77
-
78
- ## [1.0.5] - 2026-03-26
79
-
80
- ### Changed
81
-
82
- - README and package metadata (Deuk Family tagline, npm keywords, GitHub Topics note).
83
-
84
- ## [1.0.4] - 2026-03-26
85
9
 
86
10
  ### Changed
87
11
 
88
- - Release packaging includes `package-lock.json` for reproducible installs.
89
- - README: absolute links for the npm package page.
12
+ - move ticket marker and unify rules to english plain text
13
+
14
+ ## [2.2.0] - 2026-04-06
15
+
16
+ ### Added
17
+ - cli: support implementation_plan.md and Plan headers during migration
18
+ - rules: enforce mandatory English-only rules in publish directory
19
+ - rules: implement Hard Rule for no Markdown word emphasis (Plain Text only)
20
+ - rules: move ticket file path marker to the bottom of the document
21
+
22
+ ## [2.1.0] - 2026-04-05
23
+
24
+ ### Added
25
+ - cli: add ticket close status logic and verify workflow phase
26
+ - cli: print actual title instead of topic slug in ticket list
27
+ - rules: add pre-report self-review phase to definitive workflow
28
+ - rules: enforce priority ticket creation and add /ticket slash command
29
+
30
+ ### Fixed
31
+ - cli: exclude TICKET_LIST logic files from ticket auto-recovery scan
32
+ - cli: replace broken auto-recovery fallback with physical file sync logic
33
+
34
+ ### Changed
35
+ - architecture: add how-it-works guide for CLI operating principles
36
+ - enforce mandatory post-test artifact risk analysis workflow
37
+ - readme: add npm and github status badges to header
38
+ - readme: enhance docs with definitive 5-phase workflow and richer prompt usage examples
39
+ - readme: prioritize prompt-driven workflow and adopt neutral metrics
40
+ - readme: simplify workflow section with 6-phase table and sample scenario
41
+ - system: add interactive system and stack selection guide
42
+ - workflow: add Korean workflow user guide tutorial
43
+
44
+ ## [2.0.0] - 2026-04-05
45
+
46
+ ### Added
47
+ - ci: GitHub Release on main for chore(release); simplify public RELEASING
48
+ - cli: extend merge tooling and sync publish docs
49
+ - cli: tag .cursorrules inject/remove and sync template from publish
50
+ - deuk-agent-rule: automated changelog, bump tooling
51
+ - deuk-agent-rule: handoff gitignore, pre-work handoff scan, AGENTS inject newline
52
+ - deuk-agent-rule: keep a changelog templates without commit links
53
+ - forbid 'sync' word in commit titles in agent rules
54
+ - handoff: add indexed handoff workflow and CLI
55
+ - workflow: introduce Ticket-First Workflow and Multi-AI Handoff architecture
56
+
57
+ ### Fixed
58
+ - ci: run release workflow on master; document GitHub is not auto-synced from gplat
59
+ - templates: remove workspace-specific paths from default global rules
60
+
61
+ ### Changed
62
+ - absolute links for npm page
63
+ - agents: DeukAgentRules/handoff/LATEST.md handoff path for consumer repos
64
+ - agents: require full repo-root paths for handoff file links
65
+ - Deuk Family tagline, npm keywords, GitHub Topics note
66
+ - migrate handoff to ticket terminology
67
+ - public-facing RELEASING and changelog wording; sync-bundle comment
68
+ - README updates; delivery-and-parallel-work rule; CLI and publish AGENTS updates
69
+
70
+ ## [1.1.0] - 2026-04-05
71
+
72
+ ### Added
73
+ - deuk-agent-rule: Modular CLI architecture (ESM native).
74
+ - deuk-agent-rule: Recursive directory path resolution for robust ticket discovery.
75
+ - deuk-agent-rule: Strict marker casing validation to prevent duplicate injected blocks.
76
+
77
+ ### Changed
78
+ - docs: Transitioned to minimalist DeukPack styling for README.
79
+ - deuk-agent-rule: Generalized project detection from hardcoded strings to dynamic metadata (Project: prefix).
80
+ - deuk-agent-rule: CLI flags now rigorously override saved config values (Config Inheritance).
81
+ - deuk-agent-rule: ticket list and ticket use gracefully fail if system is uninitialized.
82
+
83
+ ## [1.0.13] - 2026-03-28
84
+ ### Fixed
85
+ - deuk-agent-rule: printTicketTip missing in CLI (ticket tip after init)
86
+
87
+ ### Changed
88
+ - docs: README § Tickets; GitHub About text; npm keywords; CLI survey adds Claude, Windsurf, JetBrains AI Assistant
89
+ - agents: optional .cursor/plans/*.plan.md mirror for plan-style UI; chat Path: line and optional first-line path in ticket files
90
+ - deuk-agent-rule: init prints a short ticket tip after ensuring .deuk-agent-ticket/
91
+ - deuk-agent-rule: default --rules prefix overwrites existing deuk-agent-rule-*.mdc on repeat init (package updates without a separate merge)
92
+ - deuk-agent-rule: .deuk-agent-rule.config.json stores interactive choices; later init reuses them (--interactive to change; --non-interactive for CI only)
93
+
94
+ ## [1.0.12] - 2026-03-27
95
+
96
+ ### Fixed
97
+ - ci: release workflow runs on pushes to master
98
+
99
+ ### Changed
100
+ - agents: require full repo-root paths for ticket file links
101
+
102
+ ## [1.0.11] - 2026-03-26
103
+
104
+ ### Added
105
+ - ci: GitHub Release workflow for version tags and chore(release): commits on main / master
106
+
107
+ ## [1.0.10] - 2026-03-26
108
+
109
+ ### Added
110
+ - deuk-agent-rule: changelog template headers without per-commit links
111
+
112
+ ## [1.0.9] - 2026-03-27
113
+
114
+ ### Added
115
+ - deuk-agent-rule: release changelog tooling; ticket directory gitignore; pre-work ticket scan; AGENTS inject newline fix
116
+
117
+ ### Changed
118
+ - agents: DeukAgentRules/ticket/LATEST.md ticket path for consumer repos
119
+
120
+ ## [1.0.8] - 2026-03-27
121
+
122
+ ### Added
123
+ - This changelog and npm files entry so releases are traceable.
124
+
125
+ ## [1.0.7] - 2026-03-27
126
+
127
+ ### Added
128
+ - init: create .deuk-agent-ticket/ and append .gitignore rules for local tickets.
129
+ - CLI: pre-work ticket scan; publish/AGENTS.md and multi-ai-workflow.mdc updates.
130
+
131
+ ### Fixed
132
+ - AGENTS tagged-region merge: trailing newline after injected blocks.
133
+
134
+ ## [1.0.5] - 2026-03-26
135
+
136
+ ### Changed
137
+ - README and package metadata (Deuk Family tagline, npm keywords, GitHub Topics note).
138
+
139
+ ## [1.0.4] - 2026-03-26
140
+
141
+ ### Changed
142
+ - Release packaging includes package-lock.json for reproducible installs.
143
+ - README: absolute links for the npm package page.
package/README.ko.md CHANGED
@@ -1,106 +1,125 @@
1
- # DeukAgentRules (득에이전트룰스)
2
-
3
- > **Deuk Family**의 핵심 모듈 가운데 하나입니다. 구조화된 규칙으로 AI 에이전트의 협업과 응답을 다듬습니다.
4
-
5
- **npm 패키지:** `deuk-agent-rule` · **CLI:** `deuk-agent-rule`
6
-
7
- **English:** [README.md](https://github.com/joygram/DeukAgentRules/blob/master/README.md)
8
-
9
- Cursor, GitHub Copilot, Gemini / Antigravity, Claude(Cursor·Claude Code), Windsurf, JetBrains AI Assistant 등 코딩 에이전트와 함께 쓸 `AGENTS.md`·`.cursor/rules` 버전 관리형 템플릿. 그 밖에도 프로젝트 규칙을 읽는 유사 도구에 그대로 활용할 수 있습니다. 핸드오프·간결 응답으로 비용·성능을 개선합니다.
10
-
11
- ## 워크스페이스 초기화
12
-
13
- ```bash
14
- npm install deuk-agent-rule
15
- npx deuk-agent-rule init
16
- ```
17
-
18
- 레포에 **처음** `init` 할 때만(`.deuk-agent-rule.config.json` 없음) **대화형** 질문이 나옵니다. **이후** `npx deuk-agent-rule init` 은 저장된 선택을 쓰고 템플릿만 갱신하므로, 매번 `--non-interactive` 할 필요 없습니다. **CI**에서만 `--non-interactive` 를 쓰면 됩니다. 선택을 바꾸려면 **`--interactive`** 이거나 설정 파일을 지우거나 수정하세요.
19
-
20
- 첫 `init` 예시:
21
-
22
- ```
23
- $ npx deuk-agent-rule init
24
-
25
- DeukAgentRules init — let's configure your workspace.
26
-
27
- ? What is your primary tech stack?
28
- 1) Unity / C#
29
- 2) Next.js + C#
30
- 3) Web (React / Vue / general)
31
- 4) Java / Spring Boot
32
- 5) Other / skip
33
- Choice [1-5]: 1
34
-
35
- ? Which agent tools do you use? (comma-separated numbers, or 'all')
36
- 1) Cursor
37
- 2) GitHub Copilot
38
- 3) Gemini / Antigravity
39
- 4) Claude (Cursor / Claude Code)
40
- 5) Windsurf
41
- 6) JetBrains AI Assistant
42
- 7) All of the above
43
- 8) Other / skip
44
- Choices: 1,2
45
-
46
- Stack : unity
47
- Tools : cursor, copilot
48
-
49
- AGENTS.md: injected (inject)
50
- rule copied: .cursor/rules/deuk-agent-rule-multi-ai-workflow.mdc
51
- rule copied: .cursor/rules/deuk-agent-rule-delivery-and-parallel-work.mdc
52
- rule copied: .cursor/rules/deuk-agent-rule-git-commit.mdc
53
- ```
54
-
55
- CI나 스크립트 환경에서 질문 없이 실행:
56
-
57
- ```bash
58
- npx deuk-agent-rule init --non-interactive
59
- ```
60
-
61
- 패키지 업데이트 후:
62
-
63
- ```bash
64
- npm update deuk-agent-rule
65
- npx deuk-agent-rule init
66
- ```
67
-
68
- **CI·헤드리스**에서만 `init --non-interactive` 쓰면 됩니다. 일반 업그레이드에 **`merge`를 따로 돌릴 필요는 없습니다.** 기본 **`init`** 이 번들 **`.cursor/rules`** 를 다시 맞춥니다. `--rules prefix`(기본)일 때 이미 있는 **`deuk-agent-rule-*.mdc`** 는 새 패키지 내용으로 **덮어씁니다.** 접두 없이 둔 로컬 전용 룰 파일은 건드리지 않습니다. `AGENTS.md`는 **마커 안**만 갱신되고 바깥 내용은 유지됩니다.
69
-
70
- ### 핸드오프 (멀티 세션·도구 넘김)
71
-
72
- `init` **`.deuk-agent-handoff/`** 만들고 기본으로 **`.gitignore`** 에 넣습니다. 채팅만이 아니라 **파일로 남겨야 할** 작업 명세는 여기(또는 `DeukAgentRules/handoff/LATEST.md` 관례)에 `AGENTS.md`의 **Handoff format** 절 구조(과제, 수정 파일, 결정, 제약)로 적어 두면, 다음 세션이나 다른 에이전트가 이어 받기 쉽습니다.
73
-
74
- **플랜 패널**을 쓰는 환경에서는 동일 본문을 **`.cursor/plans/deuk-handoff.plan.md`** 등으로 **선택적으로 복제**해 둘 수 있습니다. 정본과 내용이 어긋나지 않게 맞추고, 에이전트 동작은 번들된 **`multi-ai-workflow.mdc`** 를 참고하세요.
75
-
76
- ### 주요 옵션
77
-
78
- | 플래그 | 기본값 | 설명 |
79
- |--------|--------|------|
80
- | `--non-interactive` | | CI/스크립트: 질문 없음·저장 설정 미사용 |
81
- | `--interactive` | 끔 | `.deuk-agent-rule.config.json` 이 있어도 질문 다시 |
82
- | `--cwd <path>` | 현재 디렉터리 | 대상 레포 루트 |
83
- | `--dry-run` | 끔 | 쓰기 없이 동작만 출력 |
84
- | `--tag <id>` | `deuk-agent-rule` | 마커 id: `<!-- <id>:begin/end -->` |
85
- | `--agents <mode>` | `inject` | `inject` \| `skip` \| `overwrite` |
86
- | `--rules <mode>` | `prefix` | `prefix` \| `skip` \| `overwrite` |
87
- | `--backup` | | 덮어쓰기 `*.bak` 저장 |
88
-
89
- ### 번들 규칙
90
-
91
- - **`multi-ai-workflow.mdc`** — `alwaysApply: true`
92
- - **`delivery-and-parallel-work.mdc`** `alwaysApply: true` (세로 슬라이스·포트폴리오 우선·병렬 소유·리팩터 범위 축소)
93
- - **`git-commit.mdc`** — `alwaysApply: false`
94
-
95
- ### `merge` (엄격)
96
-
97
- 옵션 동일. 마커가 없으면 inject 실패(`--append-if-no-markers` 없을 때). 기본 `--rules skip`.
98
-
99
- ### 주의
100
-
101
- - `alwaysApply: true` 규칙이 겹치면 컨텍스트가 커질 수 있습니다.
102
- - `postinstall`에서 `init` 자동 실행은 권장하지 않습니다.
103
-
104
- ## 버전
105
-
106
- 배포 `package.json`의 `version` 상향.
1
+ <div align="center">
2
+ <br />
3
+ <h1>DeukAgentRules (득에이전트룰스)</h1>
4
+ <p>규칙 표준화 엔진</p>
5
+ <p><a href="https://deukpack.app">Deuk Family</a> 생태계의 핵심 에이전트 인프라</p>
6
+ </div>
7
+
8
+ <div align="center">
9
+ <a href="https://www.npmjs.com/package/deuk-agent-rule"><img src="https://img.shields.io/npm/v/deuk-agent-rule.svg?color=black&style=flat-square" alt="NPM Version" /></a>
10
+ <a href="https://www.npmjs.com/package/deuk-agent-rule"><img src="https://img.shields.io/npm/dm/deuk-agent-rule.svg?color=blue&style=flat-square" alt="NPM Downloads" /></a>
11
+ <a href="https://github.com/joygram/DeukAgentRules"><img src="https://img.shields.io/github/stars/joygram/DeukAgentRules.svg?style=flat-square&color=orange" alt="GitHub Stars" /></a>
12
+ <a href="https://github.com/joygram/DeukAgentRules/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/deuk-agent-rule.svg?style=flat-square" alt="License" /></a>
13
+ <br /><br />
14
+ <a href="https://github.com/joygram/DeukAgentRules/blob/master/README.md">English</a>
15
+ </div>
16
+
17
+ ***
18
+
19
+ ## Abstract
20
+
21
+ DeukAgentRules는 AI 엔지니어링 에이전트(Cursor, GitHub Copilot, Gemini/Antigravity, Claude, Windsurf, JetBrains AI 등)를 위한 프로젝트 불가지론적(Agnostic) 규칙 아키텍처를 정의합니다. 지속적인 워크플로 메모리를 세션 컨텍스트와 분리하여, 세션당 반복되는 프롬프트 부하를 감소시킵니다.
22
+
23
+ > DeukAgentRules인가?
24
+ > 티켓 기반 워크플로(Ticket-First)는 반복되는 컨텍스트 부하를 세션당 단일 토픽 파일 하나로 축소하고, 저장소를 재설명하지 않고도 도구 간 핸드오버를 가능하게 합니다.
25
+
26
+ ---
27
+
28
+ ## 빠른 시작
29
+
30
+ 명령어 줄로 규칙 시스템을 초기화하고 로컬 워크스페이스를 구성하세요:
31
+
32
+ ```bash
33
+ npx deuk-agent-rule init
34
+ ```
35
+
36
+ - 대화형 설정: 최초 실행 시 CLI가 주요 기술 스택과 사용하는 AI 에이전트를 선택하도록 안내합니다. (각 스택별 세부 지원 항목은 시스템 및 스택 선택 가이드를 참조하세요).
37
+ - 안전한 업데이트: 이후 실행 시 기존 커스텀 설정을 건드리지 않고 필요한 템플릿만 안전하게 주입(Append)합니다. 설정을 변경하려면 --interactive 옵션을 사용하세요.
38
+
39
+ ---
40
+
41
+ ## 티켓 기반 워크플로 (Ticket-First Workflow)
42
+
43
+ 다수의 AI 에이전트가 단일 마크다운 티켓을 통해 컨텍스트를 공유하는 구조입니다.
44
+
45
+ ### 6단계 워크플로
46
+
47
+ | 단계 | 담당 | 역할 |
48
+ |---|---|---|
49
+ | 1. 탐색 & 계획 | 추론 AI | 코드베이스 분석, 구현 계획 수립 |
50
+ | 2. 결정 | 사용자 | 계획 검토 및 승인 |
51
+ | 3. 티켓 발행 (등록) | 추론 AI | 승인된 계획을 .deuk-agent-ticket/ 에 저장 |
52
+ | 4. 실행 | IDE 에이전트 | 티켓만 읽고 범위 내에서 코딩 |
53
+ | 5. 리스크 분석 (자체검증) | IDE 에이전트 | 테스트 완료 후 빌드 산출물 자체의 결함 및 잠재 리스크 필수 분석 |
54
+ | 6. 보고 & 종결 | 사용자+에이전트 | 리포트 검토 후 npx deuk-agent-rule ticket close --latest |
55
+
56
+ ---
57
+
58
+ ### 상세 워크플로 가이드
59
+
60
+ 1단계: 탐색 및 계획 수립
61
+ ```
62
+ [User] "분석 저장소모듈"
63
+ [Agent] (코드베이스 분석 후 방향 제안)
64
+ [User] "계획 해당 분석내용을 진행할 계획 및 설계"
65
+ [Agent] (.deuk-agent-ticket/main/storage-20260406.md 에 티켓 저장)
66
+ ```
67
+
68
+ 2단계: 실행 자체 검증
69
+ ```
70
+ [User] "진행 (생략 최신 분석 내용 진행)"
71
+ [Agent] (티켓을 읽고 코드 변경 후 자체 검토 보고)
72
+ [User] "검증 이슈 결함, 잠재오류"
73
+ [Agent] (티켓 제약 사항 준수 검토 및 결함 탐색 완료)
74
+ ```
75
+
76
+ ---
77
+
78
+ ### 키워드 프롬프트 예시 (채팅창 입력)
79
+
80
+ 반복되는 타이핑과 검색 피로도를 줄이기 위해 아래와 같은 키워드 기반의 단문을 권장해요.
81
+
82
+ | 상황 | 입력 프롬프트 |
83
+ |---|---|
84
+ | 분석 | 분석 [주제/모듈] |
85
+ | 계획 | 계획 해당 분석내용을 진행할 계획 설계 |
86
+ | 진행 | 진행 [티켓번호] (생략 최신 진행) |
87
+ | 검증 | 검증 이슈 결함, 잠재오류 |
88
+ | 조회 | /티켓 |
89
+
90
+ ---
91
+
92
+ ### CLI 레퍼런스 (선택 사항)
93
+
94
+ ```bash
95
+ npx deuk-agent-rule ticket create --topic login-api --project MyProject --content "## Task: ..."
96
+ npx deuk-agent-rule ticket list
97
+ npx deuk-agent-rule ticket close --latest
98
+ ```
99
+
100
+ (티켓 튜토리얼: docs/ticket-tutorial.ko.md 참조)
101
+
102
+
103
+
104
+ ---
105
+
106
+ ## 아키텍처 설정 (How It Works)
107
+
108
+ CLI는 CI 환경과 명시적 제어를 위한 매개변수를 지원하며, 기존 로컬 설정과 충돌하지 않는 주입(Injection) 방식을 사용합니다.
109
+ 자세한 기술 구현 아키텍처와 덮어쓰기 방어 로직은 동작 원리 가이드를 참조하세요.
110
+
111
+ ### 핵심 매개변수 (Core Configuration)
112
+
113
+ | 옵션 | 용도 |
114
+ |------|---------|
115
+ | --non-interactive | CI/Headless 모드 (질의응답 없이 기본값/저장된 설정 즉시 적용) |
116
+ | --tag <id> | 기본 마커 영역(<!-- <id>:begin/end -->)을 사용자 정의 ID로 오버라이드 |
117
+ | --agents inject | 기존 AGENTS.md에 지능형 마커 주입 (또는 skip, overwrite) |
118
+ | --rules prefix | 지능형 파일 접두사를 활용하여 .cursor/rules 모듈 업데이트 |
119
+
120
+ ---
121
+
122
+ ## 라이선스 & 생태계
123
+
124
+ 이 패키지는 DeukPack Ecosystem의 일부로 구동되며, Apache-2.0 라이선스 하에 배포됩니다.
125
+ 이슈 제보, 컨트리뷰션 및 커뮤니티 논의는 GitHub Repository (https://github.com/joygram/DeukAgentRules)를 방문해 주세요.
package/README.ko.pdf ADDED
Binary file