refactor: remove legacy mkOpencodeRules alias and opencode-rules compat entry

- Remove mkOpencodeRules backward-compat alias from lib/coding-rules.nix
- Remove opencode-rules alias from lib/default.nix
- Update shells/opencode.nix to use mkCodingRules / coding-rules
- Remove backward-compat test from tests/lib/coding-rules-test.nix
- Update AGENTS.md and modules/home-manager/AGENTS.md docs
- Apply nix fmt formatting to shared-options.nix
This commit is contained in:
sascha.koenig
2026-04-20 19:16:22 +02:00
parent 35f4821bc5
commit 57ebad1358
8 changed files with 22 additions and 30 deletions

View File

@@ -126,12 +126,11 @@ Harness-agnostic agent management. Reads canonical `agent.toml` +
### `lib.coding-rules`
Coding rules injection. Generates `coding-rules.json` + symlinks rules from
the AGENTS repository. The old `lib.opencode-rules` name still works.
the AGENTS repository.
| Function | Purpose |
|----------|--------|
| `mkCodingRules { agents, languages, concerns, frameworks, rulesDir }` | Generate rules config + shellHook. `rulesDir` defaults to `.opencode-rules` |
| `mkOpencodeRules` | Backward-compat alias for `mkCodingRules` |
## PORT MANAGEMENT

View File

@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
### Removed
- Dead overlay entries for non-existent flake inputs
- Legacy `mkOpencodeRules` alias and `lib.opencode-rules` backward-compat entry (use `mkCodingRules` / `lib.coding-rules`)
## [0.4.0] - 2026-04-15

View File

@@ -112,9 +112,6 @@
RULES_EOF
'';
};
# Backward-compat alias
mkOpencodeRules = mkCodingRules;
in {
inherit mkCodingRules mkOpencodeRules;
inherit mkCodingRules;
}

View File

@@ -7,12 +7,9 @@
# Port management utilities
ports = import ./ports.nix {inherit lib;};
# Coding rules injection utilities (renamed from opencode-rules)
# Coding rules injection utilities
coding-rules = import ./coding-rules.nix {inherit lib;};
# Backward-compat alias: opencode-rules → coding-rules
opencode-rules = import ./coding-rules.nix {inherit lib;};
# Agent configuration management utilities
agents = import ./agents.nix {inherit lib;};
}

View File

@@ -163,7 +163,7 @@ The agent system was migrated from embedded `agents.json` to file-based canonica
| `coding.opencode.externalSkills` | `coding.agents.opencode.externalSkills` |
| Agents embedded in `config.json` | File-based `~/.config/opencode/agents/*.md` |
| Model hardcoded in `agents.json` | Per-machine `modelOverrides` |
| `mkOpencodeRules` | `mkCodingRules` (old name still works) |
| `mkOpencodeRules` | `mkCodingRules` |
### Migration steps

View File

@@ -4,11 +4,12 @@
inherit (lib) mkOption mkEnableOption types literalExpression;
in {
# Common agentsInput option used by all agent modules.
mkAgentsInputOption = description: mkOption {
type = types.nullOr types.anything;
default = null;
inherit description;
};
mkAgentsInputOption = description:
mkOption {
type = types.nullOr types.anything;
default = null;
inherit description;
};
# Common modelOverrides option.
mkModelOverridesOption = mkOption {
@@ -62,7 +63,7 @@ in {
{ src = inputs.skills-anthropic; selectSkills = [ "claude-api" ]; }
{ src = inputs.basecamp; }
]
'';
'';
};
# Helper to map externalSkills from module config to mkOpencodeSkills format.
@@ -71,5 +72,6 @@ in {
entry:
{inherit (entry) src skillsDir;}
// lib.optionalAttrs (entry.selectSkills != null) {inherit (entry) selectSkills;}
) cfgEntries;
)
cfgEntries;
}

View File

@@ -1,5 +1,5 @@
# OpenCode development environment with AI coding rules
# This shell demonstrates the mkOpencodeRules library provided by this repository
# This shell demonstrates the mkCodingRules library provided by this repository
# Usage: nix develop .#opencode
#
# To enable OpenCode rules, add the agents input to your flake:
@@ -13,16 +13,16 @@
inputs ? null,
agents ? null,
}: let
# Import the opencode-rules library
# Import the coding-rules library
m3taLib = import ../lib {lib = pkgs.lib;};
# Import custom packages
customPackages = import ../pkgs {inherit pkgs inputs;};
# Create rules configuration only if agents input is provided
# This demonstrates how to use mkOpencodeRules in a real project
# This demonstrates how to use mkCodingRules in a real project
rulesConfig = lib.optionalAttrs (agents != null) {
rules = m3taLib.opencode-rules.mkOpencodeRules {
rules = m3taLib.coding-rules.mkCodingRules {
# Pass the AGENTS repository path
inherit agents;
@@ -75,7 +75,7 @@ in
shellHook = ''
echo "🤖 OpenCode Development Environment"
echo ""
echo "This environment demonstrates the mkOpencodeRules library"
echo "This environment demonstrates the mkCodingRules library"
echo "provided by the m3ta-nixpkgs repository."
echo ""
@@ -121,7 +121,7 @@ in
${
if (agents == null)
then ''
echo "💡 Using mkOpencodeRules in your project:"
echo "💡 Using mkCodingRules in your project:"
echo ""
echo "Add to your flake.nix:"
echo " inputs = {"
@@ -137,7 +137,7 @@ in
echo " system = \"x86_64-linux\";"
echo " pkgs = nixpkgs.legacyPackages.''${system};"
echo " m3taLib = m3ta-nixpkgs.lib.''${system};"
echo " rules = m3taLib.opencode-rules.mkOpencodeRules {"
echo " rules = m3taLib.coding-rules.mkCodingRules {
echo " inherit agents;"
echo " languages = [\"python\" \"typescript\"];"
echo " frameworks = [\"n8n\"];"

View File

@@ -26,10 +26,7 @@ let
in
assert hasCorrectPrefix == true; {result = "pass";};
# Test 3: backward-compat alias exists
testBackwardCompat = assert codingRulesLib.mkOpencodeRules == codingRulesLib.mkCodingRules; {result = "pass";};
# Test 4: shellHook contains both the symlink command and the config generation
# Test 3: shellHook contains both the symlink command and the config generation
testShellHook = let
rules = codingRulesLib.mkCodingRules {
agents = "/tmp/fake-agents";
@@ -43,6 +40,5 @@ let
in {
instructions-correct = testInstructions;
default-rules-dir = testDefaultRulesDir;
backward-compat = testBackwardCompat;
shell-hook = testShellHook;
}