galbe 0.6.0 → 0.6.2

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[bug] '
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**Steps To Reproduce**
+
+<!-- Steps to reproduce the behavior -->
+
+**Expected behavior**
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+**Screenshots**
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+**Environment (please complete the following information):**
+
+<!-- To help us diagnose the issue, please navigate to the root of your project in your terminal and execute "bunx galbe info". Then paste the output bellow -->
+
+```txt
+
+```
+
+**Additional context**
+
+<!-- Add any other context about the problem here. -->

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[feat] '
+labels: enhancement
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you'd like**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+
+<!-- Add any other context or screenshots about the feature request here. -->

package/.github/workflows/deploy_website.yml

@@ -16,5 +16,5 @@ jobs:
           -H "Accept: application/vnd.github+json" \
           -H "Authorization: Bearer ${{ secrets.GH_WEBSITE_TOKEN }}" \
           -H "X-GitHub-Api-Version: 2022-11-28" \
-          https://api.github.com/repos/pierre-cm/galbe-website/actions/workflows/deploy.yml/dispatches \
+          https://api.github.com/repos/pierre-cm/galbe-website/actions/workflows/static.yml/dispatches \
           -d '{"ref":"main"}'

package/README.md

@@ -25,3 +25,5 @@ bun install && bun dev
 The detailed documentation is available at [galbe.dev](https://galbe.dev).
 
 ## Contributing
+
+Please refer to the [Contributing Guide](https://github.com/pierre-cm/galbe/blob/main/docs/CONTRIBUTING.md) to start contributing to Galbe.

package/bin/cli.ts

@@ -7,11 +7,13 @@ import { pckg } from './util'
 import dev from './commands/dev'
 import build from './commands/build'
 import generate from './commands/generate'
+import info from './commands/info'
 
 program.name('galbe').description(pckg.description).version(pckg.version)
 
 dev(program.command('dev'))
 build(program.command('build'))
 generate(program.command('generate'))
+info(program.command('info'))
 
 program.parse()

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/bin/commands/info.ts

@@ -0,0 +1,29 @@
+import os from 'os'
+import { Command } from 'commander'
+
+export default async (cmd: Command) => {
+  cmd.description('print informations about the current os, bun and galbe version').action(async () => {
+    const osName = os.type()
+    const osArch = os.arch()
+    const osVersion = os.release()
+
+    const bunVersion = Bun.version
+    const bunRevision = Bun.revision
+
+    let localPckg: any = {}
+    try {
+      localPckg = await Bun.file('./node_modules/galbe/package.json').json()
+    } catch (err) {}
+    const galbeVersion = localPckg?.version || 'not found'
+
+    console.log('OS')
+    console.log(`  name: ${osName}`)
+    console.log(`  arch: ${osArch}`)
+    console.log(`  version: ${osVersion}`)
+    console.log('Bun')
+    console.log(`  version: ${bunVersion}`)
+    console.log(`  revision: ${bunRevision}`)
+    console.log('Galbe')
+    console.log(`  version: ${galbeVersion}`)
+  })
+}

package/docs/CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Contributing to Galbe
+
+First off, thank you for considering contributing to our project! We appreciate your time and effort and want to make this as easy and transparent as possible for everyone.
+
+## Create an Issue
+
+If you encounter a bug, want to propose a new feature, or something that could be improved, please create an issue. Here's how:
+
+1. **Check Existing Issues**: Before creating a new issue, please search the [existing issues](https://github.com/pierre-cm/galbe/issues) to see if someone else has already reported the same problem or suggested the same feature.
+
+2. **Open a New Issue**: If your issue is new, [open a new issue](https://github.com/pierre-cm/galbe/issues/new/choose) and provide the following details:
+
+   - **Title**: A concise summary of the issue.
+   - **Description**: A detailed description of the problem or suggestion. Include steps to reproduce the issue if applicable.
+   - **Screenshots**: If possible, include screenshots or other visual aids that help explain the issue.
+   - **Environment**: Mention the environment in which you encountered the issue (e.g., OS, Bun version).
+   - **Labels**: Assign appropriate labels (e.g., bug, enhancement) to help categorize your issue.
+
+3. **Follow Up**: Once your issue is submitted, be ready to provide additional information if requested. We'll do our best to address the issue promptly.
+
+## Create a Pull Request
+
+### 1. Fork the Repository
+
+If you haven't already, [fork Galbe's repository on GitHub](https://github.com/pierre-cm/galbe/fork). This will create a copy of this repository under your GitHub account.
+
+### 2. Clone Your Fork
+
+Clone the forked repository to your local machine:
+
+```bash
+git clone https://github.com/<your-username>/galbe.git
+cd galbe
+```
+
+### 3. Create a New Branch
+
+Before making any changes, create a new branch for your work. Branches help keep your changes separate from the main branch and make it easier to review and merge:
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+Use a descriptive name for your branch to indicate what you are working on.
+
+### 4. Make Your Changes
+
+Make the necessary changes in your branch. Be sure to follow the project's coding style and best practices.
+
+### 5. Commit Your Changes
+
+Once you’ve made your changes, commit them with a clear and descriptive message:
+
+```bash
+git add .
+git commit -m "Add feature X to do Y"
+```
+
+### 6. Push to Your Fork
+
+Push your changes to your forked repository on GitHub:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 7. Create a Pull Request
+
+Once your changes are pushed to GitHub, you can create a pull request. Go to the [original repository](https://github.com/pierre-cm/galbe) on GitHub, and you should see an option to create a pull request from your branch.
+
+- Make sure to provide a detailed description of your changes and why they are necessary.
+- Link any related issues if applicable.
+- If your pull request is still a work in progress, mark it as a draft to let others know that you are not yet ready for a review.
+
+### 8. Respond to Feedback
+
+Once your pull request is submitted, it will be reviewed by the project maintainers. They may ask for changes or provide feedback. Please be responsive and make the necessary adjustments.
+
+### Coding Standards
+
+Please follow these coding standards to ensure consistency across the project:
+
+- **Code Style**: Follow the [style guide]().
+- **Commit Messages**: Use clear and descriptive commit messages.
+- **Documentation**: Update documentation where applicable. This includes comments in the code and other documentation files under the `docs` directory.
+
+## Code of Conduct
+
+We are committed to creating a welcoming and inclusive environment for everyone. To ensure this, all contributors are expected to adhere to the following guidelines:
+
+1. **Be Respectful**: Treat everyone with respect. Disagreements are inevitable, but it's important to remain courteous and constructive. Personal attacks, harassment, or offensive comments will not be tolerated.
+
+2. **Collaborate Openly**: Collaboration is key to the success of the project. Be open to feedback and suggestions from others. Constructive criticism should be welcomed and given in a positive manner.
+
+3. **Resolve Disagreements Constructively**: If you find yourself in a disagreement, seek to resolve it in a way that is constructive and respectful. If necessary, involve a project maintainer to help mediate.
+
+4. **Report Issues**: If you witness or experience any behavior that violates this Code of Conduct, please report it immediately to the project maintainers. We take all reports seriously and will address them promptly.
+
+By participating in this project, you agree to abide by this Code of Conduct.
+
+## Getting Help
+
+If you have any questions or need help, feel free to open an issue or contact one of the maintainers.
+
+Thank you for your contribution!

package/docs/cli.md

@@ -12,7 +12,7 @@ Install it globally using the following command:
 $ bun install -g galbe
 ```
 
-Run it with `bunx`:
+Or run it with `bunx`:
 
 ```bash
 $ bunx galbe
@@ -38,16 +38,19 @@ Start a dev server running your Galbe application.
 
 #### Example
 
-```js
-// index.js
+index.js
 
+```js
 import { Galbe } from 'galbe'
 
-export default new Galbe()
+const g = new Galbe()
+g.get('example', () => '')
+
+export default g
 ```
 
 ```bash
-$ galbe dev index.js -p 7357 --watch
+$ galbe dev index.js -p 7357 -w
 ```
 
 ## build
@@ -66,13 +69,13 @@ Bundle your Galbe application.
 | ----- | --------- | ------------------------------ | -------- |
 | -o    | --out     | output directory               | dist/app |
 | -C    | --compile | create a standalone executable | false    |
-| -c    | --config  | bun config (js or ts)          | -        |
+| -c    | --config  | bun config (js or ts)          |          |
 
 #### Example
 
-```js
-// index.js
+index.js
 
+```js
 import { Galbe } from 'galbe'
 
 export default new Galbe()
@@ -105,10 +108,10 @@ Generate a client for your Galbe application.
 
 #### Examples
 
-Let's setup a new Galbe project:
+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
 ```
@@ -128,9 +131,9 @@ $ galbe generate client index.ts
 This will generate a `dist/client.ts` client lib by default.
 You can import it and use it like in the following example:
 
-```ts
-// client_example.ts
+client_example.ts
 
+```ts
 import HelloClient from './dist/client'
 
 const client = new HelloClient({ server: { url: 'http://localhost:3000' } })
@@ -191,8 +194,9 @@ $ ./dist/cli hello Pierre -a 29
 Hello Pierre! You're 29 y.o.
 ```
 
-> [!NOTE]
-> In order to be able to fetch the correct server url, the cli requires to set an env variable `GCLI_SERVER_URL` with the url of your Galbe app.
+> [!IMPORTANT]
+> A `GCLI_SERVER_URL` environment variable must be defined. It should indicates the url of the Galbe server you want to target.
+> In that specific case `http://localhost:3000`.
 
 ### spec
 
@@ -209,7 +213,7 @@ Generate the spec of your Galbe application.
 | Short | Long     | Descritpion                                      | Default                 |
 | ----- | -------- | ------------------------------------------------ | ----------------------- |
 | -t    | --target | spec target [openapi:3.0:json, openapi:3.0:yaml] | openapi:3.0:yaml        |
-| -b    | --base   | base spec file                                   | -                       |
+| -b    | --base   | base spec file                                   |                         |
 | -o    | --out    | output file                                      | spec/api.(yaml \| json) |
 
 #### Example
@@ -302,7 +306,7 @@ This should generate the code of our application in the `src` directory by defau
 To test that the code was successfully generated, you can run:
 
 ```bash
-$ bunx galbe dev index.ts
+$ galbe dev index.ts
 🏗️  Constructing routes
 
     src/routes/pet.route.ts

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.0",
+  "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",