kjuulh/moq
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Update installation cmd on README for go1.16+ (#147)

Browse Source
This commit is contained in:
uji 2021-06-25 16:31:29 +09:00 committed by GitHub
parent 126389e52f
commit e7d0d3b298
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -14,11 +14,20 @@ You can read more in the [Meet Moq blog post](http://bit.ly/meetmoq).
### Installing ### Installing
To start using Moq, just run go get: To start using latest released version of Moq, just run:
#### Go version < 1.16
``` ```
$ go get github.com/matryer/moq $ go get github.com/matryer/moq
``` ```
#### Go 1.16+
```
$ go install github.com/matryer/moq@latest
```
### Usage ### Usage
``` ```
@ -32,7 +41,7 @@ moq [flags] source-dir interface [interface2 [interface3 [...]]]
-stub -stub
return zero values when no mock implementation is provided, do not panic return zero values when no mock implementation is provided, do not panic
-skip-ensure -skip-ensure
suppress mock implementation check, avoid import cycle if mocks suppress mock implementation check, avoid import cycle if mocks
generated outside of the tested package generated outside of the tested package
Specifying an alias for the mock is also supported with the format 'interface:alias' Specifying an alias for the mock is also supported with the format 'interface:alias'
@ -40,7 +49,7 @@ Specifying an alias for the mock is also supported with the format 'interface:al
Example: moq -pkg different . MyInterface:MyMock Example: moq -pkg different . MyInterface:MyMock
``` ```
**NOTE:** `source-dir` is the directory where the source code (definition) of the target interface is located. **NOTE:** `source-dir` is the directory where the source code (definition) of the target interface is located.
It needs to be a path to a directory and not the import statement for a Go package. It needs to be a path to a directory and not the import statement for a Go package.
In a command line: In a command line:
@ -112,9 +121,9 @@ The mocked structure implements the interface, where each method calls the assoc
* Use closured variables inside your test function to capture details about the calls to the methods * Use closured variables inside your test function to capture details about the calls to the methods
* Use `.MethodCalls()` to track the calls * Use `.MethodCalls()` to track the calls
* Use `go:generate` to invoke the `moq` command * Use `go:generate` to invoke the `moq` command
* If Moq fails with a `go/format` error, it indicates the generated code was not valid. * If Moq fails with a `go/format` error, it indicates the generated code was not valid.
You can run the same command with `-fmt noop` to print the generated source code without attempting to format it. You can run the same command with `-fmt noop` to print the generated source code without attempting to format it.
This can aid in debugging the root cause. This can aid in debugging the root cause.
## License ## License