Devlink local

Author: mooxbot

README.md

@@ -36,8 +36,8 @@ composer.json-deploy
 3. When running `php init.php`
 
     - Creates a `.env` file from `.env.example`
-    - Copies `composer.json-deploy` to `composer.json`
-    - Runs `composer install`
+    - Copies `composer.json-linked` to `composer.json`
+    - Runs `composer update`
 
 4. When running `devlink:status`:
 
@@ -50,7 +50,7 @@ composer.json-deploy
     - Creates the packages folder, if it does not exist
     - Creates symlinks for all configured packages
     - Updates composer.json with development configuration
-    - Creates composer.json-deploy for production use
+    - Creates composer.json-linked for production use
     - Asks to run `composer install`
     - Asks to run `php artisan optimize:clear`
     - Asks to run `php artisan queue:restart`
@@ -59,25 +59,23 @@ composer.json-deploy
 
     - Removes all symlinks
     - Deletes the packages folder, if empty
-    - Restores production-ready composer.json from composer.json-deploy
+    - Restores production-ready composer.json from composer.json-linked
     - Asks to run `composer install`
     - Asks to run `php artisan optimize:clear`
     - Asks to run `php artisan queue:restart`
 
 7. CI Safety Net - `deploy.sh`:
 
-    - If composer.json-deploy exists in the repository:
+    - If composer.json-linked exists in the repository:
         - Remove all symlinks from /packages
-        - rename composer.json-deploy to composer.json
+        - rename composer.json-linked to composer.json
     - Commit and push the change in your GitHub Action
 
-## Mac
-
-Mac works out of the box. You can have local packages mixed with the symlinked packages in your `/packages` folder.
+Mac and Linux work out of the box. You can have local packages mixed with the symlinked packages in your `/packages` folder.
 
 ![Moox Devlink](./devlink-mix.jpg)
 
-## Windows
+### Windows
 
 On Windows there are most probably some issues with ignoring symlinks. If you run into issues, you can either globally or project-wise disable the symlinks or do the following:
 

ROADMAP.md

@@ -10,4 +10,4 @@ We are working on the following tasks from top to bottom. Please don't forget to
 
 ## Ideas
 
--   [ ] Deploy: new feature: last version for all packages instead of \*
+-   [ ] Deploy feature: last version for all packages instead of \*

config/devlink.php

@@ -38,37 +38,37 @@
     | Packages
     |--------------------------------------------------------------------------
     |
-    | The packages that should be linked into the project.
+    | These packages are symlinked (or if local, just added) into the project.
     |
     | Active:
     | Toggle the package on and off. By default all packages are disabled.
     |
-    | Linked:
-    | Toggle the package off for linking, for example devlink itself.
-    |
     | Path:
     | The path to the package in the packages directory.
     |
+    | Repo-URL:
+    | The URL of the private repository (Satis).
+    |
     | Types:
     | - public = installed from Packagist
-    | - private = copied into the project
+    | - private = installed from Satis
+    | - local = local package
     |
-    | Deploy:
-    | Toggle the package on and off for deployment. Better would be to use
-    | require-dev in composer.json, but this also works.
+    | Dev:
+    | The package is only installed in the dev environment (require-dev).
     |
     */
     'packages' => [
 
-        // Moox
+        // Public
         'audit' => [
             'active' => false,
             'path' => $public_base_path.'/audit',
             'type' => 'public',
         ],
         'backup-server-ui' => [
             'active' => false,
-            'path' => $public_base_path.'/backup-server-ui',
+            'path' => '../moox-server/packages/backup-server-ui',
             'type' => 'public',
         ],
         'builder' => [
@@ -94,7 +94,7 @@
         ],
         'devops' => [
             'active' => false,
-            'path' => $public_base_path.'/devops',
+            'path' => '../moox-server/packages/devops',
             'type' => 'public',
         ],
         'expiry' => [
@@ -168,7 +168,7 @@
             'type' => 'public',
         ],
 
-        // Moox Pro
+        // Private
         'media' => [
             'active' => false,
             'path' => $private_base_path.'/media',

deploy.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ -f "composer.json-deploy" ]; then
+if [ -f "composer.json-linked" ]; then
     find packages -type l -delete
-    cp composer.json-deploy composer.json
+    cp composer.json-linked composer.json
 fi

init.php

@@ -17,7 +17,7 @@
 file_put_contents('.env', $env);
 
 if (file_exists('composer.json-deploy')) {
-    copy('composer.json-deploy', 'composer.json');
+    copy('composer.json-linked', 'composer.json');
 }
 
-exec('composer install');
+exec('composer update');

src/Console/Traits/Check.php

@@ -35,28 +35,41 @@ private function check(): array
 
         foreach ($config['packages'] as $name => $package) {
             $packagePath = "packages/{$name}";
+            $isLocal = ($package['type'] ?? '') === 'local';
+            $isPrivate = ($package['type'] ?? '') === 'private';
 
-            // Check if package is in repositories
+            // Check if package is linked
             $isLinked = false;
-            foreach ($repositories as $repo) {
-                if (($repo['type'] ?? '') === 'path' && ($repo['url'] ?? '') === $packagePath) {
-                    $isLinked = true;
-                    break;
+            if ($isLocal) {
+                // Local packages: check for path entry in composer.json
+                foreach ($repositories as $repo) {
+                    if (($repo['type'] ?? '') === 'path' && ($repo['url'] ?? '') === $packagePath) {
+                        $isLinked = true;
+                        break;
+                    }
                 }
+            } else {
+                // Public and Private packages: check for symlink
+                $isLinked = is_link($packagePath);
             }
 
             $packagesArray[$name] = $package;
+
             $realPackages[$name] = [
                 'name' => $name,
                 'type' => $package['type'] ?? 'unknown',
                 'active' => $package['active'] ?? false,
                 'link' => $package['linked'] ?? true,
                 'deploy' => $package['deploy'] ?? false,
-                'valid' => is_dir($package['path']),
+                'valid' => match (true) {
+                    $isLocal => is_dir($packagePath),
+                    $isPrivate => is_dir($package['path'] ?? ''),
+                    default => is_dir($package['path'] ?? ''),
+                },
                 'linked' => $isLinked,
             ];
 
-            if (str_contains($package['path'], 'disabled')) {
+            if (! $isPrivate && isset($package['path']) && str_contains($package['path'], 'disabled')) {
                 unset($realPackages[$name]);
             }
         }

src/Console/Traits/Deploy.php

@@ -11,8 +11,7 @@ private function deploy(): void
     {
         $this->unlink();
         $this->cleanup();
-        $this->restore();
-        $this->createDeployComposerJson();
+        $this->moveComposerFiles();
     }
 
     /**
@@ -41,69 +40,24 @@ private function cleanup(): void
         if (is_dir($this->packagesPath) && count(scandir($this->packagesPath)) === 2) {
             info('Removing packages directory...');
             rmdir($this->packagesPath);
-        } else {
-            $this->errorMessage = 'Packages directory not found!';
-            error($this->errorMessage);
         }
     }
 
-    /**
-     * Restore the composer.json file from the backup.
-     */
-    private function restore(): void
+    private function moveComposerFiles(): void
     {
-        $source = $this->composerJsonPath.'-deploy';
-        $destination = $this->composerJsonPath;
+        $linked = $this->composerJsonPath.'-linked';
+        $deploy = $this->composerJsonPath.'-deploy';
 
-        if (file_exists($source)) {
-            unlink($destination);
-            copy($source, $destination);
-            info('Restored composer.json from composer.json-deploy');
-        } else {
-            $this->errorMessage = 'composer.json-deploy not found!';
+        if (! file_exists($linked)) {
+            $this->errorMessage = 'composer.json-linked not found!';
             error($this->errorMessage);
-        }
-    }
-
-    private function createDeployComposerJson(): void
-    {
-        if (! file_exists($this->composerJsonPath)) {
-            $this->error('composer.json not found!');
 
             return;
         }
 
-        $composerContent = file_get_contents($this->composerJsonPath);
-        $composerJson = json_decode($composerContent, true);
-
-        if (json_last_error() !== JSON_ERROR_NONE) {
-            $this->error('Invalid composer.json format: '.json_last_error_msg());
-
-            return;
-        }
-
-        $deployJson = $composerJson;
-        $repositories = $deployJson['repositories'] ?? [];
-        $filteredRepos = [];
-
-        foreach ($repositories as $repo) {
-            if (($repo['type'] ?? '') !== 'path') {
-                $filteredRepos[] = $repo;
-            }
-        }
-
-        if (empty($filteredRepos)) {
-            unset($deployJson['repositories']);
-        } else {
-            $deployJson['repositories'] = $filteredRepos;
-        }
-
-        $deployPath = dirname($this->composerJsonPath).'/composer.json-deploy';
-        file_put_contents(
-            $deployPath,
-            json_encode($deployJson, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)."\n"
-        );
-
-        info('Created composer.json-deploy with non-path repositories');
+        rename($this->composerJsonPath, $deploy);
+        rename($linked, $this->composerJsonPath);
+        info('Moved composer.json to composer.json-deploy');
+        info('Moved composer.json-linked to composer.json');
     }
 }