avrae-ls 0.5.1__tar.gz → 0.6.1__tar.gz

{avrae_ls-0.5.1 → avrae_ls-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: avrae-ls
-Version: 0.5.1
+Version: 0.6.1
 Summary: Language server for Avrae draconic aliases
 Author: 1drturtle
 License: MIT License
@@ -30,6 +30,7 @@ Requires-Dist: d20>=1.1.2
 Requires-Dist: httpx>=0.27
 Requires-Dist: lsprotocol>=2023.0.1
 Requires-Dist: pygls>=1.3.1
+Requires-Dist: pyyaml>=6.0
 Provides-Extra: dev
 Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
 Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
@@ -66,18 +67,47 @@ Language Server Protocol (LSP) implementation targeting Avrae-style draconic ali
 - Tests only (with coverage): `make test` or `uv run pytest tests --cov=src`.
 - CLI smoke test without installing: `uv run python -m avrae_ls --analyze path/to/alias.txt`.
 
+## Alias tests
+
+- Create files ending with `.alias-test` (or `.aliastest`) next to your alias file. Each test starts with an invocation, followed by `---` and the expected result; you can stack multiple tests in one file by repeating this pattern (optional metadata after a second `---` per test).
+  ```
+  !my-alias -b example args
+  ---
+  expected text or number
+  ```
+- For embed aliases, put a YAML/JSON dictionary after the separator to compare against the embed preview (partial dictionaries are allowed).
+  ```
+  !embedtest
+  ---
+  title: Hello
+  description: World
+  ```
+- Embed fields lists can be partial: only the listed fields (in order) are matched; extra fields in the alias do not fail the test.
+- Use regex expectations by wrapping strings in `/.../` (or `re:...`). You can also mix literals with regex segments (e.g., `Hello /world.*/`) so only the delimited part is treated as regex.
+- Optional second `---` section can carry metadata:
+  ``` 
+  name: critical-hit
+  vars:
+    cvars:
+      hp: 12
+  character:
+    name: Tester
+  ```
+  `name` is a label for reporting, `vars` are merged into cvars/uvars/svars/gvars, and `character` keys are deep-merged into the mock character.
+- Run them with `avrae-ls --run-tests [path]` (defaults to the current directory); non-zero exit codes indicate failures.
+
 ## Runtime differences (mock vs. live Avrae)
 
 - Mock execution never writes back to Avrae: cvar/uvar/gvar mutations only live for the current run and reset before the next.
 - Network is limited to gvar fetches (when `enableGvarFetch` is true) and `verify_signature`; other Avrae/Discord calls are replaced with mocked context data from `.avraels.json`.
 - `get_gvar`/`using` values are pulled from local var files first; remote fetches go to `https://api.avrae.io/customizations/gvars/<id>` (or your `avraeService.baseUrl`) using `avraeService.token` and are cached for the session.
-- `signature()` returns a mock string (`mock-signature:<int>`). `verify_signature()` POSTs to `/bot/signature/verify`, respects `verifySignatureTimeout`/`verifySignatureRetries`, reuses the last successful response per signature, and includes `avraeService.token` if present.
+- `signature()` returns a mock string (`mock-signature:<int>`). `verify_signature()` POSTs to `/bot/signature/verify`, reuses the last successful response per signature, and includes `avraeService.token` if present.
 
 ## Troubleshooting gvar fetch / verify_signature
 
 - `get_gvar` returns `None` or `using(...)` raises `ModuleNotFoundError`: ensure the workspace `.avraels.json` sets `enableGvarFetch: true`, includes a valid `avraeService.token`, or seed the gvar in a var file referenced by `varFiles`.
 - HTTP 401/403/404 from fetch/verify calls: check the token (401/403) and the gvar/signature id (404). Override `avraeService.baseUrl` if you mirror the API.
-- Slow or flaky calls: tune `verifySignatureTimeout` / `verifySignatureRetries`, or disable remote fetches by flipping `enableGvarFetch` off to rely purely on local vars.
+- Slow or flaky calls: disable remote fetches by flipping `enableGvarFetch` off to rely purely on local vars.
 
 ## Other editors (stdio)
 
@@ -98,7 +128,7 @@ Language Server Protocol (LSP) implementation targeting Avrae-style draconic ali
     :major-modes '(fundamental-mode)  ;; bind to your Avrae alias mode
     :server-id 'avrae-ls))
   ```
-- VS Code commands to mirror: `Avrae: Run Alias (Mock)`, `Avrae: Show Alias Preview`, and `Avrae: Reload Workspace Config` run against the same server binary.
+- VS Code commands to mirror: `Avrae: Run Alias (Mock)`, `Avrae: Show Alias Preview`, `Avrae: Refresh GVARs`, and `Avrae: Reload Workspace Config` run against the same server binary.
 
 ## Releasing (maintainers)
 

{avrae_ls-0.5.1 → avrae_ls-0.6.1}/README.md

@@ -27,18 +27,47 @@ Language Server Protocol (LSP) implementation targeting Avrae-style draconic ali
 - Tests only (with coverage): `make test` or `uv run pytest tests --cov=src`.
 - CLI smoke test without installing: `uv run python -m avrae_ls --analyze path/to/alias.txt`.
 
+## Alias tests
+
+- Create files ending with `.alias-test` (or `.aliastest`) next to your alias file. Each test starts with an invocation, followed by `---` and the expected result; you can stack multiple tests in one file by repeating this pattern (optional metadata after a second `---` per test).
+  ```
+  !my-alias -b example args
+  ---
+  expected text or number
+  ```
+- For embed aliases, put a YAML/JSON dictionary after the separator to compare against the embed preview (partial dictionaries are allowed).
+  ```
+  !embedtest
+  ---
+  title: Hello
+  description: World
+  ```
+- Embed fields lists can be partial: only the listed fields (in order) are matched; extra fields in the alias do not fail the test.
+- Use regex expectations by wrapping strings in `/.../` (or `re:...`). You can also mix literals with regex segments (e.g., `Hello /world.*/`) so only the delimited part is treated as regex.
+- Optional second `---` section can carry metadata:
+  ``` 
+  name: critical-hit
+  vars:
+    cvars:
+      hp: 12
+  character:
+    name: Tester
+  ```
+  `name` is a label for reporting, `vars` are merged into cvars/uvars/svars/gvars, and `character` keys are deep-merged into the mock character.
+- Run them with `avrae-ls --run-tests [path]` (defaults to the current directory); non-zero exit codes indicate failures.
+
 ## Runtime differences (mock vs. live Avrae)
 
 - Mock execution never writes back to Avrae: cvar/uvar/gvar mutations only live for the current run and reset before the next.
 - Network is limited to gvar fetches (when `enableGvarFetch` is true) and `verify_signature`; other Avrae/Discord calls are replaced with mocked context data from `.avraels.json`.
 - `get_gvar`/`using` values are pulled from local var files first; remote fetches go to `https://api.avrae.io/customizations/gvars/<id>` (or your `avraeService.baseUrl`) using `avraeService.token` and are cached for the session.
-- `signature()` returns a mock string (`mock-signature:<int>`). `verify_signature()` POSTs to `/bot/signature/verify`, respects `verifySignatureTimeout`/`verifySignatureRetries`, reuses the last successful response per signature, and includes `avraeService.token` if present.
+- `signature()` returns a mock string (`mock-signature:<int>`). `verify_signature()` POSTs to `/bot/signature/verify`, reuses the last successful response per signature, and includes `avraeService.token` if present.
 
 ## Troubleshooting gvar fetch / verify_signature
 
 - `get_gvar` returns `None` or `using(...)` raises `ModuleNotFoundError`: ensure the workspace `.avraels.json` sets `enableGvarFetch: true`, includes a valid `avraeService.token`, or seed the gvar in a var file referenced by `varFiles`.
 - HTTP 401/403/404 from fetch/verify calls: check the token (401/403) and the gvar/signature id (404). Override `avraeService.baseUrl` if you mirror the API.
-- Slow or flaky calls: tune `verifySignatureTimeout` / `verifySignatureRetries`, or disable remote fetches by flipping `enableGvarFetch` off to rely purely on local vars.
+- Slow or flaky calls: disable remote fetches by flipping `enableGvarFetch` off to rely purely on local vars.
 
 ## Other editors (stdio)
 
@@ -59,7 +88,7 @@ Language Server Protocol (LSP) implementation targeting Avrae-style draconic ali
     :major-modes '(fundamental-mode)  ;; bind to your Avrae alias mode
     :server-id 'avrae-ls))
   ```
-- VS Code commands to mirror: `Avrae: Run Alias (Mock)`, `Avrae: Show Alias Preview`, and `Avrae: Reload Workspace Config` run against the same server binary.
+- VS Code commands to mirror: `Avrae: Run Alias (Mock)`, `Avrae: Show Alias Preview`, `Avrae: Refresh GVARs`, and `Avrae: Reload Workspace Config` run against the same server binary.
 
 ## Releasing (maintainers)
 

{avrae_ls-0.5.1 → avrae_ls-0.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "avrae-ls"
-version = "0.5.1"
+version = "0.6.1"
 description = "Language server for Avrae draconic aliases"
 authors = [
   { name = "1drturtle" }
@@ -17,6 +17,7 @@ dependencies = [
     "lsprotocol>=2023.0.1",
     "httpx>=0.27",
     "d20>=1.1.2",
+    "pyyaml>=6.0",
 ]
 
 [project.optional-dependencies]
@@ -35,6 +36,8 @@ packages = ["src/avrae_ls", "src/draconic"]
 
 [tool.hatch.build]
 include = [
+    "src/avrae_ls",
+    "src/draconic",
     "src/draconic/LICENSE",
 ]
 

avrae_ls-0.6.1/src/avrae_ls/__init__.py

@@ -0,0 +1,3 @@
+from .server import create_server
+
+__all__ = ["create_server"]

avrae_ls-0.6.1/src/avrae_ls/__main__.py

@@ -0,0 +1,210 @@
+from __future__ import annotations
+
+import argparse
+import asyncio
+import logging
+import sys
+from pathlib import Path
+from typing import Iterable
+
+import yaml
+
+from lsprotocol import types
+
+from .alias_tests import AliasTestError, AliasTestResult, discover_test_files, parse_alias_tests, run_alias_tests
+from .config import CONFIG_FILENAME, load_config
+from .context import ContextBuilder
+from .diagnostics import DiagnosticProvider
+from .runtime import MockExecutor
+from .server import create_server, __version__
+
+
+def main(argv: list[str] | None = None) -> None:
+    parser = argparse.ArgumentParser(description="Avrae draconic alias language server")
+    parser.add_argument("--tcp", action="store_true", help="Run in TCP mode instead of stdio")
+    parser.add_argument("--host", default="127.0.0.1", help="TCP host (when --tcp is set)")
+    parser.add_argument("--port", type=int, default=2087, help="TCP port (when --tcp is set)")
+    parser.add_argument("--stdio", action="store_true", help="Accept stdio flag for VS Code clients (ignored)")
+    parser.add_argument("--log-level", default="WARNING", help="Logging level (DEBUG, INFO, WARNING, ERROR)")
+    parser.add_argument("--analyze", metavar="FILE", help="Run diagnostics for a file and print them to stdout")
+    parser.add_argument(
+        "--run-tests",
+        metavar="PATH",
+        nargs="?",
+        const=".",
+        help="Run alias tests in PATH (defaults to current directory)",
+    )
+    parser.add_argument("--version", action="store_true", help="Print version and exit")
+    args = parser.parse_args(argv)
+
+    _configure_logging(args.log_level)
+
+    if args.version:
+        print(__version__)
+        return
+
+    if args.run_tests is not None:
+        if args.tcp:
+            parser.error("--run-tests cannot be combined with --tcp")
+        if args.analyze:
+            parser.error("--run-tests cannot be combined with --analyze")
+        sys.exit(_run_alias_tests(Path(args.run_tests)))
+
+    if args.analyze:
+        if args.tcp:
+            parser.error("--analyze cannot be combined with --tcp")
+        sys.exit(_run_analysis(Path(args.analyze)))
+
+    server = create_server()
+    if args.tcp:
+        server.start_tcp(args.host, args.port)
+    else:
+        server.start_io()
+
+
+def _configure_logging(level: str) -> None:
+    numeric = getattr(logging, level.upper(), logging.WARNING)
+    if not isinstance(numeric, int):
+        numeric = logging.WARNING
+    logging.basicConfig(
+        level=numeric,
+        format="%(levelname)s %(name)s: %(message)s",
+    )
+
+
+def _run_analysis(path: Path) -> int:
+    if not path.exists():
+        print(f"File not found: {path}", file=sys.stderr)
+        return 2
+
+    workspace_root = _discover_workspace_root(path)
+    log = logging.getLogger(__name__)
+    log.info("Analyzing %s (workspace root: %s)", path, workspace_root)
+
+    config, warnings = load_config(workspace_root)
+    for warning in warnings:
+        log.warning(warning)
+
+    builder = ContextBuilder(config)
+    ctx_data = builder.build()
+    executor = MockExecutor(config.service)
+    diagnostics = DiagnosticProvider(executor, config.diagnostics)
+
+    source = path.read_text()
+    results = asyncio.run(diagnostics.analyze(source, ctx_data, builder.gvar_resolver))
+    _print_diagnostics(path, results)
+    return 1 if results else 0
+
+
+def _run_alias_tests(target: Path) -> int:
+    if not target.exists():
+        print(f"Test path not found: {target}", file=sys.stderr)
+        return 2
+
+    workspace_root = _discover_workspace_root(target)
+    log = logging.getLogger(__name__)
+    log.info("Running alias tests in %s (workspace root: %s)", target, workspace_root)
+
+    config, warnings = load_config(workspace_root)
+    for warning in warnings:
+        log.warning(warning)
+
+    builder = ContextBuilder(config)
+    executor = MockExecutor(config.service)
+
+    test_files = discover_test_files(target)
+    cases = []
+    parse_errors: list[str] = []
+    for test_file in test_files:
+        try:
+            cases.extend(parse_alias_tests(test_file))
+        except AliasTestError as exc:
+            parse_errors.append(str(exc))
+
+    if parse_errors:
+        for err in parse_errors:
+            print(err, file=sys.stderr)
+    if not cases:
+        print(f"No alias tests found under {target}")
+        return 1 if parse_errors else 0
+
+    results = asyncio.run(run_alias_tests(cases, builder, executor))
+    _print_test_results(results, workspace_root)
+
+    failures = [res for res in results if not res.passed]
+    return 1 if failures or parse_errors else 0
+
+
+def _print_test_results(results: Iterable[AliasTestResult], workspace_root: Path) -> None:
+    total = len(results)
+    passed = 0
+    for res in results:
+        rel = _relative_to_workspace(res.case.path, workspace_root)
+        label = f"{rel} ({res.case.name})" if res.case.name else rel
+        status = "PASS" if res.passed else "FAIL"
+        print(f"[{status}] {label} (alias: {res.case.alias_name})")
+        if res.passed:
+            if res.stdout:
+                print(f"  Stdout: {res.stdout.strip()}")
+            passed += 1
+            continue
+        if res.error:
+            print(f"  Error: {res.error}")
+        if res.details:
+            print(f"  {res.details}")
+        expected = _format_value(res.case.expected)
+        actual = _format_value(res.actual)
+        print(f"  Expected: {expected}")
+        print(f"  Actual:   {actual}")
+        if res.stdout:
+            print(f"  Stdout: {res.stdout.strip()}")
+    print(f"{passed}/{total} tests passed")
+
+
+def _relative_to_workspace(path: Path, workspace_root: Path) -> str:
+    try:
+        return str(path.relative_to(workspace_root))
+    except ValueError:
+        return str(path)
+
+
+def _format_value(value) -> str:
+    if value is None:
+        return "None"
+    if isinstance(value, (dict, list)):
+        return (yaml.safe_dump(value, sort_keys=False) or "").strip()
+    return str(value)
+
+
+def _discover_workspace_root(target: Path) -> Path:
+    current = target if target.is_dir() else target.parent
+    for folder in [current, *current.parents]:
+        if (folder / CONFIG_FILENAME).exists():
+            return folder
+    return current
+
+
+def _print_diagnostics(path: Path, diagnostics: Iterable[types.Diagnostic]) -> None:
+    diags = list(diagnostics)
+    if not diags:
+        print(f"{path}: no issues found")
+        return
+
+    for diag in diags:
+        start = diag.range.start
+        severity = _severity_label(diag.severity)
+        source = diag.source or "avrae-ls"
+        print(f"{path}:{start.line + 1}:{start.character + 1}: {severity} [{source}] {diag.message}")
+
+
+def _severity_label(severity: types.DiagnosticSeverity | None) -> str:
+    if severity is None:
+        return "info"
+    try:
+        return types.DiagnosticSeverity(severity).name.lower()
+    except Exception:
+        return str(severity).lower()
+
+
+if __name__ == "__main__":
+    main()