Rename to cut

Author: wreulicke

testdata/skip.go renamed to .snapshot/TestPatch_Cut

@@ -55,6 +55,50 @@ Flags:
 Use "patchr [command] --help" for more information about a command.
 ```
 
+### Directives
+
+Currently, we have 5 directives.
+
+1. replace
+  * repalce next line
+2. add
+  * add next line
+3. remove
+  * remove next line
+4. template
+  * expand template using go/template
+5. cut
+  * cut a whole block
+
+```go
+func main() {
+  // You can use go text/template in replace/add/template directives
+  
+  // `replace` directive replace next line
+	// patchr:replace fmt.Println("Hello, {{ .Name }}!")
+  fmt.Println("Hello World!")
+
+  // `add` directive add next line
+  // patchr:add fmt.Println("Hello, {{ .Name }}!")
+
+  // `template` directive can expand text/template here
+  // patchr:template-start
+  // {{ if .Enabled }}
+  // fmt.Println("Enabled!")
+  // {{ end }}
+  // patchr:template-end
+
+  // `remove` directive remove next line
+  // patchr:remove
+  fmt.Println("this will be removed")
+  
+  // `cut` directive cut the whole block
+  // patchr:cut-start
+  panic("this will be cut")
+  // patchr:cut-end
+}
+```
+
 ## Example
 
 See [testdata](./testdata/).

.snapshot/TestPatch_Skip

@@ -29,10 +29,10 @@ const (
 	commentDirectiveTemplateStart = "patchr:template-start"
 	// end of template block.
 	commentDirectiveTemplateEnd = "patchr:template-end"
-	// start of skip block.
-	commentDirectiveSkipStart = "patchr:skip-start"
-	// end of skip block.
-	commentDirectiveSkipEnd = "patchr:skip-end"
+	// start of cut block.
+	commentDirectiveCutStart = "patchr:cut-start"
+	// end of cut block.
+	commentDirectiveCutEnd = "patchr:cut-end"
 )
 
 var commentDirectives = []patchCommentDirective{
@@ -41,8 +41,8 @@ var commentDirectives = []patchCommentDirective{
 	commentDirectiveRemove,
 	commentDirectiveTemplateStart,
 	commentDirectiveTemplateEnd,
-	commentDirectiveSkipStart,
-	commentDirectiveSkipEnd,
+	commentDirectiveCutStart,
+	commentDirectiveCutEnd,
 }
 
 type Patcher struct {
@@ -103,9 +103,9 @@ func (p *Patcher) visit(line string, dst *bufio.Writer, scanner *bufio.Scanner,
 				return p.visitTemplateStart(line, dst, scanner, data)
 			case commentDirectiveTemplateEnd:
 				return errors.New("unexpected end directive")
-			case commentDirectiveSkipStart:
-				return p.visitSkipStart(line, dst, scanner, data)
-			case commentDirectiveSkipEnd:
+			case commentDirectiveCutStart:
+				return p.visitCutStart(line, dst, scanner, data)
+			case commentDirectiveCutEnd:
 				return errors.New("unexpected end directive")
 			}
 		}
@@ -189,10 +189,10 @@ func (p *Patcher) visitTemplateStart(line string, dst *bufio.Writer, scanner *bu
 	return writeNewLine(t, dst)
 }
 
-func (p *Patcher) visitSkipStart(line string, dst *bufio.Writer, scanner *bufio.Scanner, data any) error {
+func (p *Patcher) visitCutStart(line string, dst *bufio.Writer, scanner *bufio.Scanner, data any) error {
 	for scanner.Scan() {
 		t := scanner.Text()
-		if strings.Contains(t, p.directives[commentDirectiveSkipEnd]) {
+		if strings.Contains(t, p.directives[commentDirectiveCutEnd]) {
 			break
 		}
 	}

README.md

@@ -47,11 +47,11 @@ func TestPatch_Add(t *testing.T) {
 	s.Assert(t)
 }
 
-func TestPatch_Skip(t *testing.T) {
+func TestPatch_Cut(t *testing.T) {
 	t.Parallel()
 	p := NewPatcher("//", map[string]string{})
 	s := snap.New()
-	f, err := os.Open("testdata/skip.go")
+	f, err := os.Open("testdata/cut.go")
 	if err != nil {
 		t.Fatal(err)
 	}

patch.go

@@ -0,0 +1,9 @@
+package main
+
+// patchr:skip-start
+// Sample is a sample struct.
+type Sample struct {
+	Name string
+}
+
+// patchr:skip-end