# go-symbols

**Repository Path**: felix_huang/go-symbols

## Basic Information

- **Project Name**: go-symbols
- **Description**: A utility for extracting a JSON representation of the package symbols from a go source tree.
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-01-03
- **Last Updated**: 2021-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Go Symbols

A utility for extracting a JSON representation of the package symbols from a go source tree.

If a directory named src is under the directory given that directory will be walked for source code,
otherwise the entire tree will be walked.

# Installing

```
go get -u github.com/newhook/go-symbols
```

# Using

```
> go-symbols /Users/matthew/go foo
```

# Schema

```
go
type symbol struct {
	Name      string `json:"name"`
	Kind      string `json:"kind"`
	Package   string `json:"package"`
	Path      string `json:"path"`
	Line      int    `json:"line"`
	Character int    `json:"character"`
}
```