Merge pull request #60 from francescovallone/develop

Release Version 0.6 of Serinus and update all related packages
francescovallone · Aug 1, 2024 · b072539 · b072539
2 parents 38902dd + c769a0e
commit b072539
Show file tree

Hide file tree

Showing 298 changed files with 11,827 additions and 1,663 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/workflows/serinus_cli_tests.yml b/.github/workflows/serinus_cli_tests.yml
@@ -0,0 +1,42 @@
+name: Serinus CLI Tests
+
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:    
+    defaults:
+      run:
+        working-directory: ./packages/serinus_cli
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v3
+
+      - name: 🎯 Setup Dart
+        uses: dart-lang/setup-dart@v1
+
+      - name: 📦 Install Dependencies
+        run: dart pub get
+
+      # - name: 🕵️ Analyze
+      #   run: dart analyze --fatal-infos --fatal-warnings .
+
+      - name: 🧪 Run Tests
+        run: |
+          dart pub global activate coverage
+          dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
+      
+      - name: 📊 Check Code Coverage
+        uses: VeryGoodOpenSource/very_good_coverage@v2
+        with:
+          path: ./packages/serinus_cli/coverage/lcov.info
+          min_coverage: 0
+
+      # - name: Upload coverage reports to Codecov
+      #   uses: codecov/codecov-action@v4
+      #   env:
+      #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/serinus_config_tests.yml b/.github/workflows/serinus_config_tests.yml
@@ -0,0 +1,42 @@
+name: Serinus Config Tests
+
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:    
+    defaults:
+      run:
+        working-directory: ./packages/serinus_config
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v3
+
+      - name: 🎯 Setup Dart
+        uses: dart-lang/setup-dart@v1
+
+      - name: 📦 Install Dependencies
+        run: dart pub get
+
+      # - name: 🕵️ Analyze
+      #   run: dart analyze --fatal-infos --fatal-warnings .
+
+      - name: 🧪 Run Tests
+        run: |
+          dart pub global activate coverage
+          dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
+      
+      - name: 📊 Check Code Coverage
+        uses: VeryGoodOpenSource/very_good_coverage@v2
+        with:
+          path: ./packages/serinus_config/coverage/lcov.info
+          min_coverage: 0
+
+      # - name: Upload coverage reports to Codecov
+      #   uses: codecov/codecov-action@v4
+      #   env:
+      #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/serinus_rate_limiter_tests.yml b/.github/workflows/serinus_rate_limiter_tests.yml
@@ -0,0 +1,42 @@
+name: Serinus Rate Limiter Tests
+
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:    
+    defaults:
+      run:
+        working-directory: ./packages/rate_limiter
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v3
+
+      - name: 🎯 Setup Dart
+        uses: dart-lang/setup-dart@v1
+
+      - name: 📦 Install Dependencies
+        run: dart pub get
+
+      # - name: 🕵️ Analyze
+      #   run: dart analyze --fatal-infos --fatal-warnings .
+
+      - name: 🧪 Run Tests
+        run: |
+          dart pub global activate coverage
+          dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
+      
+      - name: 📊 Check Code Coverage
+        uses: VeryGoodOpenSource/very_good_coverage@v2
+        with:
+          path: ./packages/rate_limiter/coverage/lcov.info
+          min_coverage: 0
+
+      # - name: Upload coverage reports to Codecov
+      #   uses: codecov/codecov-action@v4
+      #   env:
+      #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/serinus_tests.yml b/.github/workflows/serinus_tests.yml
@@ -29,7 +29,7 @@ jobs:
         run: |
           dart pub global activate coverage
           export SERINUS_TEST=true
-          dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
+          dart test --coverage=coverage && dart pub global run coverage:format_coverage --check-ignore --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
       
       - name: 📊 Check Code Coverage
         uses: VeryGoodOpenSource/very_good_coverage@v2

diff --git a/.idea/.name b/.idea/.name
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/runConfigurations/melos_bootstrap.xml b/.idea/runConfigurations/melos_bootstrap.xml
diff --git a/.idea/runConfigurations/melos_clean.xml b/.idea/runConfigurations/melos_clean.xml
diff --git a/.website/.vitepress/config.mts b/.website/.vitepress/config.mts
@@ -3,12 +3,17 @@ import { defineConfig } from 'vitepress'
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: "Serinus",
-  titleTemplate: 'Serinus - Dart Backend Framework',
+  titleTemplate: ':title - Serinus | Dart Backend Framework',
   description: "Serinus is a framework written in Dart for building efficient and scalable server-side applications.",
   head: [
     ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/serinus-icon-32x32.png"}],
     ['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/serinus-icon-16x16.png"}],
   ],
+  markdown: {
+    image: {
+      lazyLoading: true
+    }
+  },
   lastUpdated: true,
   appearance: 'force-dark',
   themeConfig: {
@@ -23,28 +28,60 @@ export default defineConfig({
     },
     nav: [
       {
-        text: 'pub.dev',
+        text: 'Guide',
+        link: '/in_a_nutshell'
+      },
+      {
+        text: 'Pub.dev',
         link: 'https://pub.dev/packages/serinus'
       },
     ],
     sidebar: [
       {
         items: [
-          { text: 'Introduction', link: '/introduction' },
           {
-            text: 'Overview',
-            base: '/overview/',
-            collapsed: false,
+            text: 'Getting Started',
+            items: [
+              { text: 'In a nutshell', link: '/in_a_nutshell' },
+              { text: 'Quick Start', link: '/quick_start' },
+              { text: 'What\'s next?', link: '/whats_next' }
+            ]
+          },
+          {
+            text: 'Foundations',
+            base: '/foundations/',
+            collapsed: true,
+            items: [
+              { text: 'Paths', link: 'paths' },
+              { text: 'Handler', link: 'handler' },
+              { text: 'RequestContext', link: 'request_context' },
+              { text: 'Dependency Inejction', link: 'dependency_injection' },
+              { text: 'Request Lifecycle', link: 'request_lifecycle' },
+            ]
+          },
+          {
+            text: 'Core Concepts',
+            base: '/core/',
+            collapsed: true,
             items: [
-              { text: 'Getting Started', link: 'getting_started' },
               { text: 'Modules', link: 'modules' },
               { text: 'Controllers', link: 'controllers' },
               { text: 'Routes', link: 'routes' },
               { text: 'Providers', link: 'providers' },
+              { text: 'Metadata', link: 'metadata' },
               { text: 'Middlewares', link: 'middlewares' },
               { text: 'WebSockets', link: 'websockets' },
               { text: 'Hooks', link: 'hooks' },
-              { text: 'Shelf Interoperability', link: 'shelf_interop' }
+              { text: 'Exceptions', link: 'exceptions' },
+              { text: 'Tracer', link: 'tracer' },
+            ]
+          },
+          {
+            base: '/validation/',
+            text: 'Validation',
+            collapsed: true,
+            items: [
+              { text: 'Schema', link: 'schema' },
             ]
           },
           {
@@ -56,12 +93,9 @@ export default defineConfig({
               { text: 'Versioning', link: 'versioning' },
               { text: 'Global Prefix', link: 'global_prefix' },
               { text: 'Body Size Limit', link: 'body_size_limit' },
+              { text: 'Shelf Interoperability', link: 'shelf_interop' }
             ]
           },
-          {
-            text: 'Request Lifecycle',
-            link: '/request_lifecycle'
-          },
           {
             text: 'Plugins',
             base: '/plugins/',
@@ -96,7 +130,7 @@ export default defineConfig({
               { text: 'Globe', link: 'globe' },
               { text: 'VPS', link: 'vps' },
             ],
-          }
+          }, 
         ]
       },
     ],

diff --git a/.website/.vitepress/theme/style.css b/.website/.vitepress/theme/style.css
@@ -131,4 +131,8 @@
 }
 .vp-btn-custom:hover, .vp-doc a.vp-btn-custom:hover {
 	color: rgb(23,23,23);
+}
+
+html {
+	scroll-behavior: smooth;
 }
diff --git a/.website/components/btn-link.vue b/.website/components/btn-link.vue
@@ -0,0 +1,14 @@
+<script setup>
+defineProps({
+	title: String,
+	description: String,
+	link: String
+})
+</script>
+
+<template>
+	<a :href="link" class="p-4 flex flex-col gap-2 bg-gray-950/25 rounded-lg !no-underline border-2 border-transparent !transition-all !ease-in-out hover:border-orange-500">
+		<h3 class="text-md text-white !m-0">{{ title }}</h3>
+		<p class="text-sm text-gray-400 !m-0">{{ description }}</p>
+	</a>
+</template>