Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gqlgo/gqlanalysis
gqlanalysis makes easy to develop static analysis tools for GraphQL in Go.
https://github.com/gqlgo/gqlanalysis
golang graphql static-analysis
Last synced: 13 days ago
JSON representation
gqlanalysis makes easy to develop static analysis tools for GraphQL in Go.
- Host: GitHub
- URL: https://github.com/gqlgo/gqlanalysis
- Owner: gqlgo
- License: mit
- Created: 2021-04-07T14:58:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T07:31:52.000Z (3 months ago)
- Last Synced: 2024-08-23T08:44:10.157Z (3 months ago)
- Topics: golang, graphql, static-analysis
- Language: Go
- Homepage:
- Size: 98.6 KB
- Stars: 44
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gqlanalysis
[![pkg.go.dev][gopkg-badge]][gopkg]
`gqlanalysis` defines the interface between a modular static analysis for GraphQL in Go.
`gqlanalysis` is inspired by [go/analysis](https://golang.org/x/tools/go/analysis).
`gqlanalysis` makes easy to develop static analysis tools for GraphQL in Go.
## How to use
### Analyzer
The primary type in the API is Analyzer.
An Analyzer statically describes an analysis function: its name, documentation, flags, relationship to other analyzers, and of course, its logic.
```go
package lackid
var Analyzer = &gqlanalysis.Analyzer{
Name: "lackid",
Doc: "lackid finds a selection for a type which has id field but the selection does not have id",
Run: run,
...
}
func run(pass *gqlanalysis.Pass) (interface{}, error) {
...
}
```
### Driver
An analysis driver is a program that runs a set of analyses and prints the diagnostics that they report.
The driver program must import the list of Analyzers it needs.
A typical driver can be created with multichecker package.
```go
package main
import (
"github.com/gqlgo/gqlanalysis/multichecker"
"github.com/gqlgo/lackid"
"github.com/gqlgo/myanalyzer"
)
func main() {
multichecker.Main(
lackid.Analyzer,
myanalyzer.Analyzer,
)
}
```
### Pass
A Pass describes a single unit of work: the application of a particular Analyzer to given GraphQL's schema and query files.
The Pass provides information to the Analyzer's Run function about schemas and queries being analyzed, and provides operations to the Run function for reporting diagnostics and other information back to the driver.
```go
type Pass struct {
Analyzer *Analyzer
Schema *ast.Schema
Queries []*ast.QueryDocument
Comments []*Comment
Report func(*Diagnostic)
ResultOf map[*Analyzer]interface{}
}
```
### Diagnostic
A Diagnostic is a message associated with a source location.
Pass can report a diagnostic via Report field or Reportf method.
```go
type Diagnostic struct {
Pos *ast.Position
Message string
}
```
## Implementations of Analyzer
* [gqlgo/lackid](https://github.com/gqlgo/lackid) - Detect lack of id in GraphQL query
## Author
[](http://github.com/appify-technologies)
[gopkg]: https://pkg.go.dev/github.com/gqlgo/gqlanalysis
[gopkg-badge]: https://pkg.go.dev/badge/github.com/gqlgo/gqlanalysis?status.svg