-
Notifications
You must be signed in to change notification settings - Fork 9.5k
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
8
commits into
github:main
Choose a base branch
from
Alquimia-ai:main
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 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
767b301
Add alquimia-ai as new integration: https://alquimia.ai
ebaf5c7
Fix test cases for alquimia-ai integration. Add alquimia-ai to workfl…
49c4a88
Add install url to alquimia-ai integration
f3d60f0
Renamed alquimia-ai to alquimia (cli native denomination)
f670ec2
Fix alquimia integration catalog updated_at date
exengstfeld a9ba17b
Fix alquima ai registration order
f9f2c80
Fix unit tests for alquimia integration
6a62fe1
Minor fix in alquimia integration
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| """Alquimia AI integration.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import re | ||
| from pathlib import Path | ||
| from typing import Any | ||
|
|
||
| import yaml | ||
|
|
||
| from ..base import SkillsIntegration | ||
| from ..manifest import IntegrationManifest | ||
|
|
||
| # Note injected into hook sections so Alquimia maps dot-notation command | ||
| # names (from extensions.yml) to the hyphenated skill names it uses. | ||
| _HOOK_COMMAND_NOTE = ( | ||
| "- When constructing slash commands from hook command names, " | ||
| "replace dots (`.`) with hyphens (`-`). " | ||
| "For example, `speckit.git.commit` → `/speckit-git-commit`.\n" | ||
| ) | ||
|
|
||
| # 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", | ||
| } | ||
|
|
||
|
|
||
| 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, | ||
| } | ||
| registrar_config = { | ||
| "dir": ".alquimia/skills", | ||
| "format": "markdown", | ||
| "args": "{{query}}", | ||
| "extension": "/SKILL.md", | ||
| } | ||
| context_file = "ALQUIMIA.md" | ||
| multi_install_safe = True | ||
|
|
||
| @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) | ||
|
|
||
| def _render_skill(self, template_name: str, frontmatter: dict[str, Any], body: str) -> str: | ||
| """Render a processed command template as a Alquimia skill.""" | ||
|
Comment on lines
+105
to
+106
|
||
| 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 = yaml.safe_dump(skill_frontmatter, sort_keys=False).strip() | ||
| 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_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) | ||
|
|
||
| @staticmethod | ||
| def _inject_hook_command_note(content: str) -> str: | ||
| """Insert a dot-to-hyphen note before each hook output instruction. | ||
|
|
||
| Targets the line ``- For each executable hook, output the following`` | ||
| and inserts the note on the line before it, matching its indentation. | ||
| Skips if the note is already present. | ||
| """ | ||
| if "replace dots" in content: | ||
| return content | ||
|
|
||
| def repl(m: re.Match[str]) -> str: | ||
| indent = m.group(1) | ||
| instruction = m.group(2) | ||
| eol = m.group(3) | ||
| return ( | ||
| indent | ||
| + _HOOK_COMMAND_NOTE.rstrip("\n") | ||
| + eol | ||
| + indent | ||
| + instruction | ||
| + eol | ||
| ) | ||
|
exengstfeld marked this conversation as resolved.
|
||
|
|
||
| return re.sub( | ||
| r"(?m)^(\s*)(- For each executable hook, output the following[^\r\n]*)(\r\n|\n|$)", | ||
| repl, | ||
| content, | ||
| ) | ||
|
|
||
| def post_process_skill_content(self, content: str) -> str: | ||
| """Inject Alquimia-specific frontmatter flags and hook notes.""" | ||
| updated = self._inject_frontmatter_flag(content, "user-invocable") | ||
| updated = self._inject_frontmatter_flag(updated, "disable-model-invocation", "false") | ||
| updated = self._inject_hook_command_note(updated) | ||
| 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 = self.post_process_skill_content(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) | ||
|
|
||
| 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.