From c321c54179e3a044bc81accc0fd3e4f49a927162 Mon Sep 17 00:00:00 2001 From: "Iskander (Alex) Sharipov" Date: Wed, 22 Dec 2021 18:27:18 +0300 Subject: [PATCH] all: update gogrep links, we're using a different gogrep now (#320) --- README.md | 2 +- _docs/dsl.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d0e2373..b269395c 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,6 @@ Note: `go-critic` embeds the rules using the IR precompilation feature. ## Extra references * Online ruleguard playground: [go-ruleguard.github.io/play](https://go-ruleguard.github.io/play) -* [gogrep](https://github.com/mvdan/gogrep) - underlying AST matching engine +* [gogrep](https://github.com/quasilyte/gogrep) - underlying AST matching engine * [NoVerify: Dynamic Rules for Static Analysis](https://medium.com/@vktech/noverify-dynamic-rules-for-static-analysis-8f42859e9253) * [Ruleguard comparison with Semgrep and CodeQL](https://speakerdeck.com/quasilyte/ruleguard-vs-semgrep-vs-codeql) diff --git a/_docs/dsl.md b/_docs/dsl.md index f4ed0b36..a09cd364 100644 --- a/_docs/dsl.md +++ b/_docs/dsl.md @@ -30,7 +30,7 @@ Every **matcher function** accepts exactly 1 argument, a [`dsl.Matcher`](https:/ Every **rule** definition starts with a [`Match()`](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl#Matcher.Match) or [`MatchComment()`](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl#Matcher.MatchComment) method call. -* For `Match()`, you specify one or more [AST patterns](https://github.com/mvdan/gogrep) that should represent what kind of Go code a rule is supposed to match. +* For `Match()`, you specify one or more [AST patterns](https://github.com/quasilyte/gogrep) that should represent what kind of Go code a rule is supposed to match. * For `MatchComment()`, you provide one or more regular expressions that should match a comment of interest. Another mandatory part is [`Report()`](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl#Matcher.Report) or [`Suggest()`](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl#Matcher.Suggest) that describe a rule match action. `Report()` will print a warning message while `Suggest()` can be used to provide a quickfix action (a syntax rewrite pattern).