🐛 fix(all): fix general issues

make beta for 'create' project, fix readme descriptions, change documentation styles, add todos...
pigeonposse · Aug 21, 2024 · 0d32c11 · 0d32c11
1 parent a99c5c8
commit 0d32c11
Show file tree

Hide file tree

Showing 40 changed files with 414 additions and 587 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -54,4 +54,4 @@ yarn.lock
 **/__cache__
 .DS_Store
 **/.DS_Store
-packages/_config/exts-examples/**
+packages/create/templates/**
diff --git a/docs/index.md b/docs/index.md
@@ -20,11 +20,11 @@ features:
 
   - title: Get started
     icon: 👋
-    details: Get started now with BACKAN
+    details: Start your project now
     link: guide/
   - title: Library
     icon: 📚
-    details: Learn and consult the BACKAN documentation.
+    details: Learn and check the documentation.
     link: guide/core
   - title: Server
     icon: 🗄️
@@ -36,3 +36,15 @@ features:
     link: guide/builder
 
 ---
+
+::: code-group
+```bash [npm]
+npm install backan
+```
+```bash [pnpm]
+pnpm install backan
+```
+```bash [yarn]
+yarn add backan
+```
+:::
diff --git a/docs/todo/v1.md b/docs/todo/v1.md
@@ -20,6 +20,10 @@
 
 - [ ] ... -->
 
+## 🌈 General
+
+- [ ] Fix and complete README files
+
 
 ## 📖 Docs
 

diff --git a/packages/backan/CHANGELOG.md b/packages/backan/CHANGELOG.md
@@ -1,5 +1,14 @@
 # backan
 
+## 0.0.5
+
+### Patch Changes
+
+- Fix general issues
+
+- Updated dependencies []:
+  - @backan/core@0.0.5
+
 ## 0.0.4
 
 ### Patch Changes

diff --git a/packages/backan/README.md b/packages/backan/README.md
@@ -1,43 +1,3 @@
-<!-- PIGEONPOSSE START MARK -->
-<!--
-██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗   ██╗   
-██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗  ██║   
-██████╔╝██║██║  ███╗█████╗  ██║   ██║██╔██╗ ██║   
-██╔═══╝ ██║██║   ██║██╔══╝  ██║   ██║██║╚██╗██║   
-██║     ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║   
-╚═╝     ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝  ╚═══╝   
-                                                  
-██████╗  ██████╗ ███████╗███████╗███████╗         
-██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝         
-██████╔╝██║   ██║███████╗███████╗█████╗           
-██╔═══╝ ██║   ██║╚════██║╚════██║██╔══╝           
-██║     ╚██████╔╝███████║███████║███████╗         
-╚═╝      ╚═════╝ ╚══════╝╚══════╝╚══════╝         
-                                                  
-                                                  
-                                                  
-█████╗█████╗█████╗█████╗█████╗█████╗█████╗        
-╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝        
-                                                  
-                                                  
-                                                  
-██████╗  █████╗  ██████╗██╗  ██╗ █████╗ ███╗   ██╗
-██╔══██╗██╔══██╗██╔════╝██║ ██╔╝██╔══██╗████╗  ██║
-██████╔╝███████║██║     █████╔╝ ███████║██╔██╗ ██║
-██╔══██╗██╔══██║██║     ██╔═██╗ ██╔══██║██║╚██╗██║
-██████╔╝██║  ██║╚██████╗██║  ██╗██║  ██║██║ ╚████║
-╚═════╝ ╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝
-                                                                      
-                                                
-REPOSITORY: https://github.com/pigeonposse/backan
-AUTHORS: 
-	- Angelo (https://github.com/angelespejo)
-
-DEVELOPED BY Angelo 🐦🌈
-
--->
-<!-- PIGEONPOSSE END MARK -->
-
 # Backan - All in one web API builder
 
 <!-- PIGEONPOSSE START HEADER -->
@@ -60,8 +20,6 @@ Create endpoints with type validations and OpenApi documentation, safely and qui
 
 <!-- PIGEONPOSSE END HEADER -->
 
-> This package contains **_BACKAN_** Create library
-
 <!-- PIGEONPOSSE START INDEX -->
 
 - [Documentation](https://backan.pigeonposse.com/)
@@ -118,3 +76,43 @@ This software is licensed with **[GPL-3.0](/LICENSE)**.
 
 </p>
 <!-- PIGEONPOSSE END ORG -->
+
+<!-- PIGEONPOSSE START MARK -->
+<!--
+██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗   ██╗   
+██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗  ██║   
+██████╔╝██║██║  ███╗█████╗  ██║   ██║██╔██╗ ██║   
+██╔═══╝ ██║██║   ██║██╔══╝  ██║   ██║██║╚██╗██║   
+██║     ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║   
+╚═╝     ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝  ╚═══╝   
+                                                  
+██████╗  ██████╗ ███████╗███████╗███████╗         
+██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝         
+██████╔╝██║   ██║███████╗███████╗█████╗           
+██╔═══╝ ██║   ██║╚════██║╚════██║██╔══╝           
+██║     ╚██████╔╝███████║███████║███████╗         
+╚═╝      ╚═════╝ ╚══════╝╚══════╝╚══════╝         
+                                                  
+                                                  
+                                                  
+█████╗█████╗█████╗█████╗█████╗█████╗█████╗        
+╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝        
+                                                  
+                                                  
+                                                  
+██████╗  █████╗  ██████╗██╗  ██╗ █████╗ ███╗   ██╗
+██╔══██╗██╔══██╗██╔════╝██║ ██╔╝██╔══██╗████╗  ██║
+██████╔╝███████║██║     █████╔╝ ███████║██╔██╗ ██║
+██╔══██╗██╔══██║██║     ██╔═██╗ ██╔══██║██║╚██╗██║
+██████╔╝██║  ██║╚██████╗██║  ██╗██║  ██║██║ ╚████║
+╚═════╝ ╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝
+                                                                      
+                                                
+REPOSITORY: https://github.com/pigeonposse/backan
+AUTHORS: 
+	- Angelo (https://github.com/angelespejo)
+
+DEVELOPED BY Angelo 🐦🌈
+
+-->
+<!-- PIGEONPOSSE END MARK -->
diff --git a/packages/backan/package.json b/packages/backan/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "backan",
-	"version": "0.0.4",
+	"version": "0.0.5",
 	"type": "module",
 	"license": "GPL-3.0",
 	"homepage": "https://backan.pigeonposse.com/guide",

diff --git a/packages/builder/CHANGELOG.md b/packages/builder/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @backan/builder
 
+## 0.0.5
+
+### Patch Changes
+
+- Fix general issues
+
 ## 0.0.4
 
 ### Patch Changes

diff --git a/packages/builder/README.md b/packages/builder/README.md
@@ -1,43 +1,3 @@
-<!-- PIGEONPOSSE START MARK -->
-<!--
-██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗   ██╗   
-██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗  ██║   
-██████╔╝██║██║  ███╗█████╗  ██║   ██║██╔██╗ ██║   
-██╔═══╝ ██║██║   ██║██╔══╝  ██║   ██║██║╚██╗██║   
-██║     ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║   
-╚═╝     ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝  ╚═══╝   
-                                                  
-██████╗  ██████╗ ███████╗███████╗███████╗         
-██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝         
-██████╔╝██║   ██║███████╗███████╗█████╗           
-██╔═══╝ ██║   ██║╚════██║╚════██║██╔══╝           
-██║     ╚██████╔╝███████║███████║███████╗         
-╚═╝      ╚═════╝ ╚══════╝╚══════╝╚══════╝         
-                                                  
-                                                  
-                                                  
-█████╗█████╗█████╗█████╗█████╗█████╗█████╗        
-╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝        
-                                                  
-                                                  
-                                                  
-██████╗  █████╗  ██████╗██╗  ██╗ █████╗ ███╗   ██╗
-██╔══██╗██╔══██╗██╔════╝██║ ██╔╝██╔══██╗████╗  ██║
-██████╔╝███████║██║     █████╔╝ ███████║██╔██╗ ██║
-██╔══██╗██╔══██║██║     ██╔═██╗ ██╔══██║██║╚██╗██║
-██████╔╝██║  ██║╚██████╗██║  ██╗██║  ██║██║ ╚████║
-╚═════╝ ╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝
-                                                                      
-                                                
-REPOSITORY: https://github.com/pigeonposse/backan
-AUTHORS: 
-	- Angelo (https://github.com/angelespejo)
-
-DEVELOPED BY Angelo 🐦🌈
-
--->
-<!-- PIGEONPOSSE END MARK -->
-
 # Backan - Builder
 
 <!-- PIGEONPOSSE START HEADER -->
@@ -118,3 +78,43 @@ This software is licensed with **[GPL-3.0](/LICENSE)**.
 
 </p>
 <!-- PIGEONPOSSE END ORG -->
+
+<!-- PIGEONPOSSE START MARK -->
+<!--
+██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗   ██╗   
+██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗  ██║   
+██████╔╝██║██║  ███╗█████╗  ██║   ██║██╔██╗ ██║   
+██╔═══╝ ██║██║   ██║██╔══╝  ██║   ██║██║╚██╗██║   
+██║     ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║   
+╚═╝     ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝  ╚═══╝   
+                                                  
+██████╗  ██████╗ ███████╗███████╗███████╗         
+██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝         
+██████╔╝██║   ██║███████╗███████╗█████╗           
+██╔═══╝ ██║   ██║╚════██║╚════██║██╔══╝           
+██║     ╚██████╔╝███████║███████║███████╗         
+╚═╝      ╚═════╝ ╚══════╝╚══════╝╚══════╝         
+                                                  
+                                                  
+                                                  
+█████╗█████╗█████╗█████╗█████╗█████╗█████╗        
+╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝        
+                                                  
+                                                  
+                                                  
+██████╗  █████╗  ██████╗██╗  ██╗ █████╗ ███╗   ██╗
+██╔══██╗██╔══██╗██╔════╝██║ ██╔╝██╔══██╗████╗  ██║
+██████╔╝███████║██║     █████╔╝ ███████║██╔██╗ ██║
+██╔══██╗██╔══██║██║     ██╔═██╗ ██╔══██║██║╚██╗██║
+██████╔╝██║  ██║╚██████╗██║  ██╗██║  ██║██║ ╚████║
+╚═════╝ ╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝
+                                                                      
+                                                
+REPOSITORY: https://github.com/pigeonposse/backan
+AUTHORS: 
+	- Angelo (https://github.com/angelespejo)
+
+DEVELOPED BY Angelo 🐦🌈
+
+-->
+<!-- PIGEONPOSSE END MARK -->
diff --git a/packages/builder/examples/main.ts b/packages/builder/examples/main.ts
@@ -2,7 +2,7 @@ import { resolve } from 'node:path'
 import { build }   from '../src/main'
 // import { build } from '../dist/main'
 
-await build( {
+build( {
 	input : resolve( 'examples/server.ts' ),
 	// name   : 'backan',
 	// outDir : resolve( 'build' ),

diff --git a/packages/builder/package.json b/packages/builder/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@backan/builder",
-	"version": "0.0.4",
+	"version": "0.0.5",
 	"type": "module",
 	"license": "GPL-3.0",
 	"homepage": "https://backan.pigeonposse.com/guide/api",

diff --git a/packages/builder/src/bin.ts b/packages/builder/src/bin.ts
@@ -1,5 +1,5 @@
 import { build } from './main'
 
-await build( {
+build( {
 	input : '',
 } )
diff --git a/packages/builder/src/const.ts b/packages/builder/src/const.ts
@@ -0,0 +1,20 @@
+export const target = 'node20'
+export const name = 'BACKAN-BUILDER'
+export const ERROR_ID = {
+	NO_INPUT        : 'NO_INPUT',
+	PLATFORM_UNKWON : 'PLATFORM_UNKWON',
+	ON_ESBUILD      : 'ON_ESBUILD',
+	ON_NCC          : 'ON_NCC',
+	ON_PKG          : 'ON_PKG',
+	UNEXPECTED      : 'UNEXPECTED',
+} as const
+export const BUILDER_TYPE = {
+	ALL : 'all',
+	CJS : 'cjs',
+	BIN : 'bin',
+} as const
+
+export const ARCH = {
+	ARM64 : 'arm64',
+	X64   : 'x64',
+} as const