-
Notifications
You must be signed in to change notification settings - Fork 10.8k
feat: Add Alquimia AI integration #2734
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
exengstfeld
wants to merge
21
commits into
github:main
Choose a base branch
from
Alquimia-ai:alquimia-integration-merge-conflicts-resolution
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
76370ff
Add alquimia-ai as new integration: https://alquimia.ai
d434263
Fix test cases for alquimia-ai integration. Add alquimia-ai to workfl…
7fc52fb
Add install url to alquimia-ai integration
d8381fa
Renamed alquimia-ai to alquimia (cli native denomination)
8fe1e55
Fix unit tests for alquimia integration
bad5412
Minor fix in alquimia integration
631c0fc
Fix typos and copilot findings
b3cd29f
Potential fix for pull request finding
exengstfeld 62aaebe
Potential fix for pull request finding
exengstfeld 4f0029b
Update tests cases and lint formatting
e1e8cfa
Final fixes
ff376b6
Rename alquimia_ai to alquimia module integration
1e37cb9
Make cli optional for alquimiia integration
9e315c2
resolve review comments
d0a7021
Fix copilot review
77cf7b2
Minor fixes: naming, remove unused code
29a08a1
Update tests cases. Fix issues
c605a67
Fix unit tests
74a6b26
Add alquimia context to default agent-context extension. Update cli r…
65d0db0
Fix hints (suggestion)
4565563
Add Alquimia AI as agent in github issue template. Fix unit tests
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| """Alquimia AI integration.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from pathlib import Path | ||
| from typing import Any | ||
|
|
||
| from ..._utils import dump_frontmatter | ||
| from ..base import SkillsIntegration | ||
| from ..manifest import IntegrationManifest | ||
|
|
||
| # Mapping of command template stem → argument-hint text shown inline | ||
| # when a user invokes the slash command in Alquimia AI. | ||
| ARGUMENT_HINTS: dict[str, str] = { | ||
| "specify": "Describe the feature you want to specify", | ||
| "plan": "Optional guidance for the planning phase", | ||
| "tasks": "Optional task generation constraints", | ||
| "implement": "Optional implementation guidance or task filter", | ||
| "analyze": "Optional focus areas for analysis", | ||
| "clarify": "Optional areas to clarify in the spec", | ||
| "constitution": "Principles or values for the project constitution", | ||
| "checklist": "Domain or focus area for the checklist", | ||
| "taskstoissues": "Optional filter or label for GitHub issues", | ||
|
exengstfeld marked this conversation as resolved.
|
||
| } | ||
|
|
||
|
|
||
| class AlquimiaAIIntegration(SkillsIntegration): | ||
| """Integration for Alquimia AI skills.""" | ||
|
|
||
| key = "alquimia" | ||
| config = { | ||
| "name": "Alquimia AI", | ||
| "folder": ".alquimia/", | ||
| "commands_subdir": "skills", | ||
| "install_url": "https://docs.alquimia.ai", | ||
| "requires_cli": True, | ||
|
exengstfeld marked this conversation as resolved.
|
||
| } | ||
| registrar_config = { | ||
| "dir": ".alquimia/skills", | ||
| "format": "markdown", | ||
| "args": "$ARGUMENTS", | ||
| "extension": "/SKILL.md", | ||
| } | ||
| multi_install_safe = True | ||
|
|
||
| def _render_skill( | ||
| self, template_name: str, frontmatter: dict[str, Any], body: str | ||
| ) -> str: | ||
| """Render a processed command template as an Alquimia skill.""" | ||
| skill_name = f"speckit-{template_name.replace('.', '-')}" | ||
| description = frontmatter.get( | ||
| "description", | ||
| f"Spec-kit workflow command: {template_name}", | ||
| ) | ||
| skill_frontmatter = self._build_skill_fm( | ||
| skill_name, description, f"templates/commands/{template_name}.md" | ||
| ) | ||
| frontmatter_text = dump_frontmatter(skill_frontmatter) | ||
| return f"---\n{frontmatter_text}\n---\n\n{body.strip()}\n" | ||
|
|
||
| def _build_skill_fm(self, name: str, description: str, source: str) -> dict: | ||
| from specify_cli.agents import CommandRegistrar | ||
|
|
||
| return CommandRegistrar.build_skill_frontmatter( | ||
| self.key, name, description, source | ||
| ) | ||
|
|
||
| @staticmethod | ||
| def inject_argument_hint(content: str, hint: str) -> str: | ||
| """Insert ``argument-hint`` after the first ``description:`` in YAML frontmatter. | ||
|
|
||
| Skips injection if ``argument-hint:`` already exists in the | ||
| frontmatter to avoid duplicate keys. | ||
| """ | ||
| lines = content.splitlines(keepends=True) | ||
|
|
||
| # Pre-scan: bail out if argument-hint already present in frontmatter | ||
| dash_count = 0 | ||
| for line in lines: | ||
| stripped = line.rstrip("\n\r") | ||
| if stripped == "---": | ||
| dash_count += 1 | ||
| if dash_count == 2: | ||
| break | ||
| continue | ||
| if dash_count == 1 and stripped.startswith("argument-hint:"): | ||
| return content # already present | ||
|
|
||
| out: list[str] = [] | ||
| in_fm = False | ||
| dash_count = 0 | ||
| injected = False | ||
| for line in lines: | ||
| stripped = line.rstrip("\n\r") | ||
| if stripped == "---": | ||
| dash_count += 1 | ||
| in_fm = dash_count == 1 | ||
| out.append(line) | ||
| continue | ||
| if in_fm and not injected and stripped.startswith("description:"): | ||
| out.append(line) | ||
| # Preserve the exact line-ending style (\r\n vs \n) | ||
| if line.endswith("\r\n"): | ||
| eol = "\r\n" | ||
| elif line.endswith("\n"): | ||
| eol = "\n" | ||
| else: | ||
| eol = "" | ||
| escaped = hint.replace("\\", "\\\\").replace('"', '\\"') | ||
| out.append(f'argument-hint: "{escaped}"{eol}') | ||
| injected = True | ||
| continue | ||
| out.append(line) | ||
| return "".join(out) | ||
|
|
||
| @staticmethod | ||
| def _inject_frontmatter_flag(content: str, key: str, value: str = "true") -> str: | ||
| """Insert ``key: value`` before the closing ``---`` if not already present.""" | ||
| lines = content.splitlines(keepends=True) | ||
|
|
||
| # Pre-scan: bail out if already present in frontmatter | ||
| dash_count = 0 | ||
| for line in lines: | ||
| stripped = line.rstrip("\n\r") | ||
| if stripped == "---": | ||
| dash_count += 1 | ||
| if dash_count == 2: | ||
| break | ||
| continue | ||
| if dash_count == 1 and stripped.startswith(f"{key}:"): | ||
| return content | ||
|
|
||
| # Inject before the closing --- of frontmatter | ||
| out: list[str] = [] | ||
| dash_count = 0 | ||
| injected = False | ||
| for line in lines: | ||
| stripped = line.rstrip("\n\r") | ||
| if stripped == "---": | ||
| dash_count += 1 | ||
| if dash_count == 2 and not injected: | ||
| if line.endswith("\r\n"): | ||
| eol = "\r\n" | ||
| elif line.endswith("\n"): | ||
| eol = "\n" | ||
| else: | ||
| eol = "" | ||
| out.append(f"{key}: {value}{eol}") | ||
| injected = True | ||
| out.append(line) | ||
| return "".join(out) | ||
|
|
||
| def post_process_skill_content(self, content: str) -> str: | ||
| """Inject Alquimia-specific frontmatter flags, hints and hook notes.""" | ||
| updated = super().post_process_skill_content(content) | ||
| updated = self._inject_frontmatter_flag(updated, "user-invocable") | ||
| updated = self._inject_frontmatter_flag( | ||
| updated, "disable-model-invocation", "false" | ||
| ) | ||
| for line in updated.splitlines(): | ||
| if line.startswith("name:"): | ||
| name = line.removeprefix("name:").strip().strip("\"'") | ||
| hint = ARGUMENT_HINTS.get(name.removeprefix("speckit-")) | ||
| if hint: | ||
| updated = self.inject_argument_hint(updated, hint) | ||
| break | ||
| return updated | ||
|
|
||
| def setup( | ||
| self, | ||
| project_root: Path, | ||
| manifest: IntegrationManifest, | ||
| parsed_options: dict[str, Any] | None = None, | ||
| **opts: Any, | ||
| ) -> list[Path]: | ||
| """Install Alquimia skills, then inject Alquimia-specific flags and argument-hints.""" | ||
| created = super().setup(project_root, manifest, parsed_options, **opts) | ||
|
|
||
| # Post-process generated skill files | ||
| skills_dir = self.skills_dest(project_root).resolve() | ||
|
|
||
| for path in created: | ||
| # Only touch SKILL.md files under the skills directory | ||
| try: | ||
| path.resolve().relative_to(skills_dir) | ||
| except ValueError: | ||
| continue | ||
| if path.name != "SKILL.md": | ||
| continue | ||
|
|
||
| content_bytes = path.read_bytes() | ||
| content = content_bytes.decode("utf-8") | ||
|
|
||
| updated = content | ||
|
|
||
| # Inject argument-hint if available for this skill | ||
| skill_dir_name = path.parent.name # e.g. "speckit-plan" | ||
| stem = skill_dir_name | ||
| if stem.startswith("speckit-"): | ||
| stem = stem[len("speckit-") :] | ||
| hint = ARGUMENT_HINTS.get(stem, "") | ||
| if hint: | ||
| updated = self.inject_argument_hint(updated, hint) | ||
|
exengstfeld marked this conversation as resolved.
|
||
|
|
||
| if updated != content: | ||
| path.write_bytes(updated.encode("utf-8")) | ||
| self.record_file_in_manifest(path, project_root, manifest) | ||
|
|
||
| return created | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.