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
4 changes: 3 additions & 1 deletion .github/workflows/blackbox-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
strategy:
fail-fast: false
matrix:
# The full 12-config x 23-file matrix is sharded into config buckets so
# The full config x file matrix is sharded into config buckets so
# no single job runs the whole (npm-install-heavy) cross-product. Each
# bucket lists config-name substrings (see test/blackbox/test_files.ts).
include:
Expand All @@ -22,6 +22,8 @@ jobs:
configs: 'payload,modelina'
- bucket: headers-params-jsonschema
configs: 'headers,parameters,jsonschema'
- bucket: openapi
configs: 'openapi'
steps:
- name: Checkout repository
uses: actions/checkout@v3
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/website-pr-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ on:
- 'website/**'
- 'src/browser/**'
- 'esbuild.browser.mjs'
# The published docs live at the repo root and are copied into the site by
# website/scripts/move_docs.js at build time, so a docs-only change can
# break the site (dead links, bad anchors) without touching website/.
- 'docs/**'
- 'assets/**'
branches:
- main
types: [opened, reopened, synchronize, ready_for_review]
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The Acceptance Criteria for _adding new features_ requires a few things in order
1. **Not all feature requests from the community (or maintainers!) are accepted:** Even though you are welcome to create a new feature without an issue, it might be rejected and turn out to be a waste of your time. We don't want that to happen, so make sure to create an issue first and wait to see if it's accepted after community discussion of the proposal.
1. **When creating tests for your new feature, aim for as high coverage numbers as possible:** When you run the tests (`npm run test`), you should see a `./coverage/lcov-report/index.html` file being generated. Use this to see in depth where your tests are not covering your implementation.
1. **No documentation, no feature:** If a user cannot understand a new feature, that feature basically doesn't exist! Remember to make sure that any and all relevant [documentation](./) is consistently updated.
- New features such as new generators or inputs, etc, need associated use case documentation along side [examples](../examples).
- New features such as new generators or inputs, etc, need associated use case documentation along side [examples](https://github.com/the-codegen-project/cli/tree/main/examples).

## Repository Architecture

Expand Down
2 changes: 1 addition & 1 deletion docs/generators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ All available generators, across languages and inputs:
| OpenAPI | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| JSON Schema | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |

> OpenAPI `channels` and `client` generate an HTTP client — see the [`openapi-http-client` example](../../examples/openapi-http-client/).
> OpenAPI `channels` and `client` generate an HTTP client — see the [`openapi-http-client` example](https://github.com/the-codegen-project/cli/tree/main/examples/openapi-http-client).

| **Languages** | [`payloads`](./payloads.md) | [`parameters`](./parameters.md) | [`headers`](./headers.md) | [`types`](./types.md) | [`channels`](./channels.md) | [`client`](./client.md) | [`models`](./models.md) | [`custom`](./custom.md) |
|---|---|---|---|---|---|---|---|---|
Expand Down
2 changes: 1 addition & 1 deletion docs/generators/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default {
};
```

# Dependencies
## Dependencies

In each generator (don't manually use it unless you use `preset: custom`), you can add `dependencies` property, which takes an array of `id`'s that the rendering engine ensures are rendered before the dependant one.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Customize it to your heart's desire! [Each generator has unique set of options](
</div>

## Integrate
With your configuration file in hand, time to integrate it into your project and generate some code! Checkout [all the integrations](../../examples/) for inspiration how to do it.
With your configuration file in hand, time to integrate it into your project and generate some code! Checkout [all the integrations](https://github.com/the-codegen-project/cli/tree/main/examples) for inspiration how to do it.

### Generate Code

Expand Down Expand Up @@ -200,5 +200,5 @@ Discover how The Codegen Project supports various messaging protocols like NATS,
- **[Generator Documentation](../generators/README.md)** - Detailed documentation for each generator type
- **[Protocol Documentation](../protocols/)** - Complete protocol reference and implementation details
- **[Input Types](../inputs/)** - Learn about AsyncAPI, OpenAPI, and JSON Schema support
- **[Examples](../../examples/)** - Real-world examples and integration patterns
- **[Examples](https://github.com/the-codegen-project/cli/tree/main/examples)** - Real-world examples and integration patterns

2 changes: 1 addition & 1 deletion docs/getting-started/generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,5 @@ export default {

- **[Explore Generator Documentation](../generators/README.md)** - Detailed docs for each generator
- **[Learn about Protocol Support](./protocols.md)** - How generators work with messaging protocols
- **[Check Out Examples](../../examples/)** - See generators in action
- **[Check Out Examples](https://github.com/the-codegen-project/cli/tree/main/examples)** - See generators in action

2 changes: 1 addition & 1 deletion docs/getting-started/protocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,6 @@ export const Protocols = {

- **[Explore Protocol Documentation](../protocols/)** - Detailed docs for each protocol
- **[Learn about Channels Generator](../generators/channels.md)** - How to configure protocol generation
- **[Check Out Examples](../../examples/)** - See the code generation in action
- **[Check Out Examples](https://github.com/the-codegen-project/cli/tree/main/examples)** - See the code generation in action
- **[Understanding Generators](./generators.md)** - Learn how generators work

3 changes: 2 additions & 1 deletion docs/inputs/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"position": 99,
"link": {
"type": "generated-index",
"description": "All the available inputs you can use along side which generators are supported."
"description": "All the available inputs you can use along side which generators are supported.",
"slug": "/inputs"
}
}
27 changes: 13 additions & 14 deletions docs/migrations/v0.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
---
sidebar_position: 99
title: Migrating between v0
---
<!-- toc is generated with GitHub Actions do not remove toc markers -->

<!-- toc -->

- [Migrating between v0](#migrating-between-v0)
* [Breaking Changes 0.39.0](#breaking-changes-0390)
+ [Functions Parameters](#functions-parameters)
* [Breaking Changes 0.55.1](#breaking-changes-0551)
* [Breaking Changes 0.61.0](#breaking-changes-0610)
+ [Channels Multi-File Output](#channels-multi-file-output)
* [Breaking Changes 0.64.2](#breaking-changes-0642)
* [Breaking Changes 0.71.0](#breaking-changes-0710)
+ [Library API Type Changes](#library-api-type-changes)
* [Breaking Changes 0.72.3](#breaking-changes-0723)
+ [OpenAPI Operation Names](#openapi-operation-names)
* [Breaking Changes 0.72.6](#breaking-changes-0726)
+ [Generated HTTP Client Uses Native fetch](#generated-http-client-uses-native-fetch)
- [Breaking Changes 0.39.0](#breaking-changes-0390)
* [Functions Parameters](#functions-parameters)
- [Breaking Changes 0.55.1](#breaking-changes-0551)
- [Breaking Changes 0.61.0](#breaking-changes-0610)
* [Channels Multi-File Output](#channels-multi-file-output)
- [Breaking Changes 0.64.2](#breaking-changes-0642)
- [Breaking Changes 0.71.0](#breaking-changes-0710)
* [Library API Type Changes](#library-api-type-changes)
- [Breaking Changes 0.72.3](#breaking-changes-0723)
* [OpenAPI Operation Names](#openapi-operation-names)
- [Breaking Changes 0.72.6](#breaking-changes-0726)
* [Generated HTTP Client Uses Native fetch](#generated-http-client-uses-native-fetch)

<!-- tocstop -->

# Migrating between v0
These are all the breaking changes in v0 and how to migrate between them

## Breaking Changes 0.39.0
Expand Down
3 changes: 2 additions & 1 deletion docs/protocols/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"position": 99,
"link": {
"type": "generated-index",
"description": "All the available protocols you can use along side which inputs and generators are supported."
"description": "All the available protocols you can use along side which inputs and generators are supported.",
"slug": "/protocols"
}
}
5 changes: 2 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
sidebar_position: 3
title: CLI Usage
---
# CLI Usage

<!-- usage -->
```sh-session
$ npm install -g @the-codegen-project/cli
Expand All @@ -20,7 +19,7 @@ USAGE
## Table of contents

<!-- toc -->
* [CLI Usage](#cli-usage)

<!-- tocstop -->

## Commands
Expand Down
Loading
Loading