GO STRUCTER

Generate structs from JSON definitions

Issues
•
Wiki
•
Examples

Overview

A JSON-to-struct generator for Go

Because sometimes you just have to generate a struct from json.

Installation

Requirements

• Go 1.11

Quick Start

Install structer using the installation script by executing the following command (execute in directory with write permissions):

curl https://s3.eu-central-1.amazonaws.com/structer/dist/structer_installer.sh | bash

The installer script is available for download here.

When installed, run the structer command from terminal:

structer

You should see the following output:

Structer is a tool for creating struct types from definitions stored as JSON.
Usage:
  structer [command]
Available Commands:
  help        Help about any command
  make        Makes a struct from JSON data.
Flags:
      --config string   config file (default is $HOME/.structer.yaml)
  -h, --help            help for structer
  -t, --toggle          Help message for toggle
Use "structer [command] --help" for more information about a command.

To get familiar with the main command, make, use the help option

structer help make

Makes a struct from JSON data.
Usage:
  structer make [flags]
Flags:
      --format string   the format of the input (default "json")
  -h, --help            help for make
      --in string       path to input file or directory
      --out string      path to output directory (default "generated")
Global Flags:
      --config string   config file (default is $HOME/.structer.yaml)

Use structer make providing the path to json file in the --in parameter:

structer make --in <PATH_TO_JSON_FILE>

TIP

For more examples visit the Examples directory.

Download Binaries

TIP

Download the latest release of structer for your platform.

• The fastest way to install is by downloading and running the installer script as shown in Quick Start
• You can download the src archive if you’d like to build this tool form source. See [Building From Source]
  (#building-from-source) for details.

Builds for other platforms available here.

Release 0.1.0

See release log for more information about the current and previous structer releases.

Building From Source

Either download the source package or clone this repository, cd into the directory where you have the source files, and execute:

make && make install

This will build and install the structer executable to your path.

That’s it. Now you can run:

structer

Makefile offers the following options:

# Start the build process, cross-building all supported platforms:
make
# Start the build process for the current platform:
make current
# Start the build process for a specific platform:
make platform darwin_amd64
# The publish option is reserved for project maintainers. 
# It will publish the distributable files to the build server 
# after a successful build.
make publish
# Make install assumes there's a build file waiting in the build 
# directory, and tries to move it to system path:
make install
# Downloads and installs the prebuilt binary for the current platform:
make web_install

Usage

Make sure you try the Quick Start guide first. See the examples directory for more examples.
Below is a very simple one:

structer
structer help
structer make --in <PATH_TO_JSON_FILE>

Running Tests

TIP

TBD

structer test run

Contributing

Contributions are welcome. Check Issues & Roadmap below to see how you can help with priority features, bugs,
tests or
docs.

Contribution guidelines are described in the Contributing document.

Issues and Roadmap

Issue tracker top:

STR-2 Enable (extendable) multiple input formats

STRU-3 TBD

Contact

Feel free to get in touch if you have a question or request in connection to this program or source repository.

Open, public communication is the prefered choice:

• Open an issue, or ask a question on wiki
• There’s a mailing list and a Google Group at structer.groups.nv3.eu

Private inquiries over email. Find emails in:

• contributors in CONTRIBUTORS.md for emails

License

Licensed under the Apache License, Version 2.0. See the LICENSE file distributed with this source code for the full text license agreement.