README

Utopia Detector is a simple library for fast and reliable environment identification. This library is aiming to be as simple and easy to learn and use. This library is maintained by the Appwrite team.

Getting Started

Install using composer:

composer require utopia-php/detector

Init in your application:

<?php

require_once __DIR__ . '/../../vendor/autoload.php';

use Utopia\Detector\Detector\Framework;
use Utopia\Detector\Detector\Packager;
use Utopia\Detector\Detector\Rendering;
use Utopia\Detector\Detector\Runtime;
use Utopia\Detector\Detector\Strategy;

// Initialise Packager Detection
$files = ['bun.lockb', 'fly.toml', 'package.json', 'remix.config.js'];
$detector = new Packager($files);
$detector
    ->addOption(new PNPM())
    ->addOption(new Yarn())
    ->addOption(new NPM());

$detectedPackager = $detector->detect();
$packagerName = $detectedPackager->getName();

// Initialise Runtime Detection
$detector = new Runtime(
    $files,
    new Strategy(Strategy::FILEMATCH), // similar for LANGUAGES and EXTENSIONS
    'npm'
);

$detector
    ->addOption(new Node())
    ->addOption(new Bun())
    ->addOption(new Deno())
    ->addOption(new PHP())
    ->addOption(new Python())
    ->addOption(new Dart())
    ->addOption(new Swift())
    ->addOption(new Ruby())
    ->addOption(new Java())
    ->addOption(new CPP())
    ->addOption(new Dotnet());

$detectedRuntime = $detector->detect();
$runtime = $detectedRuntime->getName();
$runtimeCommands = $detectedRuntime->getCommands();

// Initialise Framework Detection
$files = ['src', 'types', 'makefile', 'components.js', 'debug.js', 'package.json', 'svelte.config.js'];
$packager = 'npm';
$detector = new Framework($files, $packager);

$detector
    ->addOption(new Flutter())
    ->addOption(new Nuxt())
    ->addOption(new Astro())
    ->addOption(new Analog())
    ->addOption(new Angular())
    ->addOption(new Remix())
    ->addOption(new SvelteKit())
    ->addOption(new Lynx())
    ->addOption(new NextJs());

$detectedFramework = $detector->detect();
$framework = $detectedFramework->getName();
$frameworkInstallCommand = $framework = $detectedFramework->getInstallCommand();

// Initialise Rendering Detection
$files = ['./build/server/index.js', './build/server/renderers.js'];
$framework = 'remix';
$detector = new Rendering($files, $framework);
$detector
    ->addOption(new SSR())
    ->addOption(new Static());

$detectedRendering = $detector->detect();
$rendering = $detectedRendering->getName();

Supported Adapters

Detector Adapters:

Runtime Adapters:

Framework Adapters:

Packager Adapters:

Rendering Adapters:

✅ - supported, 🛠 - work in progress

System Requirements

Utopia Detector requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.

Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send us a pull request.

You can refer to the Contributing Guide for more info.

Tests

To run all tests, use the following command:

composer test

Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php