denisidoro/navi

Escape <variable> in cheat files

Open

#250 opened on Mar 13, 2020

View on GitHub
 (7 comments) (2 reactions) (0 assignees)Rust (15,874 stars) (530 forks)batch import
help wantednew feature

Description

Is your feature request related to a problem? Please describe.

# build default.nix
nix-build -E 'with import <nixpkgs> {} ; callPackage ./default.nix {}'

this line things of nixpkgs> as a variable, but it actually should stay `.

Describe the solution you'd like

Best we to escapt <nixpkgs> some how.

Describe alternatives you've considered

currently I ship around it, by defining

$ nixpkgs: echo "<nixpkgs>"

Contributor guide

Tech stack
rustshell
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Rust knowledgeunderstand navi cheat file format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how variables are currently parsed in cheat files, likely in src/parser.rs or similar. Look for where angle brackets are interpreted as variable syntax. Propose an escaping mechanism (e.g., backslash before the opening bracket) and update the parser accordingly. Check existing tests for variable parsing and add new test cases for escaped variables.