1 unstable release
0.0.2 | Jan 26, 2022 |
---|---|
0.0.1 |
|
#1955 in Development tools
160KB
3.5K
SLoC
CodeGenR
Installation
Install Rust : https://www.rust-lang.org/tools/install.
And then install codegenr
cargo install codegenr
or install the development version
cargo install --git https://github.com/eventuallyconsultant/codegenr --branch dev
Documentation
codegenr documentation on docs.rs
The defaults Handlebars helpers are documented here.
Contribute
You can also open the repository in GitPod with this button
In the command line you can :
cargo test --workspace
to launch all the unit testscargo doc --open
to compile and open the local documentation
Some command lines
cargo doc --open
compile and open the documentationcargo install --path codegenr
installs codegenr command line from sourcescargo install --git https://github.com/eventuallyconsultant/codegenr --branch dev
installs codegenr command line from the latest githubdev
branch
Legacy
This tool is based on the design of a precedent one written in C#
: CodegenUP.
Roadmap :
-
Load a yaml or json to serde::json
-
Resolve
$ref
tags -
Pass all the resulting document to an handlebar template
-
Implement some default helper (and make some doc tests about them)
-
A plugin system
-
Migrate C# custom helpers to this new plugin system
-
A this point, we could use
codegenr
in place ofCodegenUP
, just by calling some commands -
Rename
codegenr-cli
tocodegenr
&codegenr
tocodegenr-lib
-
Publish on
crates.io
-
Be able to have a
codegenr.toml
on a workspace root to describe all the templates to execute around the workspace -
Better Errors (typed ones)
-
Resolved Json Cache optimisation
-
all tests passing on windows too
-
Verbose/Tracing? mode
-
Better examples
-
Smol strings optimisation ?
-
Watch mode for the file changes
-
Make a VSCode extension about all of this to make it live / super user friendly for
everyone
-
Allow multiple swagger2 documents merging
-
Allow multiple swagger3 documents merging
-
Transform the json to an OpenApi Generator model, and be able to use all the
OpenApi Generator
templates ?
Dependencies
~13–26MB
~421K SLoC