feat: ignore next line keyword

This commit is contained in:
b1ek 2024-09-07 16:58:54 +10:00
parent 8cd4d4663a
commit 35ed194361
Signed by: blek
GPG Key ID: A622C22C9BC616B2
2 changed files with 26 additions and 1 deletions

View File

@ -18,6 +18,10 @@ tags
# You can add/ignore multiple commands at once: # You can add/ignore multiple commands at once:
#bshchk:add-cmd curl wget #bshchk:add-cmd curl wget
# To ignore next line:
#bshchk:ignore-next-line
curl # won't be checked
``` ```

View File

@ -6,13 +6,22 @@ import (
"mvdan.cc/sh/v3/syntax" "mvdan.cc/sh/v3/syntax"
) )
var ignored_lines = []uint{}
func get_ignored_and_deps(code string) ([]string, []string) { func get_ignored_and_deps(code string) ([]string, []string) {
// source: https://www.gnu.org/software/bash/manual/html_node/Bash-Builtins.html // source: https://www.gnu.org/software/bash/manual/html_node/Bash-Builtins.html
var ignored []string = []string{"alias", "bind", "builtin", "caller", "command", "declare", "echo", "enable", "let", "local", "logout", "mapfile", "printf", "read", "readarray", "source", "type", "typeset", "ulimit", "unalias"} var ignored []string = []string{"alias", "bind", "builtin", "caller", "command", "declare", "echo", "enable", "let", "local", "logout", "mapfile", "printf", "read", "readarray", "source", "type", "typeset", "ulimit", "unalias"}
var deps []string var deps []string
for _, line := range strings.Split(code, "\n") { for i, line := range strings.Split(code, "\n") {
splitted := strings.Split(line, " ") splitted := strings.Split(line, " ")
// comments w/ no arguments
if splitted[0] == "#bshchk:ignore-next-line" {
ignored_lines = append(ignored_lines, uint(i)+1)
}
// comments with arguments
if len(splitted) < 2 { if len(splitted) < 2 {
continue continue
} }
@ -27,6 +36,15 @@ func get_ignored_and_deps(code string) ([]string, []string) {
return ignored, deps return ignored, deps
} }
func is_line_ignored(line uint) bool {
for _, ignored := range ignored_lines {
if line == ignored {
return true
}
}
return false
}
func find(code string) ([]string, error) { func find(code string) ([]string, error) {
r := strings.NewReader(code) r := strings.NewReader(code)
f, err := syntax.NewParser().Parse(r, "") f, err := syntax.NewParser().Parse(r, "")
@ -50,6 +68,9 @@ func find(code string) ([]string, error) {
syntax.Walk(f, func(node syntax.Node) bool { syntax.Walk(f, func(node syntax.Node) bool {
switch x := node.(type) { switch x := node.(type) {
case *syntax.CallExpr: case *syntax.CallExpr:
if is_line_ignored(node.Pos().Line() - 1) {
return true
}
for i := range x.Args { for i := range x.Args {
for _, part := range x.Args[i].Parts { for _, part := range x.Args[i].Parts {
switch xx := part.(type) { switch xx := part.(type) {