From c75d136dd5ff0119da0038d25f96a42f7f68c0e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81ngel=20Albi=C3=B1ana=20Espejo?= Date: Fri, 30 Aug 2024 02:02:57 +0200 Subject: [PATCH] :bug: fix(all): update create repo and fix server repo --- docs/guide/builder/index.md | 14 +++--- docs/guide/core/app.md | 1 - docs/guide/create/index.md | 2 + docs/guide/index.md | 6 +-- docs/guide/server/index.md | 35 +++++++++---- docs/public/backan-create.png | Bin 0 -> 162188 bytes docs/todo/v1.md | 2 +- packages/_config/CHANGELOG.md | 6 +++ packages/_config/package.json | 4 +- packages/_config/src/tests/main.test.ts | 1 + packages/_config/src/tests/main.ts | 4 +- packages/backan/CHANGELOG.md | 7 +++ packages/backan/package.json | 2 +- packages/builder/CHANGELOG.md | 2 + packages/builder/package.json | 2 +- packages/core/CHANGELOG.md | 2 + packages/core/package.json | 2 +- packages/create/CHANGELOG.md | 6 +++ packages/create/examples/all.ts | 39 +++++++++++++++ packages/create/examples/main.ts | 2 +- packages/create/package.json | 2 +- packages/create/src/bin.ts | 47 ----------------- packages/create/src/main.test.ts | 64 +++++++++++------------- packages/create/src/main.ts | 2 +- packages/docs/CHANGELOG.md | 2 + packages/docs/package.json | 2 +- packages/server/CHANGELOG.md | 6 +++ packages/server/examples/app.ts | 2 - packages/server/examples/node.ts | 5 +- packages/server/package.json | 2 +- 30 files changed, 153 insertions(+), 120 deletions(-) create mode 100644 docs/public/backan-create.png create mode 100644 packages/create/examples/all.ts diff --git a/docs/guide/builder/index.md b/docs/guide/builder/index.md index 3a207f1..35d084a 100644 --- a/docs/guide/builder/index.md +++ b/docs/guide/builder/index.md @@ -39,20 +39,20 @@ Using *Backan* `Builder` is simple and will work in most cases, but that may no import {build} from '@backan/builder' await build( { - input : 'src/server.ts', // JS or TS file - name : 'my-app-name', // default is input filename + input : 'src/server.js', // JS or TS file + name : 'app-name', // default is input filename } ) ``` ```bash -backan-builder --input=src/server.ts --name=backan +backan-builder --input=src/server.js --name=app-name ``` ::: ### ⚙️ Configuration -Todas estas opciones estan disponibles con el comando `backan-builder` añadiendole el sufijo `--` y seguidos de un `=` y su valor. Por ejemplo: `--input=src/server.ts --name=backan --onlyOs` +All of these options are available with the `backan-builder` command by adding the suffix `--` and followed by an `=` and its value. ```ts type BuilderParams = { @@ -93,7 +93,7 @@ import {app} from './your-backan-app.js' buildSchema( { app : app, - output : 'example-openapi.json', + output : 'openapi-schema.json', } ) ``` @@ -112,7 +112,7 @@ export type BuilderSchemaParams = { } ``` -## Build `markdown` documentation +## Build `Markdown` documentation ```js import {buildMD} from '@backan/builder' @@ -120,7 +120,7 @@ import {app} from './your-backan-app.js' buildMD( { app : app, - output : 'example-openapi.md', + output : 'api-documentation.md', } ) ``` diff --git a/docs/guide/core/app.md b/docs/guide/core/app.md index 8c8fe66..f400fb3 100644 --- a/docs/guide/core/app.md +++ b/docs/guide/core/app.md @@ -10,7 +10,6 @@ import { App } from 'backan'; const app = new App( { version : '1.0.0', title : 'BACKAN Example app', - port : 1312, }) export default app diff --git a/docs/guide/create/index.md b/docs/guide/create/index.md index 3d610a6..31f21f7 100644 --- a/docs/guide/create/index.md +++ b/docs/guide/create/index.md @@ -4,6 +4,8 @@ A `CLI` for creating new [Backan](https://backan.pigeonposse.com) project. [![NPM Version](https://img.shields.io/npm/v/create-backan?style=for-the-badge&color=yellow)](https://www.npmjs.com/package/create-backan) + +