Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typos and Homebrew name #56

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Some may think that I have too much faith in pure Go, but this is my honest feel
go get -u github.com/kyoh86/richgo
```

(homebrew):
(Homebrew):

```
brew install kyoh86/tap/richgo
Expand Down Expand Up @@ -165,7 +165,7 @@ passPackageStyle:
failPackageStyle:
# Same format as `buildStyle`

# A threashold of the coverage
# A threshold of the coverage
coverThreshold: (0-100)

# Style of the "Cover" lines with the coverage that is higher than coverThreshold.
Expand All @@ -187,46 +187,46 @@ leaveTestPrefix: (true | false)

Rich-Go separate the output-lines in following categories.

* Build:
* Build:
When the Go fails to build, it prints errors like this:

<pre><code># github.com/kyoh86/richgo/sample/buildfail
sample/buildfail/buildfail_test.go:6: t.Foo undefined (type testing.T has no field or method Foo)</code></pre>

* Start:
* Start:
In the top of test, Go prints that name like this:

<pre><code>=== RUN TestSampleOK/SubtestOK</code></pre>

* Pass:
When a test is successed, Go prints that name like this:
* Pass:
When a test is successful, Go prints that name like this:

<pre><code> ---PASS: TestSampleOK/SubtestOK</code></pre>

* Fail:
* Fail:
When a test is failed, Go prints that name like this:

<pre><code>--- FAIL: TestSampleNG (0.00s)
sample_ng_test.go:9: It's not OK... :(</code></pre>

* Skip:
* Skip:
If there is no test files in directory or a test is skipped, Go prints that path or the name like this:

<pre><code>--- SKIP: TestSampleSkip (0.00s)
sample_skip_test.go:6:
? github.com/kyoh86/richgo/sample/notest [no test files]</code></pre>

* PassPackage:
When tests in package are successed, Go prints just:
* PassPackage:
When tests in package are successful, Go prints just:

<pre><code>PASS</code></pre>

* Fail:
* Fail:
When a test in package are failed, Go prints just:

<pre><code>FAIL</code></pre>

* Cover:
* Cover:
If the coverage analysis is enabled, Go prints the coverage like this:

<pre><code>=== RUN TestCover05
Expand All @@ -235,7 +235,7 @@ PASS
coverage: 50.0% of statements
ok github.com/kyoh86/richgo/sample/cover05 0.012s coverage: 50.0% of statements</code></pre>

Each categories can be styled seperately.
Each category can be styled separately.

### Label types

Expand Down Expand Up @@ -310,7 +310,7 @@ RICHGO_FORCE_COLOR=1 richgo test ./... | tee test.log
## Configure to resolve a conflict with "Solarized dark" theme

The bright-black is used for background color in Solarized dark theme.
Richgo uses that color for "startStyle" and "skipStyle", so "START" and "SKIP" lines can not be seen on the screen with Solarized dark theme.
richgo uses that color for "startStyle" and "skipStyle", so "START" and "SKIP" lines can not be seen on the screen with Solarized dark theme.

To resolve that conflict, you can set another color for "startStyle" and "skipStyle" in [.richstyle](#configuration-file-paths) like below.

Expand Down
2 changes: 1 addition & 1 deletion editor/tty.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

const forceColorFlag = "RICHGO_FORCE_COLOR"

// Formattable judge whether a descriptor (like a os.Stdout, os.Stderr or *os.File...)
// Formattable judge whether a descriptor (like an os.Stdout, os.Stderr or *os.File...)
// is capable of colorization or not. The default behavior is to detect whether
// it is connected to a TTY, but may be overridden by setting the environment
// variable `RICHGO_FORCE_COLOR` to a non-empty value.
Expand Down