✨ Never write toil/boilerplate go code again! ✨
Home Page: https://pkg.go.dev/github.com/Joffref/genz
License: Apache License 2.0
I'm Mathis Joffre, I'm 22 years old and I'm an apprentice engineer currently interested in Network, system administration, and software engineering.
No response
I want to be able to get comments of the Methods, the same as for Attributes.
TODO in code here
?
core feature of GenZ
to be able to read comments on methods
No response
No response
No response
I want to get the package name qualifier following the aliased name I gave in the parsed go input
A solution happened!
A reason happened!
An alternative happened!
An impact happened!
No response
The main idea is to be able to test the generated code against an expected output. Moreover, we should be able to test the behavior of templates against common scenarios, in order to prevent regression.
Let's define it together!
This could be a huge blocker for company-grade solutions wanting to use GenZ as they are not able to test templates to avoid regression.
No response
No response
We should be able to parse interfaces, and thus generate code from them, such as mock or anything else (just for examples).
Let's say we expose the following attributes :
string): Name of the interface[]string): List comments above the interface.[]Methods): Methods that express this interface.[]self): Interfaces that compose this interface. (Maybe optional for now)It might be a great asset to differentiate from other tools.
No response
We cannot generate a Type with the same name as the parsed type because of name overlapping.
Ex.
package main
type Human struct {
//+required
Firstname string
//+required
Lastname string
Age uint
}Template
package main
type {{ .Type.InternalName }}) struct {}
if you want genz tests, you will have both human.go and expected.go in the same package, with the name Human overlapping
Quickfix https://github.com/Joffref/genz/tree/expected-in-dir
No response
to discuss
blocker for some cases
No response
[Bug]: Unable to create issues for features/enhancements
beta
No response
No response
No response
No response
No response
README has to explain the tool's installation, design, and usage.
No response
That's the first impression our tool is giving to people.
No response
Huge I hope <3
No response
Be able to specify, an HTTP URL instead of a path for a template.
Parse template argument to check if it starts https://. If it is true, let's download it in tmp dir and run genz with this template.
No response
No response
No response
No response
Parse type methods into parser.Method struct
No response
No response
No response
No response
No response
At the moment GenZ uses a template to render go code. GenZ workflow could be described as follows:
flowchart LR
parser[Parse Go code] ---> object[GenZ parsed element]
generator[GenZ generator] --->|Consume|object
generator --->|Inject ParsedElement|Template
Template --->|Generate| code[Go code]
There are some caveats with this approach:
On viable solution could be to expose a fluent API, to write Go code with Go code. It ensures syntax consistency, flexibility, and hardened testing.
// ...
Code(buffer, "name").
WithHeader("My Header").
WithHeaders([]string{"line 1", "line 2"}).
WithImport("test").
WithImports([]string{"hello", "world"}).
WithNamedImport("b", "bob")
WithNamedImports(map[string]string{
"t": "toto"
}).Generate()
// ...// My Header
// line 1
// line 2
package name
import (
"test"
"hello"
"world"
b "bob"
t "toto"
)A declaration is defined as the following interface:
type Declaration interface {
Generate() string
}// ...
Code(buffer, "name").
WithDeclaration(MyDeclaration).
WithDeclarations([]Declaration{MyDeclarationOne, MyDeclarationTwo}).
Generate()
// ...// ...
FuncDecl("HelloWorld").
WithDoc("HelloWorld does blabla").
WithReceiver("m", "MyReceiver", true).
WithParameter("name", "string").
WithParamaters(map[string]string{
"world": "string",
"n": "int"
}).
WithReturn("string").
WithReturns([]string{"int", "error"}).
WithBody(`return "", 0, nil`).
Generate()
// ...// HelloWorld does blabla
func (m *MyReceiver) HelloWorld(name string, world string, n int) (string, int, error) {
return "", 0, nil
}// ...
StructDecl("MyStruct").
WithDoc("A comment").
WithAttribute("integer" "int", "json:int").
WithAttributes(??).
Generate()
// ...// A comment
type MyStruct struct {
integer int `json: int`
hello func() string
}A reason happened!
An alternative happened!
An impact happened!
No response
See #22
beta
No response
No response
No response
No response
GenZ should be able to parse struct tags. For instance:
type Human struct {
name string `json: name`
}name in this struct should be retrieved using this syntax (or equivalent): .Attributes[0].Tags["json"]
No response
Actual output when running genz tests (via make test-examples) doesn't give information about the context on failure.
▶ genz(refacto-generator-to-parse-1-type-only) $ make test-examples
genz test -directory ./examples/ -v
genz: genz test ./examples/
running test in examples/1_validator/test
genz: generating template for type Human
genz: generated buffer (716 bytes)
genz: gofmt-ing buffer
genz: wrote human_validator.gen.go (580 bytes)
running test in examples/2_getters/test
genz: generating template for type Car
genz: generated buffer (142 bytes)
genz: gofmt-ing buffer
genz: wrote car.gen.go (122 bytes)
? github.com/Joffref/genz/examples/2_getters/test [no test files]
running test in examples/3_tests/tests/0_no_getter
genz: generating template for type Car
genz: generated buffer (19 bytes)
genz: gofmt-ing buffer
genz: wrote car.gen.go (13 bytes)
? github.com/Joffref/genz/examples/3_tests/tests/0_no_getter [no test files]
running test in examples/3_tests/tests/1_1_getter
genz: generating template for type Car
genz: generated buffer (75 bytes)
genz: gofmt-ing buffer
genz: wrote car.gen.go (66 bytes)
=== RUN TestCarGetModel
--- PASS: TestCarGetModel (0.00s)
PASS
ok github.com/Joffref/genz/examples/3_tests/tests/1_1_getter (cached)
genz: Difference between expected.go and generated file:
[]uint8(
"""
... // 22 identical lines
// WORK IN PROGRESS
- // map[_0:+>18 _1:<99]
+ // map[_0:+>18 _1:<99]
return nil
... // 2 identical lines
"""
)
make: *** [Makefile:23: test-examples] Error 1
I guess we can have a best output to read the results
PASS at the end of unit tests execution even with a failure is a bit tricky because we could understand everything went well, (or is that me ?)genz: Difference between expected.go and generated file: but there is no information about the concerned directory or test name (I suggest to print the directory and the test name)Because currently it's hard to determine where a test did not match
no idea
No response
No response
There is no documentation on parsed attributes.
No response
No response
No response
No response
No response
I want to be able to express the zero value behind a Type
No response
No response
No response
No response
No response
Exemple
type Car struct {
tires []Tire
}
type Tire struct{}Will have it's tires .Type value equal to github.com/Joffref/genz/examples/getters/test.Tire in template
We only want "Tire".
beta
No response
No response
No response
parser.go
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.