enable final new line by default (pinterest#446)

sowmyav24 · Jun 10, 2019 · a9699d9 · a9699d9
1 parent 20ff5f4
commit a9699d9
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/EditorConfig.kt b/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/EditorConfig.kt
@@ -11,8 +11,7 @@ interface EditorConfig {
     val indentSize: Int
     val tabWidth: Int
     val maxLineLength: Int
-    val insertFinalNewline: Boolean?
-
+    val insertFinalNewline: Boolean
     fun get(key: String): String?
 
     companion object {
@@ -26,7 +25,7 @@ interface EditorConfig {
             }
             val tabWidth = map["indent_size"]?.toIntOrNull()
             val maxLineLength = map["max_line_length"]?.toIntOrNull() ?: -1
-            val insertFinalNewline = map["insert_final_newline"]?.toBoolean()
+            val insertFinalNewline = map["insert_final_newline"]?.toBoolean() ?: true
             return object : EditorConfig {
                 override val indentStyle = indentStyle
                 override val indentSize = indentSize

diff --git a/...uleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/FinalNewlineRule.kt b/...uleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/FinalNewlineRule.kt
@@ -16,7 +16,7 @@ class FinalNewlineRule : Rule("final-newline"), Rule.Modifier.RestrictToRoot {
     ) {
         if (node.isRoot()) {
             val editorConfig = node.getUserData(KtLint.EDITOR_CONFIG_USER_DATA_KEY)!!
-            val insertFinalNewline = editorConfig.insertFinalNewline ?: return
+            val insertFinalNewline = editorConfig.insertFinalNewline
             val lastNode = lastChildNodeOf(node)
             if (insertFinalNewline) {
                 if (lastNode !is PsiWhiteSpace || !lastNode.textContains('\n')) {

diff --git a/...et-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/FinalNewlineRuleTest.kt b/...et-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/FinalNewlineRuleTest.kt
@@ -11,7 +11,11 @@ class FinalNewlineRuleTest {
     @Test
     fun testLint() {
         // neither true nor false
-        assertThat(FinalNewlineRule().lint("fun name() {\n}")).isEmpty()
+        assertThat(FinalNewlineRule().lint("fun name() {\n}")).isEqualTo(
+            listOf(
+                LintError(1, 1, "final-newline", "File must end with a newline (\\n)")
+            )
+        )
         assertThat(FinalNewlineRule().lint("fun name() {\n}\n")).isEmpty()
         // true
         assertThat(