Rename check from newline-after-block to after-block (#228)

Author: bombsimon

CHECKS.md

@@ -3,6 +3,7 @@
 ## Table of content
 
 - [Checks](#checks)
+  - [`after-block`](#after-block)
   - [`append`](#append)
   - [`assign`](#assign)
   - [`assign-exclusive`](#assign-exclusive)
@@ -18,7 +19,6 @@
   - [`inc-dec`](#inc-dec)
   - [`label`](#label)
   - [`leading-whitespace`](#leading-whitespace)
-  - [`newline-after-block`](#newline-after-block)
   - [`range`](#range)
   - [`return`](#return)
   - [`select`](#select)
@@ -36,6 +36,68 @@
 This document describes all the checks done by `wsl` with examples of what's not
 allowed and what's allowed.
 
+### `after-block`
+
+Block statements (`if`, `for`, `switch`, etc.) should be followed by a blank
+line to visually separate them from subsequent code.
+
+> **NOTE** An exception is made for `defer` statements that follow an
+> `if err != nil` block when the defer references a variable assigned on the
+> line above the if statement. This is a common pattern for resource cleanup.
+
+<table>
+<thead><tr><th>Bad</th><th>Good</th></tr></thead>
+<tbody>
+<tr><td valign="top">
+
+```go
+if true {
+    fmt.Println("hello")
+} // 1
+fmt.Println("world")
+
+for i := 0; i < 3; i++ {
+    fmt.Println(i)
+} // 2
+x := 1
+```
+
+</td><td valign="top">
+
+```go
+if true {
+    fmt.Println("hello")
+}
+
+fmt.Println("world")
+
+for i := 0; i < 3; i++ {
+    fmt.Println(i)
+}
+
+x := 1
+
+// Exception: defer after error check
+f, err := os.Open("file.txt")
+if err != nil {
+    return err
+}
+defer f.Close()
+```
+
+</td></tr>
+
+<tr><td valign="top">
+
+<sup>1</sup> Missing whitespace after block
+
+<sup>2</sup> Missing whitespace after block
+
+</td><td valign="top">
+
+</td></tr>
+</tbody></table>
+
 ### `assign`
 
 Assign (`foo := bar`) or re-assignments (`foo = bar`) should only be cuddled
@@ -1284,68 +1346,6 @@ if true {
 
 </tbody></table>
 
-### `newline-after-block`
-
-Block statements (`if`, `for`, `switch`, etc.) should be followed by a blank
-line to visually separate them from subsequent code.
-
-> **NOTE** An exception is made for `defer` statements that follow an
-> `if err != nil` block when the defer references a variable assigned on the
-> line above the if statement. This is a common pattern for resource cleanup.
-
-<table>
-<thead><tr><th>Bad</th><th>Good</th></tr></thead>
-<tbody>
-<tr><td valign="top">
-
-```go
-if true {
-    fmt.Println("hello")
-}
-fmt.Println("world") // 1
-
-for i := 0; i < 3; i++ {
-    fmt.Println(i)
-}
-x := 1 // 2
-```
-
-</td><td valign="top">
-
-```go
-if true {
-    fmt.Println("hello")
-}
-
-fmt.Println("world")
-
-for i := 0; i < 3; i++ {
-    fmt.Println(i)
-}
-
-x := 1
-
-// Exception: defer after error check
-f, err := os.Open("file.txt")
-if err != nil {
-    return err
-}
-defer f.Close()
-```
-
-</td></tr>
-
-<tr><td valign="top">
-
-<sup>1</sup> Missing whitespace after block
-
-<sup>2</sup> Missing whitespace after block
-
-</td><td valign="top">
-
-</td></tr>
-</tbody></table>
-
 ### `trailing-whitespace`
 
 <table>

README.md

@@ -64,6 +64,7 @@ For more details and examples, see [CHECKS](CHECKS.md).
 
 #### Specific `wsl` cases
 
+- ❌ **after-block** - Require empty line after block statements
 - ✅ **append** - Only allow re-assigning with `append` if the value being
   appended exist on the line above
 - ❌ **assign-exclusive** - Only allow cuddling either new variables or
@@ -73,7 +74,6 @@ For more details and examples, see [CHECKS](CHECKS.md).
 - ✅ **err** - Error checking must follow immediately after the error variable
   is assigned
 - ✅ **leading-whitespace** - Disallow leading empty lines in blocks
-- ❌ **newline-after-block** - Require empty line after block statements
 - ✅ **trailing-whitespace** - Disallow trailing empty lines in blocks
 
 ### Configuration
@@ -166,13 +166,14 @@ linters:
         - leading-whitespace
         - trailing-whitespace
       disable:
+        - after-block
         - assign-exclusive
         - assign-expr
-        - newline-after-block
 ```
 
 ## See also
 
+- [`newline-after-block`][newline-after-block] - Require newline after blocks
 - [`nlreturn`][nlreturn] - Use empty lines before `return`
 - [`whitespace`][whitespace] - Don't use a blank newline at the start or end of
   a block.
@@ -181,5 +182,6 @@ linters:
   [analysis]: https://pkg.go.dev/golang.org/x/tools/go/analysis
   [gofumpt]: https://github.com/mvdan/gofumpt
   [golangci-lint]: https://golangci-lint.run
+  [newline-after-block]: https://github.com/breml/newline-after-block
   [nlreturn]: https://github.com/ssgreg/nlreturn
   [whitespace]: https://github.com/ultraware/whitespace

analyzer_test.go

@@ -116,11 +116,11 @@ func TestWithConfig(t *testing.T) {
 			},
 		},
 		{
-			subdir: "newline_after_block",
+			subdir: "after_block",
 			configFn: func(config *Configuration) {
 				config.Checks = NoChecks()
 				config.Checks.Add(CheckCaseTrailingNewline)
-				config.Checks.Add(CheckNewlineAfterBlock)
+				config.Checks.Add(CheckAfterBlock)
 
 				config.CaseMaxLines = 1
 			},

config.go

@@ -33,6 +33,8 @@ const (
 	CheckSwitch
 	CheckTypeSwitch
 
+	// CheckAfterBlock ensures there's a newline after each block.
+	CheckAfterBlock
 	// CheckAppend only allows assignments of `append` to be cuddled with other
 	// assignments if it's a variable used in the append statement, e.g.
 	//
@@ -70,7 +72,6 @@ const (
 	CheckErr
 	CheckLeadingWhitespace
 	CheckTrailingWhitespace
-	CheckNewlineAfterBlock
 
 	//nolint:godoclint // No need to document
 	// CheckTypes only used for reporting.
@@ -97,13 +98,13 @@ func (c CheckType) String() string {
 		"switch",
 		"type-switch",
 		//
+		"after-block",
 		"append",
 		"assign-exclusive",
 		"assign-expr",
 		"err",
 		"leading-whitespace",
 		"trailing-whitespace",
-		"newline-after-block",
 		//
 		"case-trailing-newline",
 	}[c]
@@ -213,7 +214,7 @@ func AllChecks() CheckSet {
 	c := DefaultChecks()
 	c.Add(CheckAssignExclusive)
 	c.Add(CheckAssignExpr)
-	c.Add(CheckNewlineAfterBlock)
+	c.Add(CheckAfterBlock)
 
 	return c
 }
@@ -265,6 +266,8 @@ func CheckFromString(s string) (CheckType, error) {
 	case "type-switch":
 		return CheckTypeSwitch, nil
 
+	case "after-block":
+		return CheckAfterBlock, nil
 	case "append":
 		return CheckAppend, nil
 	case "assign-exclusive":
@@ -277,8 +280,6 @@ func CheckFromString(s string) (CheckType, error) {
 		return CheckLeadingWhitespace, nil
 	case "trailing-whitespace":
 		return CheckTrailingWhitespace, nil
-	case "newline-after-block":
-		return CheckNewlineAfterBlock, nil
 	default:
 		return CheckInvalid, fmt.Errorf("invalid check '%s'", s)
 	}

…g/newline_after_block/blockstatements.go …th_config/after_block/blockstatements.gotestdata/src/with_config/newline_after_block/blockstatements.go renamed to testdata/src/with_config/after_block/blockstatements.go testdata/src/with_config/newline_after_block/blockstatements.go renamed to testdata/src/with_config/after_block/blockstatements.go

@@ -6,7 +6,7 @@ func ifStatementWithoutNewline() {
 	x := 5
 	if x > 0 {
 		fmt.Println("positive")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("next statement")
 }
 
@@ -43,7 +43,7 @@ func ifElseStatementWithoutNewline() {
 		fmt.Println("positive")
 	} else {
 		fmt.Println("not positive")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("next statement")
 }
 
@@ -77,14 +77,14 @@ func ifElseIfStatementWithoutNewline() {
 		fmt.Println("negative")
 	} else {
 		fmt.Println("zero")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("next statement")
 }
 
 func forLoopWithoutNewline() {
 	for i := 0; i < 5; i++ {
 		fmt.Println(i)
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after loop")
 }
 
@@ -106,7 +106,7 @@ func rangeLoopWithoutNewline() {
 	items := []int{1, 2, 3}
 	for _, item := range items {
 		fmt.Println(item)
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after loop")
 }
 
@@ -128,7 +128,7 @@ func switchStatementWithoutNewline() {
 		fmt.Println("two") // want `missing whitespace below this line \(case-trailing-newline\)`
 	default:
 		fmt.Println("other")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after switch")
 }
 
@@ -155,7 +155,7 @@ func selectStatementWithoutNewline() {
 		fmt.Println(v) // want `missing whitespace below this line \(case-trailing-newline\)`
 	default:
 		fmt.Println("default")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after select")
 }
 
@@ -177,7 +177,7 @@ func multipleStatementsWithMixedViolations() {
 
 	if x > 0 {
 		fmt.Println("positive")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	for i := 0; i < x; i++ {
 		fmt.Println(i)
 	}
@@ -194,9 +194,9 @@ func nestedIfWithoutNewline() {
 	if x > 0 {
 		if y > 0 {
 			fmt.Println("both positive")
-		} // want `missing whitespace below this line \(newline-after-block\)`
+		} // want `missing whitespace below this line \(after-block\)`
 		fmt.Println("x positive")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after outer if")
 }
 
@@ -218,9 +218,9 @@ func nestedForWithoutNewline() {
 	for i := 0; i < 3; i++ {
 		for j := 0; j < 3; j++ {
 			fmt.Println(i, j)
-		} // want `missing whitespace below this line \(newline-after-block\)`
+		} // want `missing whitespace below this line \(after-block\)`
 		fmt.Println("inner loop done")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after outer loop")
 }
 
@@ -244,11 +244,11 @@ func nestedSwitchWithoutNewline() {
 		switch y {
 		case 2:
 			fmt.Println("x=1, y=2")
-		} // want `missing whitespace below this line \(newline-after-block\)`
+		} // want `missing whitespace below this line \(after-block\)`
 		fmt.Println("x=1") // want `missing whitespace below this line \(case-trailing-newline\)`
 	case 2:
 		fmt.Println("x=2")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after outer switch")
 }
 
@@ -279,7 +279,7 @@ func complexNested() {
 				fmt.Println("zero") // want `missing whitespace below this line \(case-trailing-newline\)`
 			case 2:
 				fmt.Println("two")
-			} // want `missing whitespace below this line \(newline-after-block\)`
+			} // want `missing whitespace below this line \(after-block\)`
 			fmt.Println("even")
 		}
 
@@ -298,7 +298,7 @@ func typeSwitchWithoutNewline() {
 		fmt.Println("int:", v) // want `missing whitespace below this line \(case-trailing-newline\)`
 	default:
 		fmt.Println("unknown type")
-	} // want `missing whitespace below this line \(newline-after-block\)`
+	} // want `missing whitespace below this line \(after-block\)`
 	fmt.Println("after type switch")
 }