automigration quide

Author: lainio

scripts/README.md

@@ -29,13 +29,18 @@ checking, which makes this so important but difficult. The `err2` package writes
 problems to `stderr` because it cannot panic in middle of the panicking. Note.
 This is only a legacy code problem. We are migration as you see :-)
 
+#### Manual v0.9.40 Migration With Location List (nvim/vim)
+
 Follow these steps check do you have migration needs for v0.9.40:
 1. [Set up Migration Environment](#set-up-migration-environment)
-1. Execute following command:
+1. Execute following command in your repo's root directory:
    ```shell
-   migr-name.sh todo_handle_func todo_catch_func
+   migr-name.sh -ndv todo_handle_func todo_catch_func
    ```
 
+*Tip. If your repo is large and you have many migration changes see the next
+[semi-automatic guide](#semi-automatic-v0.9.40-migration).*
+
 *Tip. You can execute that command from e.g. nvim/vim and you get your fix list.*
 ```shell
 migr-name.sh todo_handle_func todo_catch_func > todo_list
@@ -46,10 +51,20 @@ nvim -q todo_list
 nvim -q <(migr-name.sh todo_handle_func todo_catch_func)
 ```
 
-**Note. We are still in middle to process check if we can make this migration
-automatic, at least semi-automatic. Probably we cannot do the same as with
-others because the error value setting isn't closure anymore where we can refer
-the `err` return variable directly.**
+#### Semi-Automatic v0.9.40 Migration
+
+Follow these steps:
+1. [Set up Migration Environment](#set-up-migration-environment)
+1. Make sure that you haven't uncommitted changes in your repo and that you are
+   in the branch where you want to make the changes.
+1. Execute following command in your repo's root directory:
+   ```shell
+   migr-name.sh -ndv repl_handle_func repl_catch_func
+   ```
+1. Then continue with `build`, `test`, `lint`, etc. **And don't stop yet.**
+1. Use `git diff` or similar to skimming that all changes seem to be OK. Here
+   you have an opportunity to start use new features of `err2` like logging.
+1. You are ready to commit changes.
 
 ### `assert.SetDefaultAsserter` -> `assert.SetDefault` and others in v0.9.1
 

scripts/functions.sh

@@ -353,8 +353,8 @@ clean() {
 
 search_0_multi='(^\s*)(err)( :?= )((.|\n)*?)(\n)(\s*try\.To\(err\))' 
 search_1_multi='(^\s*[\w\.]*)(, err)( :?= )([\s\S]*?)(\n)(\s*try\.To\(err\))'
-search_2_multi="(^\s*[\w\.]*, [\w\.]*)(, err)( :?= )([\s\S]*?)(\n)(\s*try\.To\(err\))"
-search_3_multi="(^\s*[\w\.]*, [\w\.]*, [\w\.]*)(, err)( :?= )([\s\S]*?)(\n)(\s*try\.To\(err\))"
+search_2_multi='(^\s*[\w\.]*, [\w\.]*)(, err)( :?= )([\s\S]*?)(\n)(\s*try\.To\(err\))'
+search_3_multi='(^\s*[\w\.]*, [\w\.]*, [\w\.]*)(, err)( :?= )([\s\S]*?)(\n)(\s*try\.To\(err\))'
 
 # other tested versions, left here for debugging purposes
 #search_2_multi="(^\s*\w*, \w*)(, err)( :?= )([\s\S]*?)(\n)(\s*try\.To\(err\))"
@@ -460,14 +460,28 @@ todo_assert() {
 	ag 'assert\.[DP]+\.'
 }
 
+search_handle_multi='(^\s*)(defer err2\.Handle\(&err, func\(\) \{)([\s\S]*?)(^\s*\}\)$)'
+
 todo_handle_func() {
-	dlog "searching old error handlers"
-	ag 'err2\.Handle\(&err, func\(\)'
+	vlog "searching old error Handlers"
+	ag "$search_handle_multi"
+}
+
+repl_handle_func() {
+	vlog "replacing old error Handlers"
+	check_commit "$search_handle_multi" '\1defer err2.Handle(&err, func(err error) error {\3\1\treturn err\n\1})'
 }
 
+search_catch_multi='(^\s*)(defer err2\.Catch\(func\(err error\) \{)([\s\S]*?)(^\s*\}\)$)'
+
 todo_catch_func() {
-	dlog "searching old error handlers"
-	ag 'err2\.Catch\(func\(err error\) \{'
+	vlog "searching old error Catchers"
+	ag "$search_catch_multi"
+}
+
+repl_catch_func() {
+	vlog "replacing old error Catchers"
+	check_commit "$search_catch_multi" '\1defer err2.Catch(err2.Err(func(err error) {\3\1}))'
 }
 
 lint() {

try/notfound_test.go

@@ -28,9 +28,9 @@ func ExampleIsNotFound1() {
 	err2.SetErrorTracer(nil)
 
 	find := func(key int) string {
-		defer err2.Catch(func(err error) {
+		defer err2.Catch(err2.Err(func(err error) {
 			fmt.Println("ERROR:", err)
-		})
+		}))
 		notFound, value := try.IsNotFound1(FindObject(key))
 		if notFound {
 			return fmt.Sprintf("cannot find key (%d)", key)