Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…nto feat/dprint
  • Loading branch information
stijnvanhulle committed Oct 21, 2023
2 parents 687a015 + f88cf40 commit 4f08763
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 16 deletions.
5 changes: 4 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = LF
tab_width = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [stijnvanhulle]
6 changes: 5 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,11 @@ export default defineConfig({
link: 'https://github.com/kubb-project/kubb/releases',
},
{
text: 'Contributing',
text: 'Sponsor Kubb',
link: 'https://github.com/sponsors/stijnvanhulle/',
},
{
text: 'Contribute Kubb',
link: '/contributing',
},
{
Expand Down
3 changes: 3 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@ This is not a new problem and has already been resolved with the use of a Swagge

The problem is that most of them are good at one _thing_: generating TypeScript types or generating React-Query hooks. Kubb is trying to resolve that with a plugin system where we already provide you with some <a href="/plugins/introduction">generation plugins</a> but also giving you the possibilty to create your own generation plugin without the need of forking the full project.

<iframe src="https://github.com/sponsors/stijnvanhulle/button" title="Sponsor stijnvanhulle" height="32" width="114" style="border: 0; border-radius: 6px;"></iframe>

## Motivation

Swagger/OpenAPI has been used a lot as a contract between frontend and backend teams, this was the same for the last couple of projects I did. Every project is different so it always came down in choosing one of the provided <a href="https://tools.openapis.org/categories/code-generators.html">code generators</a> or the default one of <a href="https://swagger.io/tools/swagger-codegen/">Swagger</a>. But that wasn't enough for my needs 🙁.


Main features ✨:

- Every generated client(React-Query, MSW, Zod, ...) is contained in it's own package.
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ yarn add @kubb/react

:::

<hr/>

### Configure `tsconfig.json`

::: code-group
Expand Down
42 changes: 28 additions & 14 deletions release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/core": {
"component": "@kubb/core",
Expand All @@ -78,7 +79,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/cli": {
"component": "@kubb/cli",
Expand All @@ -87,7 +89,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/parser": {
"component": "@kubb/parser",
Expand All @@ -96,7 +99,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger": {
"component": "@kubb/swagger",
Expand All @@ -105,7 +109,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-ts": {
"component": "@kubb/swagger-ts",
Expand All @@ -114,7 +119,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-client": {
"component": "@kubb/swagger-client",
Expand All @@ -123,7 +129,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-tanstack-query": {
"component": "@kubb/swagger-tanstack-query",
Expand All @@ -132,7 +139,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-faker": {
"component": "@kubb/swagger-faker",
Expand All @@ -141,7 +149,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-msw": {
"component": "@kubb/swagger-msw",
Expand All @@ -150,7 +159,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-zod": {
"component": "@kubb/swagger-zod",
Expand All @@ -159,7 +169,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-zodios": {
"component": "@kubb/swagger-zodios",
Expand All @@ -168,7 +179,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/swagger-swr": {
"component": "@kubb/swagger-swr",
Expand All @@ -177,7 +189,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
},
"packages/react": {
"component": "@kubb/react",
Expand All @@ -186,7 +199,8 @@
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false
"prerelease": false,
"skip-github-release": true
}
},
"plugins": [
Expand Down

0 comments on commit 4f08763

Please sign in to comment.