edit

go
Copy
func edit(match string) string

edit will perform an in-place edit on the match string according to the provided parameters.

regex

Replace the provided regex pattern with the given string.

yaml
Copy
extends: existence
message: Consider removing '%s'
level: warning
action:
  name: edit
  params:
    - regex
    - '([A-Z]\w+)([A-Z]\w+)' # pattern
    - '$1-$2' # repl
tokens:
  - '([A-Z]\w+)([A-Z]\w+)'

This is equivalent to the following Go code:

go
Copy
match = pattern.ReplaceAllString(match, repl)

trim_right

Trim the first parameter from the end of the matched text.

yaml
Copy
extends: existence
message: "Don't use exclamation points in text."
nonword: true
action:
  name: edit
  params:
    - trim_right
    - '!'
tokens:
  - '\w+!(?:s|$)'

trim_left

Trim the first parameter from the start of the matched text.

yaml
Copy
extends: existence
message: "'%s' too many spaces."
level: warning
nonword: true
action:
  name: edit
  params:
    - trim_left
    - ' '
tokens:
  - '(?<=[a-z][.!?] ) [A-Z]'