Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
---
|
|
sidebar_position: 13
|
|
title: Cosmos Source Analysis (cosmosanalysis)
|
|
slug: /packages/cosmosanalysis
|
|
---
|
|
|
|
# Cosmos Source Analysis (cosmosanalysis)
|
|
|
|
The `cosmosanalysis` package provides static analysis helpers for Cosmos SDK-based projects, especially for app structure and interface/embed discovery.
|
|
|
|
For full API details, see the
|
|
[`cosmosanalysis` Go package documentation](https://pkg.go.dev/github.com/ignite/cli/v29/ignite/pkg/cosmosanalysis).
|
|
|
|
## When to use
|
|
|
|
- Validate that a directory is a Cosmos chain project before running codegen.
|
|
- Locate key app files and embedded types in Cosmos app sources.
|
|
- Detect interface implementations across module files.
|
|
|
|
## Key APIs
|
|
|
|
- `IsChainPath(path string) error`
|
|
- `FindAppFilePath(chainRoot string) (path string, err error)`
|
|
- `ValidateGoMod(module *modfile.File) error`
|
|
- `FindImplementation(modulePath string, interfaceList []string) (found []string, err error)`
|
|
- `DeepFindImplementation(modulePath string, interfaceList []string) (found []string, err error)`
|
|
- `FindEmbed(modulePath string, targetEmbeddedTypes []string) (found []string, err error)`
|
|
- `FindEmbedInFile(n ast.Node, targetEmbeddedTypes []string) (found []string)`
|
|
|
|
## Common Tasks
|
|
|
|
- Call `IsChainPath` early to fail fast on unsupported project layouts.
|
|
- Use `FindAppFilePath` before AST transformations that require the chain app entrypoint.
|
|
- Use `FindImplementation`/`DeepFindImplementation` to verify generated modules are wired as expected.
|
|
|
|
## Basic import
|
|
|
|
```go
|
|
import "github.com/ignite/cli/v29/ignite/pkg/cosmosanalysis"
|
|
```
|