feat: read configuration from XDG base directory and new install instructions, etc - #45
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates ell to follow the XDG Base Directory conventions for configuration/templates/plugins, improves Windows compatibility for the launcher, and removes the external jq dependency by introducing a pure-bash JSON parser.
Changes:
- Read config from
${XDG_CONFIG_HOME:-$HOME/.config}/ell/config(while keeping legacy~/.ellrcsupport). - Add XDG-aware template/plugin resolution across config/data/legacy/bundled roots.
- Replace
jqusage in OpenAI/Gemini backends with a new pure-bash JSON parser and update docs/testing notes accordingly.
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/entry.sh | Removes jq from test container prerequisites. |
| README.md | Updates install instructions for XDG data layout; adds Windows guidance; documents Docker-based testing. |
| llm_backends/openai/generate_completion.sh | Switches response parsing from jq to json_* helpers. |
| llm_backends/gemini/generate_completion.sh | Switches response parsing from jq to json_* helpers (including stream buffer parsing). |
| helpers/resolve_paths.sh | Adds XDG-aware template resolution and multi-root plugin hook discovery/dedup. |
| helpers/load_config.sh | Adds XDG main config file load before legacy/per-project/override configs. |
| helpers/json.sh | Introduces a pure-bash JSON parser and query helpers (json_parse/json_get/json_has). |
| ell.sh | Wires in new helpers; resolves templates via multi-root search; updates hook discovery. |
| docs/Plugins.md | Documents the new multi-root plugin discovery and override behavior. |
| docs/Configuration.md | Documents XDG config location and updated ELL_TEMPLATE_PATH semantics. |
| .gitattributes | Forces LF endings for scripts/templates to avoid Windows shebang failures. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
implements #17, fixes #43.
also removes jq dependency