Summary

Update shellcheck for new tool support and better parsing.

Review Request #11576 — Created April 5, 2021 and submitted June 9, 2021, 1:07 a.m.

Information

Owner

chipx86

Repository

ReviewBot

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewbot

People

Description

This updates ShellCheckTool to subclass the newer BaseTool, and to
use the newer features it offers (dependencies, improved file pattern
support, central command building, new loggers, and new comment
options).

The list of file types and shebangs supported have been extended, based
on shellcheck's advertised capabilities.

The handling of shellcheck results has been improved. We now request
JSON output, and use that to convey column, error code, and severity
information.

The payload also provides suggested fixes, in the form of "replacement"
ranges. These are used to modify the referenced line(s) of code and
patch them up to provide a possible replacement line of code. The new
tool support will provide the resulting replacements in the comment, if
we're able to successfully apply them without any issues. This is
future-proofed to back out of the attempt if we see anything we don't
expect from shellcheck.

If anything goes wrong with parsing files or handling settings, the
resulting error is left as a comment on the file.

Testing Done

Unit tests passed on Python 2.7 and 3.x.

Commits

Summary	ID
Update shellcheck for new tool support and better parsing. This updates `ShellCheckTool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved file pattern support, central command building, new loggers, and new comment options). The list of file types and shebangs supported have been extended, based on shellcheck's advertised capabilities. The handling of shellcheck results has been improved. We now request JSON output, and use that to convey column, error code, and severity information. The payload also provides suggested fixes, in the form of "replacement" ranges. These are used to modify the referenced line(s) of code and patch them up to provide a possible replacement line of code. The new tool support will provide the resulting replacements in the comment, if we're able to successfully apply them without any issues. This is future-proofed to back out of the attempt if we see anything we don't expect from shellcheck. If anything goes wrong with parsing files or handling settings, the resulting error is left as a comment on the file.	2264c4462c76230cebfb5dd94dd38a712fd8aa18

Summary

Update shellcheck for new tool support and better parsing.

This updates `ShellCheckTool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved file pattern support, central command building, new loggers, and new comment options). The list of file types and shebangs supported have been extended, based on shellcheck's advertised capabilities. The handling of shellcheck results has been improved. We now request JSON output, and use that to convey column, error code, and severity information. The payload also provides suggested fixes, in the form of "replacement" ranges. These are used to modify the referenced line(s) of code and patch them up to provide a possible replacement line of code. The new tool support will provide the resulting replacements in the comment, if we're able to successfully apply them without any issues. This is future-proofed to back out of the attempt if we see anything we don't expect from shellcheck. If anything goes wrong with parsing files or handling settings, the resulting error is left as a comment on the file.

2264c4462c76230cebfb5dd94dd38a712fd8aa18

Issues

Description	From	Last Updated
Copy-pasteo: pyflakes -> shellcheck. Mind checking your other changes to make sure I didn't miss this in the things I've …	david	June 2, 2021, 6:26 p.m.

flake8 passed.

JSHint passed.

bot/reviewbot/tools/shellcheck.py (Diff revision 1)

Show all issues

Copy-pasteo: pyflakes -> shellcheck. Mind checking your other changes to make sure I didn't miss this in the things I've already reviewed?

Change Summary:

"pyflakes" -> "shellcheck" in the docstrings.

Commits:

	Summary	ID
	Update shellcheck for new tool support and better parsing. This updates `ShellCheckTool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved file pattern support, central command building, new loggers, and new comment options). The list of file types and shebangs supported have been extended, based on shellcheck's advertised capabilities. The handling of shellcheck results has been improved. We now request JSON output, and use that to convey column, error code, and severity information. The payload also provides suggested fixes, in the form of "replacement" ranges. These are used to modify the referenced line(s) of code and patch them up to provide a possible replacement line of code. The new tool support will provide the resulting replacements in the comment, if we're able to successfully apply them without any issues. This is future-proofed to back out of the attempt if we see anything we don't expect from shellcheck. If anything goes wrong with parsing files or handling settings, the resulting error is left as a comment on the file.	f769bd111d2ec0828580d41fe643aa086c1dc5c7
	Update shellcheck for new tool support and better parsing. This updates `ShellCheckTool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved file pattern support, central command building, new loggers, and new comment options). The list of file types and shebangs supported have been extended, based on shellcheck's advertised capabilities. The handling of shellcheck results has been improved. We now request JSON output, and use that to convey column, error code, and severity information. The payload also provides suggested fixes, in the form of "replacement" ranges. These are used to modify the referenced line(s) of code and patch them up to provide a possible replacement line of code. The new tool support will provide the resulting replacements in the comment, if we're able to successfully apply them without any issues. This is future-proofed to back out of the attempt if we see anything we don't expect from shellcheck. If anything goes wrong with parsing files or handling settings, the resulting error is left as a comment on the file.	2264c4462c76230cebfb5dd94dd38a712fd8aa18

Diff:

Revision 2 (+1528 -132)

Show changes

	bot/reviewbot/tools/shellcheck.py
	bot/reviewbot/tools/testing/testcases.py
	bot/reviewbot/tools/tests/test_shellcheck.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (20385c9)