Merge pull request #30 from sonatard/fix-doc

update README for v0.2.0

Author: sonatard

README.md

@@ -2,14 +2,13 @@
 
 ![](https://github.com/sonatard/noctx/workflows/CI/badge.svg)
 
-`noctx` finds sending http request without context.Context.
+`noctx` finds function calls without context.Context.
 
-You should use `noctx` if sending http request in your library.
-Passing `context.Context` enables library user to cancel http request, getting trace information and so on.
+If you are using net/http package, you should use noctx.
+Passing `context.Context` enables library user to cancel request, getting trace information and so on.
 
 ## Usage
 
-
 ### noctx with go vet
 
 go vet is a Go standard tool for analyzing source code.
@@ -19,7 +18,7 @@ go vet is a Go standard tool for analyzing source code.
 $ go install github.com/sonatard/noctx/cmd/noctx@latest
 ```
 
-2. noctx execute
+2. Execute noctx
 ```sh
 $ go vet -vettool=`which noctx` main.go
 ./main.go:6:11: net/http.Get must not be called
@@ -46,40 +45,28 @@ linters:
    - xxx # Add unused linter to disable linters.
 ```
 
-3. noctx execute
+3. Execute noctx
 ```sh
 # Use .golangci.yml
 $ golangci-lint run
 
-# Only noctx execute
+# Only execute noctx
 golangci-lint run --enable-only noctx
 ```
 
-## Detection rules
+## net/http package
+### Detection rules
 
-- Executing following functions
-  - `net/http.Get`
-  - `net/http.Head`
-  - `net/http.Post`
-  - `net/http.PostForm`
-  - `(*net/http.Client).Get`
-  - `(*net/http.Client).Head`
-  - `(*net/http.Client).Post`
-  - `(*net/http.Client).PostForm`
-- `http.Request` returned by `http.NewRequest` function and passes it to other function.
+- Executing the following functions
+https://github.com/sonatard/noctx/blob/9a514098df3f8a88e0fd6949320c4e0aa51b520c/ngfunc/main.go#L15-L26
 
-## How to fix
+### How to fix
 
+- use `http.NewRequestWithContext` function instead of using `http.NewRequest` function.
 - Send http request using `(*http.Client).Do(*http.Request)` method.
-- In Go 1.13 and later, use `http.NewRequestWithContext` function instead of using `http.NewRequest` function.
-- In Go 1.12 and earlier, call `(http.Request).WithContext(ctx)` after `http.NewRequest`.
-
-`(http.Request).WithContext(ctx)` has a disadvantage of performance because it returns a copy of `http.Request`. Use `http.NewRequestWithContext` function if you only support Go1.13 or later.
-
 
 If your library already provides functions that don't accept context, you define a new function that accepts context and make the existing function a wrapper for a new function.
 
-
 ```go
 // Before fix code
 // Sending an HTTP request but not accepting context
@@ -106,7 +93,7 @@ func Send(body io.Reader) error {
 
 // Sending an HTTP request and accepting context
 func SendWithContext(ctx context.Context, body io.Reader) error {
-    // Change NewRequest to NewRequestWithContext and pass context it
+    // Change NewRequest to NewRequestWithContext and pass context to it
     req, err := http.NewRequestWithContext(ctx, http.MethodPost, "http://example.com", body)
     if err != nil {
         return err
@@ -120,56 +107,12 @@ func SendWithContext(ctx context.Context, body io.Reader) error {
 }
 ```
 
-## Detection sample
+### Detection sample
 
-```go
-package main
-
-import (
-	"context"
-	"net/http"
-)
-
-func main() {
-	const url = "http://example.com"
-	http.Get(url) // want `net/http\.Get must not be called`
-	http.Head(url)          // want `net/http\.Head must not be called`
-	http.Post(url, "", nil) // want `net/http\.Post must not be called`
-	http.PostForm(url, nil) // want `net/http\.PostForm must not be called`
-
-	cli := &http.Client{}
-	cli.Get(url) // want `\(\*net/http\.Client\)\.Get must not be called`
-	cli.Head(url)          // want `\(\*net/http\.Client\)\.Head must not be called`
-	cli.Post(url, "", nil) // want `\(\*net/http\.Client\)\.Post must not be called`
-	cli.PostForm(url, nil) // want `\(\*net/http\.Client\)\.PostForm must not be called`
-
-	req, _ := http.NewRequest(http.MethodPost, url, nil) // want `should rewrite http.NewRequestWithContext`
-	cli.Do(req)
-
-	ctx := context.Background()
-	req2, _ := http.NewRequestWithContext(ctx, http.MethodPost, url, nil) // OK
-	cli.Do(req2)
-
-	req3, _ := http.NewRequest(http.MethodPost, url, nil) // OK
-	req3 = req3.WithContext(ctx)
-	cli.Do(req3)
-
-	f2 := func(req *http.Request, ctx context.Context) *http.Request {
-		return req
-	}
-	req4, _ := http.NewRequest(http.MethodPost, url, nil) // want `should rewrite http.NewRequestWithContext`
-	req4 = f2(req4, ctx)
-	cli.Do(req4)
-
-	req5, _ := func() (*http.Request, error) {
-		return http.NewRequest(http.MethodPost, url, nil) // want `should rewrite http.NewRequestWithContext`
-	}()
-	cli.Do(req5)
-
-}
-```
+https://github.com/sonatard/noctx/blob/9a514098df3f8a88e0fd6949320c4e0aa51b520c/testdata/src/http_client/http_client.go#L11
+https://github.com/sonatard/noctx/blob/9a514098df3f8a88e0fd6949320c4e0aa51b520c/testdata/src/http_request/http_request.go#L17
 
-## Reference
+### Reference
 
 - [net/http - NewRequest](https://pkg.go.dev/net/http#NewRequest)
 - [net/http - NewRequestWithContext](https://pkg.go.dev/net/http#NewRequestWithContext)