Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,25 @@
"windows": {
"program": "${workspaceFolder}/node_modules/jest/bin/jest"
}
},
{
"type": "node",
"request": "launch",
"name": "Debug runtime generation",
"skipFiles": ["<node_internals>/**"],
"program": "${workspaceFolder}/bin/run.mjs",
"args": ["generate", "${input:codegenFile}"],
"cwd": "${workspaceFolder}/test/runtime/typescript",
"console": "integratedTerminal"
}
],
"inputs": [
{
"id": "codegenFile",
"type": "pickString",
"description": "Select codegen file to use",
"options": ["./codegen-regular.mjs", "./codegen-request-reply.mjs"],
"default": "./codegen-regular.mjs"
}
]
}
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

<h4>Generate payload models, parameters, headers, messages, communication support functions, testing functions, and more, across programming languages such as TypeScript, and soon more...</h4>
<h4>Generate payload models, parameters, headers, messages, communication support functions, and much more...</h4>

[Read the Docs](https://the-codegen-project.org/docs/) | [View Demos](./examples/README.md)

Expand Down Expand Up @@ -51,7 +51,7 @@
- 💫 Regenerate once the input changes
- 👀 Integrate it into any project (such as [Next.JS](./examples/typescript-nextjs), [TypeScript Libraries](./examples/typescript-library), you name it.)
- 💅 [Create custom generators to your use-case](https://the-codegen-project.org/docs/generators/custom)
- 🗄️ Protocol agnostic generator ([NATS](https://the-codegen-project.org/docs/protocols/nats), [Kafka](https://the-codegen-project.org/docs/protocols/kafka), [MQTT](https://the-codegen-project.org/docs/protocols/mqtt), [AMQP](https://the-codegen-project.org/docs/protocols/amqp), [event-source](https://the-codegen-project.org/docs/protocols/eventsource), read the [docs](https://the-codegen-project.org/docs#protocols) for the full list and information)
- 🗄️ Protocol agnostic generator ([NATS](https://the-codegen-project.org/docs/protocols/nats), [Kafka](https://the-codegen-project.org/docs/protocols/kafka), [MQTT](https://the-codegen-project.org/docs/protocols/mqtt), [AMQP](https://the-codegen-project.org/docs/protocols/amqp), [event-source](https://the-codegen-project.org/docs/protocols/eventsource), [HTTP Client](https://the-codegen-project.org/docs/protocols/http_client), read the [docs](https://the-codegen-project.org/docs#protocols) for the full list and information)
- ⭐ And much more...

# How it works
Expand Down Expand Up @@ -227,14 +227,16 @@ codegen generate

# 👀 Goals
Besides the [milestones](https://github.com/the-codegen-project/cli/milestones), we have certain goals that we want to reach for various reasons;
- ⭐ Reach 50 stars - So we can publish the CLI on Brew and Chocolatey
- 📃 3 Published resources (blog post, video, etc)
- [ ] ⭐ Reach 50 stars - So we can publish the CLI on Brew and Chocolatey
- [X] 📃 3 Published resources (blog post, video, etc)

# 📃 Resources
People who have been so kind to write or talk about The Codegen Project;
- [The Codegen Project - 1 Months of Progress](https://the-codegen-project.org/blog/update-2)
- [The Codegen Project - AsyncAPI Extensions](https://the-codegen-project.org/blog/asyncapi-customizing-outputs)
- [The Codegen Project - 5 Months of Progress](https://the-codegen-project.org/blog/update-1)


# Contribution Guidelines

We have made quite a [comprehensive contribution guide](https://the-codegen-project.org/docs/contributing) to give you a lending hand in how the project is structured and how to contribute to it.
Expand Down
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Each protocol has its own limitations, corner cases, and features; thus, each ha
- [Kafka](./protocols/kafka.md)
- [MQTT](./protocols/mqtt.md)
- [EventSource](./protocols/eventsource.md)
- [HTTP Client](./protocols/http_client.md)

### [Migrations](./contributing.md)
Get an overview of how to contribute to the project
Expand Down
5 changes: 4 additions & 1 deletion docs/generators/channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This is supported through the following inputs: [`asyncapi`](../inputs/asyncapi.

It supports the following languages; [`typescript`](#typescript)

It supports the following protocols; [`nats`](../protocols/nats.md), [`kafka`](../protocols/kafka.md), [`mqtt`](../protocols/mqtt.md), [`amqp`](../protocols/amqp.md), [`event_source`](../protocols/eventsource.md)
It supports the following protocols; [`nats`](../protocols/nats.md), [`kafka`](../protocols/kafka.md), [`mqtt`](../protocols/mqtt.md), [`amqp`](../protocols/amqp.md), [`event_source`](../protocols/eventsource.md), [`http_client`](../protocols/http_client.md)

## Options
These are the available options for the `channels` generator;
Expand All @@ -49,6 +49,9 @@ Depending on which protocol, these are the dependencies:
- `MQTT`: https://github.com/mqttjs/MQTT.js v5
- `AMQP`: https://github.com/amqp-node/amqplib v0
- `EventSource`: `event_source_fetch`: https://github.com/Azure/fetch-event-source v2, `event_source_express`: https://github.com/expressjs/express v4
- `HTTP`: https://github.com/node-fetch/node-fetch v2

NodeFetch

For TypeScript what is generated is a single file that include functions to help easier interact with AsyncAPI channels. For example;

Expand Down
Loading