Compare commits
No commits in common. "eee848c6a46ce07c19f5d29dccbe130dd9e4af19" and "2a9698a64e0a0ae830cf5fda1ec292e53bec89e8" have entirely different histories.
eee848c6a4
...
2a9698a64e
|
|
@ -1,78 +0,0 @@
|
|||
{
|
||||
"name": "bmad-method",
|
||||
"owner": {
|
||||
"name": "Brian (BMad) Madison"
|
||||
},
|
||||
"description": "Breakthrough Method of Agile AI-driven Development — a full-lifecycle framework with agents and workflows for analysis, planning, architecture, and implementation.",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/bmad-code-org/BMAD-METHOD",
|
||||
"repository": "https://github.com/bmad-code-org/BMAD-METHOD",
|
||||
"keywords": ["bmad", "agile", "ai", "orchestrator", "development", "methodology", "agents"],
|
||||
"plugins": [
|
||||
{
|
||||
"name": "bmad-pro-skills",
|
||||
"source": "./",
|
||||
"description": "Next level skills for power users — advanced prompting techniques, agent management, and more.",
|
||||
"version": "6.3.0",
|
||||
"author": {
|
||||
"name": "Brian (BMad) Madison"
|
||||
},
|
||||
"skills": [
|
||||
"./src/core-skills/bmad-help",
|
||||
"./src/core-skills/bmad-init",
|
||||
"./src/core-skills/bmad-brainstorming",
|
||||
"./src/core-skills/bmad-distillator",
|
||||
"./src/core-skills/bmad-party-mode",
|
||||
"./src/core-skills/bmad-shard-doc",
|
||||
"./src/core-skills/bmad-advanced-elicitation",
|
||||
"./src/core-skills/bmad-editorial-review-prose",
|
||||
"./src/core-skills/bmad-editorial-review-structure",
|
||||
"./src/core-skills/bmad-index-docs",
|
||||
"./src/core-skills/bmad-review-adversarial-general",
|
||||
"./src/core-skills/bmad-review-edge-case-hunter"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "bmad-method-lifecycle",
|
||||
"source": "./",
|
||||
"description": "Full-lifecycle AI development framework — agents and workflows for product analysis, planning, architecture, and implementation.",
|
||||
"version": "6.3.0",
|
||||
"author": {
|
||||
"name": "Brian (BMad) Madison"
|
||||
},
|
||||
"skills": [
|
||||
"./src/bmm-skills/1-analysis/bmad-product-brief",
|
||||
"./src/bmm-skills/1-analysis/bmad-agent-analyst",
|
||||
"./src/bmm-skills/1-analysis/bmad-agent-tech-writer",
|
||||
"./src/bmm-skills/1-analysis/bmad-document-project",
|
||||
"./src/bmm-skills/1-analysis/research/bmad-domain-research",
|
||||
"./src/bmm-skills/1-analysis/research/bmad-market-research",
|
||||
"./src/bmm-skills/1-analysis/research/bmad-technical-research",
|
||||
"./src/bmm-skills/2-plan-workflows/bmad-agent-pm",
|
||||
"./src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer",
|
||||
"./src/bmm-skills/2-plan-workflows/bmad-create-prd",
|
||||
"./src/bmm-skills/2-plan-workflows/bmad-edit-prd",
|
||||
"./src/bmm-skills/2-plan-workflows/bmad-validate-prd",
|
||||
"./src/bmm-skills/2-plan-workflows/bmad-create-ux-design",
|
||||
"./src/bmm-skills/3-solutioning/bmad-agent-architect",
|
||||
"./src/bmm-skills/3-solutioning/bmad-create-architecture",
|
||||
"./src/bmm-skills/3-solutioning/bmad-check-implementation-readiness",
|
||||
"./src/bmm-skills/3-solutioning/bmad-create-epics-and-stories",
|
||||
"./src/bmm-skills/3-solutioning/bmad-generate-project-context",
|
||||
"./src/bmm-skills/4-implementation/bmad-agent-dev",
|
||||
"./src/bmm-skills/4-implementation/bmad-agent-sm",
|
||||
"./src/bmm-skills/4-implementation/bmad-agent-qa",
|
||||
"./src/bmm-skills/4-implementation/bmad-agent-quick-flow-solo-dev",
|
||||
"./src/bmm-skills/4-implementation/bmad-dev-story",
|
||||
"./src/bmm-skills/4-implementation/bmad-quick-dev",
|
||||
"./src/bmm-skills/4-implementation/bmad-sprint-planning",
|
||||
"./src/bmm-skills/4-implementation/bmad-sprint-status",
|
||||
"./src/bmm-skills/4-implementation/bmad-code-review",
|
||||
"./src/bmm-skills/4-implementation/bmad-create-story",
|
||||
"./src/bmm-skills/4-implementation/bmad-correct-course",
|
||||
"./src/bmm-skills/4-implementation/bmad-retrospective",
|
||||
"./src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -37,19 +37,7 @@ Requires [Node.js](https://nodejs.org) v20+ and `npx` (included with npm).
|
|||
| `--user-name <name>` | Name for agents to use | System username |
|
||||
| `--communication-language <lang>` | Agent communication language | English |
|
||||
| `--document-output-language <lang>` | Document output language | English |
|
||||
| `--output-folder <path>` | Output folder path (see resolution rules below) | `_bmad-output` |
|
||||
|
||||
#### Output Folder Path Resolution
|
||||
|
||||
The value passed to `--output-folder` (or entered interactively) is resolved according to these rules:
|
||||
|
||||
| Input type | Example | Resolved as |
|
||||
|------------|---------|-------------|
|
||||
| Relative path (default) | `_bmad-output` | `<project-root>/_bmad-output` |
|
||||
| Relative path with traversal | `../../shared-outputs` | Normalized absolute path — e.g. `/Users/me/shared-outputs` |
|
||||
| Absolute path | `/Users/me/shared-outputs` | Used as-is — project root is **not** prepended |
|
||||
|
||||
The resolved path is what agents and workflows use at runtime when writing output files. Using an absolute path or a traversal-based relative path lets you direct all generated artifacts to a directory outside your project tree — useful for shared or monorepo setups.
|
||||
| `--output-folder <path>` | Output folder path | _bmad-output |
|
||||
|
||||
### Other Options
|
||||
|
||||
|
|
@ -153,7 +141,6 @@ Invalid values will either:
|
|||
|
||||
:::tip[Best Practices]
|
||||
- Use absolute paths for `--directory` to avoid ambiguity
|
||||
- Use an absolute path for `--output-folder` when you want artifacts written outside the project tree (e.g. a shared monorepo outputs directory)
|
||||
- Test flags locally before using in CI/CD pipelines
|
||||
- Combine with `-y` for truly unattended installations
|
||||
- Use `--debug` if you encounter issues during installation
|
||||
|
|
|
|||
|
|
@ -37,19 +37,7 @@ Yêu cầu [Node.js](https://nodejs.org) v20+ và `npx` (đi kèm với npm).
|
|||
| `--user-name <name>` | Tên để agent sử dụng | Tên người dùng hệ thống |
|
||||
| `--communication-language <lang>` | Ngôn ngữ giao tiếp của agent | Tiếng Anh |
|
||||
| `--document-output-language <lang>` | Ngôn ngữ đầu ra tài liệu | Tiếng Anh |
|
||||
| `--output-folder <path>` | Đường dẫn thư mục output (xem quy tắc resolve bên dưới) | `_bmad-output` |
|
||||
|
||||
#### Quy tắc resolve đường dẫn output folder
|
||||
|
||||
Giá trị truyền vào `--output-folder` (hoặc nhập ở chế độ tương tác) sẽ được resolve theo các quy tắc sau:
|
||||
|
||||
| Loại đầu vào | Ví dụ | Được resolve thành |
|
||||
|------|-------------|---------|
|
||||
| Đường dẫn tương đối (mặc định) | `_bmad-output` | `<project-root>/_bmad-output` |
|
||||
| Đường dẫn tương đối có traversal | `../../shared-outputs` | Đường dẫn tuyệt đối đã được chuẩn hóa, ví dụ `/Users/me/shared-outputs` |
|
||||
| Đường dẫn tuyệt đối | `/Users/me/shared-outputs` | Giữ nguyên như đã nhập, **không** thêm project root vào trước |
|
||||
|
||||
Đường dẫn sau khi resolve là đường dẫn mà agent và workflow sẽ dùng lúc runtime để ghi file đầu ra. Việc dùng đường dẫn tuyệt đối hoặc đường dẫn tương đối có traversal cho phép bạn chuyển toàn bộ artifact sinh ra sang một thư mục nằm ngoài cây dự án, hữu ích với thư mục dùng chung hoặc cấu trúc monorepo.
|
||||
| `--output-folder <path>` | Đường dẫn thư mục output | _bmad-output |
|
||||
|
||||
### Tùy chọn khác
|
||||
|
||||
|
|
@ -153,7 +141,6 @@ Giá trị không hợp lệ sẽ dẫn đến một trong các trường hợp
|
|||
|
||||
:::tip[Thực hành tốt]
|
||||
- Dùng đường dẫn tuyệt đối cho `--directory` để tránh nhầm lẫn
|
||||
- Dùng đường dẫn tuyệt đối cho `--output-folder` khi bạn muốn ghi artifact ra ngoài cây dự án, ví dụ vào một thư mục output dùng chung trong monorepo
|
||||
- Thử nghiệm cờ ở máy local trước khi đưa vào pipeline CI/CD
|
||||
- Kết hợp với `-y` nếu bạn muốn cài đặt hoàn toàn không cần can thiệp
|
||||
- Dùng `--debug` nếu gặp vấn đề trong quá trình cài đặt
|
||||
|
|
|
|||
|
|
@ -166,27 +166,9 @@ def resolve_project_root_placeholder(value, project_root):
|
|||
"""Replace {project-root} placeholder with actual path."""
|
||||
if not value or not isinstance(value, str):
|
||||
return value
|
||||
if '{project-root}' not in value:
|
||||
return value
|
||||
|
||||
# Strip the {project-root} token to inspect what remains, so we can
|
||||
# correctly handle absolute paths stored as "{project-root}//absolute/path"
|
||||
# (produced by the "{project-root}/{value}" template applied to an absolute value).
|
||||
suffix = value.replace('{project-root}', '', 1)
|
||||
|
||||
# Strip the one path separator that follows the token (if any)
|
||||
if suffix.startswith('/') or suffix.startswith('\\'):
|
||||
remainder = suffix[1:]
|
||||
else:
|
||||
remainder = suffix
|
||||
|
||||
if os.path.isabs(remainder):
|
||||
# The original value was an absolute path stored with a {project-root}/ prefix.
|
||||
# Return the absolute path directly — no joining needed.
|
||||
return remainder
|
||||
|
||||
# Relative path: join with project root and normalize to resolve any .. segments.
|
||||
return os.path.normpath(os.path.join(str(project_root), remainder))
|
||||
if '{project-root}' in value:
|
||||
return value.replace('{project-root}', str(project_root))
|
||||
return value
|
||||
|
||||
|
||||
def parse_var_specs(vars_string):
|
||||
|
|
@ -240,22 +222,9 @@ def apply_result_template(var_def, raw_value, context):
|
|||
if not result_template:
|
||||
return raw_value
|
||||
|
||||
# If the user supplied an absolute path and the template would prefix it with
|
||||
# "{project-root}/", skip the template entirely to avoid producing a broken path
|
||||
# like "/my/project//absolute/path".
|
||||
if isinstance(raw_value, str) and os.path.isabs(raw_value):
|
||||
return raw_value
|
||||
|
||||
ctx = dict(context)
|
||||
ctx['value'] = raw_value
|
||||
result = expand_template(result_template, ctx)
|
||||
|
||||
# Normalize the resulting path to resolve any ".." segments (e.g. when the user
|
||||
# entered a relative path such as "../../outside-dir").
|
||||
if isinstance(result, str) and '{' not in result and os.path.isabs(result):
|
||||
result = os.path.normpath(result)
|
||||
|
||||
return result
|
||||
return expand_template(result_template, ctx)
|
||||
|
||||
|
||||
# =============================================================================
|
||||
|
|
|
|||
|
|
@ -110,37 +110,6 @@ class TestResolveProjectRootPlaceholder(unittest.TestCase):
|
|||
def test_non_string(self):
|
||||
self.assertEqual(resolve_project_root_placeholder(42, Path('/test')), 42)
|
||||
|
||||
def test_absolute_path_stored_with_prefix(self):
|
||||
"""Absolute output_folder entered by user is stored as '{project-root}//abs/path'
|
||||
by the '{project-root}/{value}' template. It must resolve to '/abs/path', not
|
||||
'/project//abs/path'."""
|
||||
result = resolve_project_root_placeholder(
|
||||
'{project-root}//Users/me/outside', Path('/Users/me/myproject')
|
||||
)
|
||||
self.assertEqual(result, '/Users/me/outside')
|
||||
|
||||
def test_relative_path_with_traversal_is_normalized(self):
|
||||
"""A relative path like '../../sibling' produces '{project-root}/../../sibling'
|
||||
after the template. It must resolve to the normalized absolute path, not the
|
||||
un-normalized string '/project/../../sibling'."""
|
||||
result = resolve_project_root_placeholder(
|
||||
'{project-root}/../../sibling', Path('/Users/me/myproject')
|
||||
)
|
||||
self.assertEqual(result, '/Users/sibling')
|
||||
|
||||
def test_relative_path_one_level_up(self):
|
||||
result = resolve_project_root_placeholder(
|
||||
'{project-root}/../outside-outputs', Path('/project/root')
|
||||
)
|
||||
self.assertEqual(result, '/project/outside-outputs')
|
||||
|
||||
def test_standard_relative_path_unchanged(self):
|
||||
"""Normal in-project relative paths continue to work correctly."""
|
||||
result = resolve_project_root_placeholder(
|
||||
'{project-root}/_bmad-output', Path('/project/root')
|
||||
)
|
||||
self.assertEqual(result, '/project/root/_bmad-output')
|
||||
|
||||
|
||||
class TestExpandTemplate(unittest.TestCase):
|
||||
|
||||
|
|
@ -178,39 +147,6 @@ class TestApplyResultTemplate(unittest.TestCase):
|
|||
result = apply_result_template(var_def, 'English', {})
|
||||
self.assertEqual(result, 'English')
|
||||
|
||||
def test_absolute_value_skips_project_root_template(self):
|
||||
"""When the user enters an absolute path, the '{project-root}/{value}' template
|
||||
must not be applied — doing so would produce '/project//absolute/path'."""
|
||||
var_def = {'result': '{project-root}/{value}'}
|
||||
result = apply_result_template(
|
||||
var_def, '/Users/me/shared-outputs', {'project-root': '/Users/me/myproject'}
|
||||
)
|
||||
self.assertEqual(result, '/Users/me/shared-outputs')
|
||||
|
||||
def test_relative_traversal_value_is_normalized(self):
|
||||
"""A relative path like '../../outside' combined with the project-root template
|
||||
must produce a clean normalized absolute path, not '/project/../../outside'."""
|
||||
var_def = {'result': '{project-root}/{value}'}
|
||||
result = apply_result_template(
|
||||
var_def, '../../outside-dir', {'project-root': '/Users/me/myproject'}
|
||||
)
|
||||
self.assertEqual(result, '/Users/outside-dir')
|
||||
|
||||
def test_relative_one_level_up_is_normalized(self):
|
||||
var_def = {'result': '{project-root}/{value}'}
|
||||
result = apply_result_template(
|
||||
var_def, '../sibling-outputs', {'project-root': '/project/root'}
|
||||
)
|
||||
self.assertEqual(result, '/project/sibling-outputs')
|
||||
|
||||
def test_normal_relative_value_unchanged(self):
|
||||
"""Standard in-project relative paths still produce the expected joined path."""
|
||||
var_def = {'result': '{project-root}/{value}'}
|
||||
result = apply_result_template(
|
||||
var_def, '_bmad-output', {'project-root': '/project/root'}
|
||||
)
|
||||
self.assertEqual(result, '/project/root/_bmad-output')
|
||||
|
||||
|
||||
class TestLoadModuleYaml(unittest.TestCase):
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue