%stop!

Author: Itay Donanhirsh

README.md

@@ -1,4 +1,4 @@
-<!-- [# %stop #] -->
+<!-- [# %stop! #] -->
 
 # [# Clutter #]
 
@@ -111,7 +111,7 @@ These tags are written as a normal tag to the index, with an added attribute `se
 
 ### Pragma Tags
 
-There are only two pragma tags implemented: `%stop` and `%cont`. Example:
+There are only three pragma tags implemented: `%stop`, '%stop!' and `%cont`. Example:
 
 ```
 [# to_be #]
@@ -121,6 +121,9 @@ There are only two pragma tags implemented: `%stop` and `%cont`. Example:
 [# that_is_the_question #]
 ```
 
+`%stop!` will stop parsing the file entirely, ignoring further pragmas as well.
+
+
 ## Index
 
 To generate an index, use:

internal/pkg/scanner/scan_raw.go

@@ -13,7 +13,7 @@ func ScanRawReader(
 	z *zap.SugaredLogger,
 	cfg BracketConfig,
 	r io.Reader,
-	f func(*RawElement) error, // will not include path. path is filled in [# .fill-path #].
+	f func(*RawElement) error, // will not include path. path is filled in [# ./fill-path #].
 ) error {
 	re, err := cfg.Regexp()
 	if err != nil {
@@ -24,6 +24,7 @@ func ScanRawReader(
 
 	stopped := false
 
+S:
 	for i := 0; scanner.Scan(); i++ {
 		line := scanner.Text()
 
@@ -39,6 +40,10 @@ func ScanRawReader(
 
 			if strings.HasPrefix(text, "%") {
 				switch text[1:] {
+				case "stop!":
+					// hard stop will stop scanning the rest of the file.
+					break S
+
 				case "stop":
 					if stopped {
 						return fmt.Errorf("already stopped")

internal/pkg/scanner/scan_sitter.go

@@ -0,0 +1,22 @@
+package scanner
+
+import (
+	"fmt"
+	"io"
+
+	"go.uber.org/zap"
+)
+
+func ScanSitterReader(
+	z *zap.SugaredLogger,
+	cfg BracketConfig,
+	r io.Reader,
+	f func(*RawElement) error, // will not include path. path is filled in [# ./fill-path #].
+) error {
+	_, err := cfg.Regexp()
+	if err != nil {
+		return fmt.Errorf("invalid bracket: %w", err)
+	}
+
+	return nil
+}