designing-options

@khaneliman/designing-options

khaneliman

302

14 forks

Updated 1/18/2026

View on GitHub

khanelinix option namespacing and design patterns. Use when defining module options, accessing configuration values, or understanding the khanelinix.* namespace convention.

Installation

$skills install @khaneliman/designing-options

Claude Code

Cursor

Copilot

Codex

Antigravity

Details

Repositorykhaneliman/khanelinix

Pathmodules/common/ai-tools/skills/khanelinix/designing-options/SKILL.md

Branchmain

Scoped Name@khaneliman/designing-options

Usage

After installing, this skill will be available to your AI coding assistant.

Verify installation:

skills list

Skill Instructions

name: designing-options description: "khanelinix option namespacing and design patterns. Use when defining module options, accessing configuration values, or understanding the khanelinix.* namespace convention."

Options Design

Namespace Convention

ALL options must be under khanelinix.*:

options.khanelinix.{category}.{module}.{option} = { ... };

Namespace Visualization

khanelinix.*
├── programs.*
│   ├── terminal.*
│   │   ├── tools.*      (git, fzf, ripgrep, ...)
│   │   ├── shells.*     (zsh, bash, fish, ...)
│   │   └── editors.*    (neovim, helix, ...)
│   └── graphical.*
│       ├── wms.*        (hyprland, sway, ...)
│       └── apps.*       (firefox, discord, ...)
├── services.*           (user systemd services)
├── desktop.*            (DE configurations)
├── security.*           (sops, gpg, ssh)
├── system.*             (fonts, xdg, env)
└── user.*               (name, email, theme)

Examples

options.khanelinix.programs.terminal.tools.git.enable = ...
options.khanelinix.desktop.windowManagers.hyprland.enable = ...
options.khanelinix.security.sops.enable = ...
options.khanelinix.user.name = ...

Standard Option Pattern

{
  config,
  lib,
  pkgs,
  ...
}:
let
  inherit (lib) mkIf mkEnableOption;

  cfg = config.khanelinix.programs.myApp;
in
{
  options.khanelinix.programs.myApp = {
    enable = mkEnableOption "My App";
  };

  config = mkIf cfg.enable {
    # configuration here
  };
}

Accessing User Context

let
  inherit (config.khanelinix) user;
in
{
  # Use user.name, user.email, user.fullName
  programs.git.userName = user.fullName;
}

Reduce Repetition

Use shared top-level options:

# Define once at top level
options.khanelinix.theme.name = mkOption { ... };

# Reference throughout
config = mkIf (cfg.theme.name == "catppuccin") { ... };

Option Helpers

khanelinix provides helpers in lib.khanelinix:

inherit (lib.khanelinix) mkOpt enabled disabled;

# Quick enable/disable
programs.git = enabled;   # { enable = true; }
programs.foo = disabled;  # { enable = false; }

# Custom option with default
userName = mkOpt types.str "default" "User name";

osConfig Access

When home modules need system config:

{
  config,
  lib,
  osConfig ? { },  # With fallback
  ...
}:

# Always guard with fallback
config = lib.mkIf (osConfig.khanelinix.security.sops.enable or false) {
  # ...
};

Common Anti-Patterns

❌ Direct nixpkgs options

# BAD - bypasses khanelinix abstraction
programs.git.enable = true;

✅ Namespaced options

# GOOD - uses khanelinix namespace
khanelinix.programs.terminal.tools.git.enable = true;

❌ Hardcoded theme values

# BAD - theme string duplicated everywhere
programs.kitty.theme = "Catppuccin-Mocha";

✅ Reference shared theme

# GOOD - single source of truth
programs.kitty.theme = config.khanelinix.user.theme;

❌ Missing type specification

# BAD - implicit type, can cause issues
myOption = mkOption {
  default = "";
  description = "Some option";
};

✅ Explicit types

# GOOD - explicit type
myOption = mkOption {
  type = types.str;
  default = "";
  description = "Some option";
};

More by khaneliman

View all

template-creation

302

Create development environment templates and project scaffolding with Nix flakes. Use when creating new project templates, setting up dev shells, configuring language-specific environments, or integrating with CI/CD.

managing-secrets

302

Manages encrypted secrets using sops-nix and age. Use when adding new secrets, rotating keys, debugging secret access, or setting up secret management for new hosts/users.

code-review

302

Conduct thorough, actionable code reviews focusing on critical issues. Use when reviewing pull requests, analyzing code changes, identifying bugs, security vulnerabilities, or suggesting improvements that developers will actually implement.

scaffolding-modules

302

khanelinix directory structure and module placement. Use when creating new modules, deciding where files belong, or understanding the modules/ organization. Covers platform separation (nixos/darwin/home/common) and auto-discovery.