galbe 0.6.1 → 0.6.2

package/bin/commands/generate/code/openapi.parser.ts

@@ -280,6 +280,7 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
   let rs = Object.fromEntries(
     Object.entries(r || {}).map(([status, sv]) => {
       let entries: string[] = []
+      let s: string = Number.isInteger(Number(status)) ? status : '200'
       for (let [_type, tv] of Object.entries((sv as OpenAPIV3.ResponseObject)?.content || {})) {
         entries.push(
           unref(parseOapiSchema(tv.schema), m => {
@@ -289,7 +290,7 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
           })
         )
       }
-      return [status, [...new Set(entries)]]
+      return [s, [...new Set(entries)]]
     })
   )
 

package/docs/cli.md

@@ -111,7 +111,7 @@ Generate a client for your Galbe application.
 Let's first setup a new Galbe project:
 
 ```bash
-$ bun create galbe galbe-example -t hello -l ts
+$ bun create galbe galbe-example --template hello --lang ts
 $ cd galbe-example
 $ bun install
 ```

package/docs/plugins.md

@@ -4,6 +4,8 @@ Galbe provides a powerful plugin system that allows developers to extend and cus
 
 ## Definition
 
+### Signature
+
 ```ts
 type GalbePlugin = {
   name: string
@@ -47,7 +49,7 @@ This method is called after the route handler has been called and before the res
 
 It is preemptable, meaning that any returned value will be interpreted as a response to send back to the client. Therefore, the method should only return [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) instances or nothing.
 
-## Registration
+### Usage
 
 To register a plugin with your Galbe server, you must use the `use` method from you galbe instance.
 
@@ -56,7 +58,21 @@ const galbe = new Galbe()
 galbe.use(plugin)
 ```
 
-## Example
+## Create a plugin
+
+### 1. Scaffolding
+
+The Galbe starter CLI provides a template that can be used to setup a Galbe plugin project.
+
+```bash
+$ bun create galbe my-plugin --template plugin
+$ cd my-plugin
+$ bun install
+```
+
+Now you should be ready to start developing your plugin. Following section will present an example of a plugin implementation.
+
+### 2. Implementation
 
 Here is an example of a plugin implementation that handles routes tagged with `@deprecated` metadata (See [Route files](routes.md#route-files) section about metadata).
 
@@ -100,8 +116,6 @@ export default () => {
 }
 ```
 
-index.ts
-
 ```ts
 import { Galbe } from 'galbe'
 import deprecatedPlugin from './deprecated.plugin'
@@ -111,3 +125,29 @@ galbe.use(deprecatedPlugin())
 
 export default galbe
 ```
+
+### 3. Publishing
+
+If you want to submit your plugin to the [official plugin list](https://galbe.dev/plugins), you should follow these steps:
+
+1. Create a **public** Github repository for your plugin. Make sure to include the following information in the README at the root of your repository:
+
+   - A description of your plugin and what it does.
+   - How to install and configure it.
+   - How to use it.
+
+2. (_Optional_) Publish your plugin to [NPM](https://npmjs.com).
+
+3. Create a Pull Request adding your plugin config to [plugins.json](https://github.com/pierre-cm/galbe-website/blob/main/plugins.json) file. The config should be in the following format:
+
+```json
+"plugin-id": {
+  "name": "Plugin Name",
+  "description": "Plugin description",
+  "repo": "https://github.com/<username>/<repo-name>",
+  "npm": "https://www.npmjs.com/package/<package-name>",
+}
+```
+
+> [!IMPORTANT]
+> Please provide any relevent information about the plugin in the Pull Request description. It will be reviewed by the project maintainers as soon as possible. Be sure to check the [Glabe Contributing Guide](https://github.com/pierre-cm/galbe/blob/main/docs/CONTRIBUTING.md) before submitting any request. Same rules will apply here.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "galbe",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "Fast, lightweight and highly customizable JavaScript web framework based on Bun",
   "author": "Pierre Caillaud M (https://github.com/pierre-cm)",
   "type": "module",