Skip to content

Commit

Permalink
feat: update next with master (#1737)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaslagoni authored Jan 11, 2024
2 parents 793b385 + 1d30dda commit a7c2311
Show file tree
Hide file tree
Showing 119 changed files with 4,135 additions and 129 deletions.
58 changes: 56 additions & 2 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,11 @@
"profile": "https://github.com/artur-ciocanu",
"contributions": [
"code",
"bug"
"bug",
"example",
"doc",
"test",
"maintenance"
]
},
{
Expand Down Expand Up @@ -782,7 +786,57 @@
"profile": "https://jaisarita.vercel.app/",
"contributions": [
"code",
"design"
"design",
"doc",
"maintenance",
"test",
"review"
]
},
{
"login": "Harshil-Jani",
"name": "Harshil Jani",
"avatar_url": "https://avatars.githubusercontent.com/u/79367883?v=4",
"profile": "http://harshil.prose.sh",
"contributions": [
"code",
"test"
]
},
{
"login": "Min2who",
"name": "Mintu Gogoi",
"avatar_url": "https://avatars.githubusercontent.com/u/127925465?v=4",
"profile": "https://mintu-portfolio.netlify.app/",
"contributions": [
"test"
]
},
{
"login": "devansh-m12",
"name": "Devansh Mahant",
"avatar_url": "https://avatars.githubusercontent.com/u/86195162?v=4",
"profile": "https://github.com/devansh-m12",
"contributions": [
"doc"
]
},
{
"login": "officialasishkumar",
"name": "Asish Kumar",
"avatar_url": "https://avatars.githubusercontent.com/u/87874775?v=4",
"profile": "https://github.com/officialasishkumar",
"contributions": [
"doc"
]
},
{
"login": "ankur0904",
"name": "Ankur Singh",
"avatar_url": "https://avatars.githubusercontent.com/u/98346896?v=4",
"profile": "https://github.com/ankur0904",
"contributions": [
"doc"
]
}
],
Expand Down
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Description
<!-- Provide a brief description of the changes introduced by this pull request. -->

## Related Issue
<!-- If this pull request is related to any existing issue, mention it here. -->

## Checklist
- [ ] The code follows the project's coding standards and is properly linted (`npm run lint`).
- [ ] Tests have been added or updated to cover the changes.
- [ ] Documentation has been updated to reflect the changes.
- [ ] All tests pass successfully locally.(`npm run test`).

## Additional Notes
<!-- Add any additional information or context that might be relevant to reviewers. -->
3 changes: 3 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,6 @@

# Language Champions for PHP and it's presets
*/generators/php @ferror

# Language Champions for Scala and it's presets
*/generators/scala @artur-ciocanu
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![Discussions](https://img.shields.io/github/discussions/asyncapi/modelina)](https://github.com/asyncapi/modelina/discussions)
[![Website](https://img.shields.io/website?label=website&url=https%3A%2F%2Fwww.modelina.org)](https://www.modelina.org)
[![Playground](https://img.shields.io/website?label=playground&url=https%3A%2F%2Fwww.modelina.org%2Fplayground)](https://www.modelina.org/playground) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-72-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-77-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Your one-stop tool for generating accurate and well-tested models for representing the message payloads. Use it as a tool in your development workflow, or a library in a larger integrations, entirely in your control.
Expand All @@ -23,7 +23,6 @@ Your one-stop tool for generating accurate and well-tested models for representi
- [Installing Modelina](#installing-modelina)
- [AsyncAPI CLI](#asyncapi-cli)
- [Features](#features)
- [Roadmap](#roadmap)
- [Requirements](#requirements)
- [Documentation](#documentation)
- [Examples](#examples)
Expand Down Expand Up @@ -201,7 +200,7 @@ The following table provides a short summary of available features for supported
<td>We support the following JSON Schema versions: <em>Draft-4, Draft-6 and Draft-7</em></td>
</tr>
<tr>
<td>OpenAPI</td>
<td><a href="./docs/usage.md#generate-models-from-openapi-documents">OpenAPI</a></td>
<td>We support the following OpenAPI versions: <em><a href="./docs/usage.md#generate-models-from-swagger-20-documents">Swagger 2.0</a> and <a href="./docs/usage.md#generate-models-from-openapi-documents">OpenAPI 3.0</a></em>, which generates models for all the defined request and response payloads.</td>
</tr>
<tr>
Expand Down Expand Up @@ -266,13 +265,12 @@ The following table provides a short summary of available features for supported
<td><a href="./docs/usage.md#generate-php-models">PHP</a></td>
<td>Class and enum generation: <em>custom indentation type and size, descriptions, etc </em></td>
</tr>
<tr>
<td><a href="./docs/usage.md#generate-scala-models">Scala</a></td>
<td>Class and enum generation: <em>custom indentation type and size, descriptions, etc </em></td>
</tr>
</table>

## Roadmap
This is the roadmap that is currently in focus by the [CODEOWNERS](./CODEOWNERS)

- [1 year roadmap](https://github.com/asyncapi/modelina/milestone/4)

## Requirements
The following are a requirement in order to use Modelina.

Expand Down Expand Up @@ -363,7 +361,7 @@ Thanks go out to these wonderful people ([emoji key](https://allcontributors.org
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/PanMan"><img src="https://avatars.githubusercontent.com/u/978501?v=4?s=100" width="100px;" alt="PanMan"/><br /><sub><b>PanMan</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=PanMan" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/artur-ciocanu"><img src="https://avatars.githubusercontent.com/u/743192?v=4?s=100" width="100px;" alt="artur-ciocanu"/><br /><sub><b>artur-ciocanu</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=artur-ciocanu" title="Code">💻</a> <a href="https://github.com/asyncapi/modelina/issues?q=author%3Aartur-ciocanu" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/artur-ciocanu"><img src="https://avatars.githubusercontent.com/u/743192?v=4?s=100" width="100px;" alt="artur-ciocanu"/><br /><sub><b>artur-ciocanu</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=artur-ciocanu" title="Code">💻</a> <a href="https://github.com/asyncapi/modelina/issues?q=author%3Aartur-ciocanu" title="Bug reports">🐛</a> <a href="#example-artur-ciocanu" title="Examples">💡</a> <a href="https://github.com/asyncapi/modelina/commits?author=artur-ciocanu" title="Documentation">📖</a> <a href="https://github.com/asyncapi/modelina/commits?author=artur-ciocanu" title="Tests">⚠️</a> <a href="#maintenance-artur-ciocanu" title="Maintenance">🚧</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://micro-jumbo.eu/"><img src="https://avatars.githubusercontent.com/u/11511697?v=4?s=100" width="100px;" alt="Cyprian Gracz"/><br /><sub><b>Cyprian Gracz</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=micro-jumbo" title="Code">💻</a> <a href="https://github.com/asyncapi/modelina/commits?author=micro-jumbo" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/modelina/issues?q=author%3Amicro-jumbo" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.printnanny.ai"><img src="https://avatars.githubusercontent.com/u/2601819?v=4?s=100" width="100px;" alt="Leigh Johnson"/><br /><sub><b>Leigh Johnson</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=leigh-johnson" title="Code">💻</a> <a href="https://github.com/asyncapi/modelina/commits?author=leigh-johnson" title="Tests">⚠️</a> <a href="#example-leigh-johnson" title="Examples">💡</a> <a href="https://github.com/asyncapi/modelina/commits?author=leigh-johnson" title="Documentation">📖</a> <a href="#maintenance-leigh-johnson" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/modelina/pulls?q=is%3Apr+reviewed-by%3Aleigh-johnson" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nitintejuja"><img src="https://avatars.githubusercontent.com/u/95347924?v=4?s=100" width="100px;" alt="Nitin Tejuja"/><br /><sub><b>Nitin Tejuja</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=nitintejuja" title="Tests">⚠️</a> <a href="#example-nitintejuja" title="Examples">💡</a></td>
Expand Down Expand Up @@ -417,7 +415,12 @@ Thanks go out to these wonderful people ([emoji key](https://allcontributors.org
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nilkanth987"><img src="https://avatars.githubusercontent.com/u/12413581?v=4?s=100" width="100px;" alt="Nilkanth Parmar"/><br /><sub><b>Nilkanth Parmar</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=nilkanth987" title="Code">💻</a> <a href="https://github.com/asyncapi/modelina/commits?author=nilkanth987" title="Tests">⚠️</a> <a href="#example-nilkanth987" title="Examples">💡</a> <a href="https://github.com/asyncapi/modelina/commits?author=nilkanth987" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://jaisarita.vercel.app/"><img src="https://avatars.githubusercontent.com/u/43639341?v=4?s=100" width="100px;" alt="Ashmit JaiSarita Gupta"/><br /><sub><b>Ashmit JaiSarita Gupta</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=devilkiller-ag" title="Code">💻</a> <a href="#design-devilkiller-ag" title="Design">🎨</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://jaisarita.vercel.app/"><img src="https://avatars.githubusercontent.com/u/43639341?v=4?s=100" width="100px;" alt="Ashmit JaiSarita Gupta"/><br /><sub><b>Ashmit JaiSarita Gupta</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=devilkiller-ag" title="Code">💻</a> <a href="#design-devilkiller-ag" title="Design">🎨</a> <a href="https://github.com/asyncapi/modelina/commits?author=devilkiller-ag" title="Documentation">📖</a> <a href="#maintenance-devilkiller-ag" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/modelina/commits?author=devilkiller-ag" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/modelina/pulls?q=is%3Apr+reviewed-by%3Adevilkiller-ag" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://harshil.prose.sh"><img src="https://avatars.githubusercontent.com/u/79367883?v=4?s=100" width="100px;" alt="Harshil Jani"/><br /><sub><b>Harshil Jani</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=Harshil-Jani" title="Code">💻</a> <a href="https://github.com/asyncapi/modelina/commits?author=Harshil-Jani" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://mintu-portfolio.netlify.app/"><img src="https://avatars.githubusercontent.com/u/127925465?v=4?s=100" width="100px;" alt="Mintu Gogoi"/><br /><sub><b>Mintu Gogoi</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=Min2who" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/devansh-m12"><img src="https://avatars.githubusercontent.com/u/86195162?v=4?s=100" width="100px;" alt="Devansh Mahant"/><br /><sub><b>Devansh Mahant</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=devansh-m12" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/officialasishkumar"><img src="https://avatars.githubusercontent.com/u/87874775?v=4?s=100" width="100px;" alt="Asish Kumar"/><br /><sub><b>Asish Kumar</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=officialasishkumar" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ankur0904"><img src="https://avatars.githubusercontent.com/u/98346896?v=4?s=100" width="100px;" alt="Ankur Singh"/><br /><sub><b>Ankur Singh</b></sub></a><br /><a href="https://github.com/asyncapi/modelina/commits?author=ankur0904" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
8 changes: 5 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,15 @@ No one wants to read the code to find information about it, instead use the [/ap

### Languages
Each language has its own limitations, corner cases, and features; thus, each language has separate documentation.
- [C++](./languages/Cplusplus.md)
- [C#](./languages/Csharp.md)
- [Dart](./languages/Dart.md)
- [Go](./languages/Go.md)
- [Java](./languages/Java.md)
- [JavaScript](./languages/JavaScript.md)
- [Rust](./languages/Rust.md)
- [Kotlin](./languages/Kotlin.md)
- [PHP](./languages/Php.md)
- [Python](./languages/Python.md)
- [Rust](./languages/Rust.md)
- [Scala](./languages/Scala.md)
- [TypeScript](./languages/TypeScript.md)
- [Kotlin](./languages/Kotlin.md)
- [C++](./languages/Cplusplus.md)
7 changes: 6 additions & 1 deletion docs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,17 @@ Check out this [example out for a live demonstration](../examples/include-custom

One of the primary use-cases for the generated models, is to serialize and deserilize it to for example JSON, XML or binary. Each generator can have multiple ways to achieve this, and even support multiple libraries. This is achieved through presets, you can find them here for each output:

- [C++](./languages/Cplusplus.md#generate-serializer-and-deserializer-functionality)
- [C#](./languages/Csharp.md#generate-serializer-and-deserializer-functionality)
- [Dart](./languages/Dart.md#generate-serializer-and-deserializer-functionality)
- Go currently does not support this.
- [Go](./languages/Go.md#generate-serializer-and-deserializer-functionality)
- [Java](./languages/Java.md#generate-serializer-and-deserializer-functionality)
- [JavaScript](./languages/JavaScript.md#generate-serializer-and-deserializer-functionality)
- [Kotlin](./languages/Kotlin.md#generate-serializer-and-deserializer-functionality)
- [PHP](./languages/Php.md#generate-serializer-and-deserializer-functionality)
- [Python](./languages/Python.md#generate-serializer-and-deserializer-functionality)
- [Rust](./languages/Rust.md)
- [Scala](./languages/Scala.md#generate-serializer-and-deserializer-functionality)
- [TypeScript](./languages/TypeScript.md#generate-serializer-and-deserializer-functionality)

## Adapting input and outputs
Expand Down
12 changes: 6 additions & 6 deletions docs/champions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ You can checkout the [CODEOWNERS file](../CODEOWNERS) for an updated list of mai

These are the areas that we mainly focus on getting having champions and where you can help out. However, keep in mind it is not limited to these alone.

### :running: Core champions
### 🏃 Core champions

There is not one area that interest you, but rather the library as a whole, where you want to maintain and push forward the project and it's mission.

### :books: Doc champions
### 📚 Doc champions

Doc champions are those who focus on the documentation and how users best go from 0 to 100 in order to use Modelina. Maybe you like to write technical documentation, or you love making tutorials, this would be for you!

### :trident: Input champions
### 🔱 Input champions

Input champions are those who take charge of the input processing, it can either be a specific input processor (such as JSON Schema or AsyncAPI) or multiple. They maintain the process of converting the input to the internal model which Modelina can use to generate outputs to.

### :wrench: Language champions
### 🔧 Language champions

Language champions are those who maintain of a specific language output, it can either be a specific generator (such as TypeScript or Java) or or multiple. They maintain the process of converting the internal model into usable data models in their respective language.

### :sparkles: Website champions
### Website champions

Website champions are those who focus on the website (this includes playground). Maybe you are a designer or coder that loves to create great interactions for user, then this is would be for you!

Expand Down Expand Up @@ -125,4 +125,4 @@ Maintainers should feel free to pleasantly disagree with the work and decisions

There can be countless reasons why you want to step down as a champion and it is entirely your provocative at any time.

To step down as a champion make a PR removing your name from the [CODEOWNERS file](../CODEOWNERS) and thats it :v:
To step down as a champion make a PR removing your name from the [CODEOWNERS file](../CODEOWNERS) and thats it ✌️
Loading

0 comments on commit a7c2311

Please sign in to comment.