Remove init requirement & syntax sugar from Withable by Jeehut · Pull Request #50 · FlineDev/HandySwift

Jeehut · 2020-06-20T13:23:02Z

Fixes #49.

Proposed Changes

Remove the init() requirement from Withable.
Remove the init syntax sugar method that allowed Foo { $0.bar = 5} in favor of Foo().with { $0.bar = 5}.
Adds support for Foo(bar: 5).with { $0.otherProperty = true } without requiring init() on Foo type.

Jeehut · 2020-06-20T14:16:21Z

Here is an overview of what got changed by this pull request:

Issues
======
- Added 50

See the complete overview on Codacy

Jeehut · 2020-06-20T14:16:38Z

+        excludeFilters: [testFiles],
+        autoCorrectReplacement: #"{ $1 in"#,
+        autoCorrectExamples: [
+            ["before": "run { (a) in", "after": "run { a in"],


Codacy found an issue: Don't use parantheses around non-typed parameters in a closure.

Jeehut · 2020-06-20T14:16:40Z

+        autoCorrectExamples: [
+            ["before": "run { (a) in", "after": "run { a in"],
+            ["before": "run { (a, b) in", "after": "run { a, b in"],
+            ["before": "run { (a, b, c) in", "after": "run { a, b, c in"]


Codacy found an issue: Multi-line collection literals should have trailing commas.

Jeehut · 2020-06-20T14:16:41Z

+        excludeFilters: [testFiles],
+        autoCorrectReplacement: "$callPart1!.$callPart2!.$callPart3",
+        autoCorrectExamples: [
+            ["before": "let x = (viewModel?.profile?.imagePath)!\n", "after": "let x = viewModel!.profile!.imagePath\n"]


Codacy found an issue: Don't use ? first to force unwrap later ? directly unwrap within the parantheses.

Jeehut · 2020-06-20T14:16:42Z

+        excludeFilters: [testFiles],
+        autoCorrectReplacement: "$callPart1!.$callPart2!.$callPart3!.$callPart4",
+        autoCorrectExamples: [
+            ["before": "let x = (viewModel?.user?.profile?.imagePath)!\n", "after": "let x = viewModel!.user!.profile!.imagePath\n"]


Codacy found an issue: Multi-line collection literals should have trailing commas.

Jeehut · 2020-06-20T14:16:42Z

+    // MARK: EmptyTodo
+    try Lint.checkFileContents(
+        checkInfo: "EmptyTodo: `// TODO:` comments should not be empty.",
+        regex: #"// TODO: ?(\[[\d\-_a-z]+\])? *\n"#,


Codacy found an issue: All TODOs should have a format with creator credentials & date of their creation documented like this: // TODO: [cg_YYYY-MM-DD] .

Jeehut · 2020-06-20T14:16:43Z

+    try Lint.checkFileContents(
+        checkInfo: "SingleLineGuard: Use a single line guard for simple checks.",
+        regex: #"guard\s*([^\{]{2,80})\s+else\s*\{\s*\n\s*(return[^\n]{0,40}|continue|fatalError\([^\n;]+\))\s*\}"#,
+        matchingExamples: ["guard x else {\n  return\n}", "guard x else {\n  return 2 * x.squared(x: {15})\n}", #"guard x else {\#n  fatalError("some message: \(x)")\#n}"#],


Codacy found an issue: Line should be 160 characters or less: currently 173 characters

Jeehut · 2020-06-20T14:16:44Z

+            "callPart3": #"[^\s\?\.]+"#,
+            "separator3": #"\?\."#,
+            "callPart4": #"[^\s\?\.]+"#,
+            "closingBraceUnwrap": #"\)!"#


Codacy found an issue: Multi-line collection literals should have trailing commas.

Jeehut · 2020-06-20T14:16:45Z

+            ["before": "init(\n    x: Int,\n    y: Int\n) {\n    \n}", "after": "init(\n    x: Int,\n    y: Int\n) {}"],
+            ["before": "func foo2bar()  { }", "after": "func foo2bar() {}"],
+            ["before": "func foo2bar(x: Int, y: Int)  { }", "after": "func foo2bar(x: Int, y: Int) {}"],
+            ["before": "func foo2bar()\n{\n    \n}", "after": "func foo2bar() {}"],


Codacy found an issue: Don't keep empty methods in code without commenting inside why they are needed or a // TODO: not yet implemented.

Jeehut · 2020-06-20T14:16:46Z

+    try Lint.checkFileContents(
+        checkInfo: "EmptyTodo: `// TODO:` comments should not be empty.",
+        regex: #"// TODO: ?(\[[\d\-_a-z]+\])? *\n"#,
+        matchingExamples: ["// TODO:\n", "// TODO: [2020-03-19]\n", "// TODO: [cg_2020-03-19]  \n"],


Codacy found an issue: All TODOs should have a format with creator credentials & date of their creation documented like this: // TODO: [cg_YYYY-MM-DD] .

Jeehut · 2020-06-20T14:16:47Z

+                    {
+                        dataExporterHelper.exportData(
+                """
+            ]


Codacy found an issue: Multi-line collection literals should have trailing commas.

Jeehut · 2020-06-20T14:16:48Z

@@ -0,0 +1,547 @@
+#!/usr/local/bin/swift-sh
+import AnyLint // @Flinesoft ~> 0.8.2


Codacy found an issue: Header comments should be consistent with project patterns.

Jeehut · 2020-06-20T14:16:48Z

+        checkInfo: "SingleLineGuard: Use a single line guard for simple checks.",
+        regex: #"guard\s*([^\{]{2,80})\s+else\s*\{\s*\n\s*(return[^\n]{0,40}|continue|fatalError\([^\n;]+\))\s*\}"#,
+        matchingExamples: ["guard x else {\n  return\n}", "guard x else {\n  return 2 * x.squared(x: {15})\n}", #"guard x else {\#n  fatalError("some message: \(x)")\#n}"#],
+        nonMatchingExamples: ["guard x else { return }", "guard x else { return 2 * x.squared(x: {15}) }", #"guard x else { fatalError("some message: \(x)") }"#],


Codacy found an issue: Line should be 160 characters or less: currently 162 characters

Jeehut · 2020-06-20T14:16:49Z

+
+    // MARK: IfAsGuard
+    try Lint.checkFileContents(
+        checkInfo: "IfAsGuard: Don't use an if statement to just return – use guard for such cases instead.",


Codacy found an issue: Always start a multiline guard via guard then a line break and all expressions indented.

Jeehut · 2020-06-20T14:16:50Z

+        excludeFilters: [testFiles],
+        autoCorrectReplacement: "$callPart1!.$callPart2",
+        autoCorrectExamples: [
+            ["before": "call(x: (viewModel?.username)!)", "after": "call(x: viewModel!.username)"]


Codacy found an issue: Multi-line collection literals should have trailing commas.

Jeehut · 2020-06-20T14:16:51Z

+            }
+            """,
+            """
+            guard let collection = viewModel.myCollection(),


Codacy found an issue: Always start a multiline guard via guard then a line break and all expressions indented.

Jeehut · 2020-06-20T14:16:52Z

+    try Lint.checkFileContents(
+        checkInfo: "NavigationControllerVariableNaming: Always name your navigation controller variables with the suffix `NavCtrl` or just `navCtrl`.",
+        regex: #"(var|let) +(nc|navigationcontroller|navc|ncontroller|navcontroller)[ :][^\n=]*=\i"#,
+        matchingExamples: ["let nc =", "var navigationController =", "let navc =", "let ncontroller =", "var nc: MyNavigationController =", "let navController: MyNavigationController<T> = "],


Codacy found an issue: Always name your view controller variables with the suffix ViewCtrl.

Jeehut · 2020-06-20T14:16:53Z

+    try Lint.checkFileContents(
+        checkInfo: "ClosureParamsParantheses: Don't use parantheses around non-typed parameters in a closure.",
+        regex: #"\{\s*\(((?!self)[^):]+)\)\s*in"#,
+        matchingExamples: ["run { (a) in", "run { (a, b) in", "run { (a, b, c) in"],


Codacy found an issue: Don't use parantheses around non-typed parameters in a closure.

Jeehut · 2020-06-20T14:16:53Z

+        regex: #"guard\s*([^\n]*,\n)+([^\n]*\S *)else\s*\{"#,
+        matchingExamples: [
+            """
+            guard


Codacy found an issue: Always close a multiline guard via else { on a new line indented like the opening guard.

Jeehut · 2020-06-20T14:16:54Z

+        excludeFilters: [testFiles],
+        autoCorrectReplacement: "$callPart1!.$callPart2",
+        autoCorrectExamples: [
+            ["before": "call(x: (viewModel?.username)!)", "after": "call(x: viewModel!.username)"]


Codacy found an issue: Don't use ? first to force unwrap later ? directly unwrap within the parantheses.

Jeehut · 2020-06-20T14:16:55Z

+            "callPart3": #"[^\s\?\.]+"#,
+            "closingBraceUnwrap": #"\)!"#
+        ],
+        matchingExamples: ["call(x: (viewModel?.profile?.username)!)"],


Codacy found an issue: Don't use ? first to force unwrap later ? directly unwrap within the parantheses.

Jeehut · 2020-06-20T14:16:56Z

+            "closingBraceUnwrap": #"\)!"#
+        ],
+        matchingExamples: ["call(x: (viewModel?.username)!)"],
+        nonMatchingExamples: ["call(x: (viewModel?.profile?.username)!)", "call(x: viewModel!.username)"],


Codacy found an issue: Don't use ? first to force unwrap later ? directly unwrap within the parantheses.

Jeehut · 2020-06-20T14:16:57Z

+            ["before": "init()\n{\n    \n}", "after": "init() {}"],
+            ["before": "init(\n    x: Int,\n    y: Int\n) {\n    \n}", "after": "init(\n    x: Int,\n    y: Int\n) {}"],
+            ["before": "func foo2bar()  { }", "after": "func foo2bar() {}"],
+            ["before": "func foo2bar(x: Int, y: Int)  { }", "after": "func foo2bar(x: Int, y: Int) {}"],


Codacy found an issue: Don't keep empty methods in code without commenting inside why they are needed or a // TODO: not yet implemented.

Jeehut · 2020-06-20T14:16:58Z

+        checkInfo: "EmptyTodo: `// TODO:` comments should not be empty.",
+        regex: #"// TODO: ?(\[[\d\-_a-z]+\])? *\n"#,
+        matchingExamples: ["// TODO:\n", "// TODO: [2020-03-19]\n", "// TODO: [cg_2020-03-19]  \n"],
+        nonMatchingExamples: ["// TODO: refactor", "// TODO: not yet implemented", "// TODO: [cg_2020-03-19] not yet implemented"],


Codacy found an issue: All TODOs should have a format with creator credentials & date of their creation documented like this: // TODO: [cg_YYYY-MM-DD] .

Jeehut · 2020-06-20T14:16:59Z

+
+    // MARK: SingleLineGuard
+    try Lint.checkFileContents(
+        checkInfo: "SingleLineGuard: Use a single line guard for simple checks.",


Codacy found an issue: Always start a multiline guard via guard then a line break and all expressions indented.

Jeehut · 2020-06-20T14:17:00Z

+            ],
+            [
+                "before": "param: callFunction(errorMessage != nil ? errorMessage! : L10n.Global.Info.success),\n",
+                "after": "param: callFunction(errorMessage ?? L10n.Global.Info.success),\n"


Codacy found an issue: Multi-line collection literals should have trailing commas.

Jeehut · 2020-06-20T14:19:24Z

@knothed What do you think of this? Since you implemented this in the first place, do you agree with my changes?

Jeehut added 6 commits June 20, 2020 15:20

Remove init requirement & syntax sugar from Withable

a9af9ed

Document changes of PR #50

f194611

Mark removed method as unavailable for easier migration

415bef8

Add basic GitHub Actions configuration

a86741d

Configure AnyLint checks & fix issues

8a454f1

Update badge to GitHub Actions

7eb55c7

Jeehut commented Jun 20, 2020

View reviewed changes

Jeehut merged commit eddbe17 into main Jun 20, 2020

Jeehut commented Jun 20, 2020

View reviewed changes

Jeehut deleted the wip/cg_withable branch June 20, 2020 14:16

Jeehut commented Jun 20, 2020

View reviewed changes

		@@ -0,0 +1,547 @@
		#!/usr/local/bin/swift-sh
		import AnyLint // @Flinesoft ~> 0.8.2

Uh oh!

Conversation

Jeehut commented Jun 20, 2020

Proposed Changes

Uh oh!

Jeehut commented Jun 20, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jeehut commented Jun 20, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant