bug: Allow Dynamic Content in Simple Titles (#59)

Allows simple titles (##) to reference variables/attributes/etc chore: Makes LexDocBlockNQString public chore: Replaces TokenConfigDescLine => TokenConfigDescLineStart
TekWizely · Jul 27, 2022 · c7d5bdd · c7d5bdd
1 parent e28963e
commit c7d5bdd
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 16 deletions.
diff --git a/internal/lexer/lexer.go b/internal/lexer/lexer.go
@@ -94,11 +94,8 @@ func LexMain(_ *LexContext, l *lexer.Lexer) LexFn {
 			//
 			if matchOneOrMore(l, isSpaceOrTab) {
 				l.Clear()
-				if matchOneOrMore(l, isPrintNonReturn) {
-					l.EmitToken(TokenConfigDescLine)
-					if matchNewline(l) {
-						l.Clear()
-					}
+				if l.CanPeek(1) && isPrintNonReturn(l.Peek(1)) {
+					l.EmitToken(TokenConfigDescLineStart)
 					return LexMain
 				}
 			}
@@ -536,7 +533,7 @@ func LexDocBlockDesc(ctx *LexContext, l *lexer.Lexer) LexFn {
 			// Desc line
 			//
 			ctx.PushFn(LexDocBlockDesc)
-			return lexDocBlockNQString
+			return LexDocBlockNQString
 		}
 		return LexDocBlockDesc
 	}
@@ -545,9 +542,9 @@ func LexDocBlockDesc(ctx *LexContext, l *lexer.Lexer) LexFn {
 	return nil
 }
 
-// lexDocBlockNQString
+// LexDocBlockNQString lexes a doc block comment line
 //
-func lexDocBlockNQString(ctx *LexContext, l *lexer.Lexer) LexFn {
+func LexDocBlockNQString(ctx *LexContext, l *lexer.Lexer) LexFn {
 	switch {
 	// Consume a run of printable, non-escape characters
 	//
@@ -568,7 +565,7 @@ func lexDocBlockNQString(ctx *LexContext, l *lexer.Lexer) LexFn {
 	//
 	case l.CanPeek(1) && l.Peek(1) == runeDollar:
 		if l.CanPeek(2) && l.Peek(2) == runeLBrace {
-			ctx.PushFn(lexDocBlockNQString)
+			ctx.PushFn(LexDocBlockNQString)
 			l.EmitType(TokenVarRefStart)
 			return LexVarRef
 		}
@@ -580,7 +577,7 @@ func lexDocBlockNQString(ctx *LexContext, l *lexer.Lexer) LexFn {
 		}
 		return nil
 	}
-	return lexDocBlockNQString
+	return LexDocBlockNQString
 }
 
 // LexDocBlockAttr lexes a doc block attribute line
@@ -636,7 +633,7 @@ func LexCmdConfigShell(ctx *LexContext, l *lexer.Lexer) LexFn {
 //
 func LexCmdConfigUsage(_ *LexContext, l *lexer.Lexer) LexFn {
 	ignoreSpace(l)
-	return lexDocBlockNQString
+	return LexDocBlockNQString
 }
 
 // LexCmdConfigOpt matches: name [-l] [--long] [<label>] ["desc"]
@@ -720,7 +717,7 @@ func LexCmdConfigOpt(_ *LexContext, l *lexer.Lexer) LexFn {
 
 	// Desc?
 	//
-	return lexDocBlockNQString
+	return LexDocBlockNQString
 }
 
 // LexCmdShellName lexes a command's shell

diff --git a/internal/lexer/tokens.go b/internal/lexer/tokens.go
@@ -56,7 +56,7 @@ const (
 	TokenHashLine
 
 	TokenConfigShell
-	TokenConfigDescLine
+	TokenConfigDescLineStart
 	TokenConfigDescEnd
 	TokenConfigUsage
 	TokenConfigOpt

diff --git a/internal/parser/parser.go b/internal/parser/parser.go
@@ -175,10 +175,13 @@ func parseMain(ctx *parseContext, p *parser.Parser) parseFn {
 	}
 	// Doc Line
 	//
-	if tryPeekType(p, lexer.TokenConfigDescLine) {
-		line := p.Next()
+	if tryPeekType(p, lexer.TokenConfigDescLineStart) {
+		p.Next()
+		ctx.pushLexFn(ctx.l.Fn)
+		ctx.setLexFn(lexer.LexDocBlockNQString)
+		line := expectDocNQString(ctx, p)
 		cmdConfig = &ast.CmdConfig{}
-		cmdConfig.Desc = append(cmdConfig.Desc, &ast.ScopeValueRunes{Value: line.Value()})
+		cmdConfig.Desc = append(cmdConfig.Desc, line)
 		p.Clear()
 		tryMatchCmd(ctx, p, cmdConfig)
 		return parseMain