CodeScout is a Go package and CLI tool for analyzing and extracting structured representations of functions, methods, and structs from Go source files.
Returns the first function matching the configuration in the provided file path.
Returns all matching functions based on the configuration.
Returns the first struct matching the configuration in the given file path.
Returns all structs matching the provided configuration.
Returns the first method matching the configuration.
Returns all methods that match the given configuration.
Defines filters for scouting functions including:
- Name
- Parameter and return types
- Match options:
Exact,NoParams,NoReturn
Used to find specific methods, with support for:
- Receiver type
- Pointer receiver flag
- Accessed fields and called methods
- Match options:
Exact,NoParams,NoReturn,NoFields,NoMethods
Defines search criteria for structs:
- Field name and type matches
ExactandNoFieldsoptions
CodeScout also offers a full-featured CLI using Cobra.
codescout func [path] [flags]--name,-n: Function name--params,-p: Function parameters--return,-r: Return types--no-params,-s: Expect no parameters--no-return,-u: Expect no return values--exact,-x: Match criteria exactly--output,-o: Output format (definition,body,signature, etc.)
codescout method [path] [flags]--name,-n: Method name--receiver,-m: Receiver type--pointer,-t: Whether it's a pointer receiver--fields,-f: Fields accessed--methods,-c: Methods called--no-fields,-d: Must not access struct fields--no-methods,-e: Must not call struct methods- All function flags also apply
codescout struct [path] [flags]--name,-n: Struct name--fields,-f: Fields to match--no-fields,-s: Struct must have no fields--exact,-x: Match fields exactly--output,-o: Output format (definition,body, etc.)
All commands support the --verbose, -v flag to list all matches instead of just the first.
codescout func ./example.go -name=SomeFunc -params=input:string -return=error -output=signaturego get github.com/galactixx/codescout@latestThen import in your Go code:
import "github.com/galactixx/codescout"go install github.com/galactixx/codescout/cmd/codescout@latestThen run:
codescout- Support for scouting interfaces and their methods.
- Ability to search for structs that implement specific interfaces via MethodConfig matching.
- Color-coded Go syntax highlighting in CLI output.
- Smart path resolution and recursive file scanning.
- Integration with gopls for enhanced analysis.
This project is licensed under the MIT License. See the LICENSE file for more details.
If you have any questions or need support, feel free to reach out by opening an issue on the GitHub repository.