Git Product home page Git Product logo

ifacegen's Introduction

ifacegen

ifacegen is a code generation tool that generates interfaces from structs.

Usage

A go generate comment can be added to the struct:

package client

import (
	"context"
	"net/url"
)

//go:generate go run github.com/ChrisRx/ifacegen
type Client struct {
    ...
}


// ExportedMethod is an example method for Client that is exported.
func (c *Client) ExportedMethod(ctx context.Context, u *url.URL) (string, error) {
    ...
}

func (c *Client) unExportedMethod() error {
    ...
}

and a file will be produced in the same package named zz_Client.iface.go containing the generated interface:

// Code generated by ifacegen. DO NOT EDIT.

package client

import (
	"context"
	"net/url"
)

type Interface interface {
	// ExportedMethod is an example method for Client that is exported.
	ExportedMethod(ctx context.Context, u *url.URL) (string, error)
}

ifacegen will determine the target struct based upon where in the code the go generate comment is placed.

Flags can be used specify the target struct (--struct-name) or the generated interface name (--iface):

//go:generate go run github.com/ChrisRx/ifacegen --struct-name client -iface Client

ifacegen's People

Contributors

chrisrx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.