feat: add Jaspr framework detection

.github/workflows/tests.yml

@@ -14,6 +14,7 @@ jobs:
       uses: shivammathur/setup-php@v2
       with:
         php-version: '8.3'
+        extensions: yaml
 
     - name: Validate composer.json and composer.lock
       run: composer validate --strict

README.md

@@ -13,6 +13,8 @@ Install using composer:
 composer require utopia-php/detector
 ```
 
+Requires the `yaml` extension — see [System Requirements](#system-requirements).
+
 Init in your application:
 ```php
 <?php
@@ -125,6 +127,7 @@ Framework Adapters:
 |---------|---------|
 | Astro | ✅ |
 | Flutter | ✅ |
+| Jaspr | ✅ |
 | NextJs | ✅ |
 | Nuxt | ✅ |
 | Remix | ✅ |
@@ -152,7 +155,13 @@ Rendering Adapters:
 
 ## System Requirements
 
-Utopia Detector requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
+Utopia Detector requires PHP 8.0 or later with the `json` and `yaml` extensions. We recommend using the latest PHP version whenever possible.
+
+`json` ships with PHP. `yaml` is a PECL extension, used to read `pubspec.yaml` manifests:
+
+```bash
+pecl install yaml
+```
 
 
 ## Contributing

composer.json

@@ -27,7 +27,9 @@
     }
   },
   "require": {
-    "php": ">=8.0"
+    "php": ">=8.0",
+    "ext-json": "*",
+    "ext-yaml": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^9.4",

src/Detection/Framework/Flutter.php

@@ -19,6 +19,14 @@ public function getFiles(): array
         return ['pubspec.yaml', 'pubspec.lock'];
     }
 
+    /**
+     * @return array<string>
+     */
+    public function getPackages(): array
+    {
+        return ['flutter'];
+    }
+
     public function getInstallCommand(): string
     {
         return '';

src/Detection/Framework/Jaspr.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Utopia\Detector\Detection\Framework;
+
+/**
+ * Not a Flutter derivative, but detected from the same pubspec files. Extending
+ * Flutter makes Jaspr the more specific match, so it wins once a jaspr package
+ * shows up and loses an ambiguous pubspec whatever order the options were added in.
+ */
+class Jaspr extends Flutter
+{
+    public function getName(): string
+    {
+        return 'jaspr';
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getPackages(): array
+    {
+        return \array_merge(['jaspr', 'jaspr_builder'], parent::getPackages());
+    }
+
+    public function getInstallCommand(): string
+    {
+        return 'dart pub get';
+    }
+
+    public function getBuildCommand(): string
+    {
+        return 'jaspr build';
+    }
+
+    public function getOutputDirectory(): string
+    {
+        return './build/jaspr';
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getConfigFiles(): array
+    {
+        return ['pubspec.yaml'];
+    }
+
+    /**
+     * Reads `jaspr.mode`, which builds a server executable in `server` mode
+     * and web assets in `static` and `client` mode.
+     */
+    public function getAdapter(string $configContent): string
+    {
+        $pubspec = @\yaml_parse($configContent);
+        $config = \is_array($pubspec) ? ($pubspec['jaspr'] ?? null) : null;
+
+        if (! \is_array($config)) {
+            return '';
+        }
+
+        return match ($config['mode'] ?? null) {
+            'server' => 'ssr',
+            'static', 'client' => 'static',
+            default => '',
+        };
+    }
+}

src/Detection/Rendering/SSR.php

@@ -16,6 +16,7 @@ class SSR extends Rendering
         'analog' => ['server/index.mjs'],
         'tanstack-start' => ['server/server.js', 'server/index.mjs'],
         'flutter' => [],
+        'jaspr' => ['app'],
         'lynx' => [],
     ];
 

src/Detector/Framework.php

@@ -11,6 +11,15 @@ class Framework extends Detector
     public const INPUT_FILE = 'file';
     public const INPUT_PACKAGES = 'packages';
 
+    private const DEPENDENCY_SECTIONS = [
+        'dependencies',
+        'devDependencies',
+        'peerDependencies',
+        'optionalDependencies',
+        'dev_dependencies',
+        'dependency_overrides',
+    ];
+
     /**
      * @var array<FrameworkDetection>
      */
@@ -46,7 +55,7 @@ public function detect(): ?FrameworkDetection
         $files = array_map(fn ($input) => $input['content'], $files);
 
         $packages = array_filter($this->inputs, fn ($input) => $input['type'] === self::INPUT_PACKAGES);
-        $packages = array_map(fn ($input) => $input['content'], $packages);
+        $packages = array_map(fn ($input) => $this->dependencies($input['content']), $packages);
 
         // List of frameworks with count of matches
         $frameworkMatches = [];
@@ -63,9 +72,9 @@ public function detect(): ?FrameworkDetection
 
         foreach ($this->options as $detector) {
             // Check package-based detection
-            foreach ($packages as $packageJson) {
+            foreach ($packages as $dependencies) {
                 foreach ($detector->getPackages() as $packageNeeded) {
-                    if (str_contains($packageJson, '"'.$packageNeeded.'"')) {
+                    if (\in_array($packageNeeded, $dependencies, true)) {
                         $frameworkMatches[$detector->getName()] += 1;
                     }
                 }
@@ -125,4 +134,34 @@ public function detect(): ?FrameworkDetection
 
         return null;
     }
+
+    /**
+     * Reads declared dependency names out of a `package.json` or a `pubspec.yaml`.
+     *
+     * @return array<string>
+     */
+    protected function dependencies(string $manifest): array
+    {
+        $parsed = \json_decode($manifest, true);
+
+        if (! \is_array($parsed)) {
+            $parsed = @\yaml_parse($manifest);
+        }
+
+        if (! \is_array($parsed)) {
+            return [];
+        }
+
+        $dependencies = [];
+
+        foreach (self::DEPENDENCY_SECTIONS as $section) {
+            $packages = $parsed[$section] ?? null;
+
+            if (\is_array($packages)) {
+                $dependencies = \array_merge($dependencies, \array_map('strval', \array_keys($packages)));
+            }
+        }
+
+        return $dependencies;
+    }
 }