add tip for the JSON output

[madneal]

This PR provides a tip when output as JSON due to the current default pretty-print flag

Current Issue

For the orginal json flag provided by checker.go, it's impossible to get analysisflags.JSON from nilaway. There is a conflict bettwen the pretty-print and json output currently due to the code

nilaway/nilaway.go

Line 43 in e902884

if conf.PrettyPrint {

.
As the default conf.PrettyPrint is true, so the output will be messy when try to output as json.

[sonalmahajan15]

Awesome, we had missed realizing this problem. Thanks for helping us improve the documentation!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.60%. Comparing base (56f5ac5) to head (ae7824b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #266   +/-   ##
=======================================
  Coverage   87.60%   87.60%           
=======================================
  Files          63       63           
  Lines        7916     7916           
=======================================
  Hits         6935     6935           
  Misses        799      799           
  Partials      182      182           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[madneal]

@sonalmahajan15 seems some issue with the golden test

[sonalmahajan15]

@madneal , yes, something seems to be wrong. We'll look into it and merge the PR.

[yuxincs]

Yeah, I think we'll have to wait for golang/go#61324 to have an importable checker API to use.

[yuxincs]

I'm updating your branch since we recently fixed the CI issue, and we'll need those changes in order for CI to pass :)

[github-actions]

Golden Test

Note

✅ NilAway errors reported on standard libraries are identical.

3271 errors on base branch (main, 56f5ac5)
3271 errors on test branch (a747e8e)

[yuxincs]

Thanks @madneal for the contributions!