initial commit

CHANGELOG.md

@@ -6,3 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [1.0.0] - 2024-03-18
+
+### Added
+
+- Initial release!

README.md

@@ -1,22 +1,32 @@
-title_goes_here [![required php version](https://img.shields.io/packagist/php-v/open-southeners/packagist_package_here)](https://www.php.net/supported-versions.php) [![codecov](https://codecov.io/gh/open-southeners/packagist_package_here/branch/main/graph/badge.svg?token=codecov_badge_token)](https://codecov.io/gh/open-southeners/packagist_package_here) [![Edit on VSCode online](https://img.shields.io/badge/vscode-edit%20online-blue?logo=visualstudiocode)](https://vscode.dev/github/open-southeners/packagist_package_here)
-===
+# Laravel Console File Menu [![required php version](https://img.shields.io/packagist/php-v/open-southeners/laravel-console-file-menu)](https://www.php.net/supported-versions.php) [![codecov](https://codecov.io/gh/open-southeners/laravel-console-file-menu/branch/main/graph/badge.svg?token=BpXj7Mh1c9)](https://codecov.io/gh/open-southeners/laravel-console-file-menu) [![Edit on VSCode online](https://img.shields.io/badge/vscode-edit%20online-blue?logo=visualstudiocode)](https://vscode.dev/github/open-southeners/laravel-console-file-menu)
 
-and_description_here
+Like NunoMaduro's [console file menu package](https://github.com/nunomaduro/laravel-console-menu) but for files
 
-**Search & replace:**
-
-| Keys                                                      | Replacement                                                   |
-| --------------------------------------------------------- | ------------------------------------------------------------- |
-| `title_goes_here`                                         | Fancy title from the repository (only README and stuff)       |
-| `and_description_here`                                    | Short package description (only for README and composer.json) |
-| `packagist_package_here`                                  | Packagist (composer) published package name                   |
-| `codecov_badge_token`                                           | Codecov token for the coverage badge                          |
-| `OpenSoutheners\PhpPackage`, `OpenSoutheners\\PhpPackage` | PSR-0 and PSR-4 complaint package namespace                   |
+![screenshot](art/screenshot.png)
 
 ## Getting started
 
 ```
-composer require open-southeners/packagist_package_here
+composer require open-southeners/laravel-console-file-menu
+```
+
+Start using it by copying code from below:
+
+```php
+use NunoMaduro\LaravelConsoleMenu\Menu;
+
+// In between your command's code:
+$result = $this->fileMenu('/base/path')
+    // Customise the underlying menu here: https://github.com/php-school/cli-menu?tab=readme-ov-file#appearance
+    ->customise(fn (Menu $menu) => $menu->setForegroundColour('green')
+        ->setBackgroundColour('black')
+    )
+    ->onlyDirectories(false)
+    ->hideFileExtensions(false)
+    ->respectIgnored(true)
+    ->open();
+
+// $result will contain the full file/directory selected path or null otherwise
 ```
 
 ## Partners
@@ -25,4 +35,4 @@ composer require open-southeners/packagist_package_here
 
 ## License
 
-This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

composer.json

@@ -1,52 +1,58 @@
 {
-    "name": "open-southeners/packagist_package_here",
-    "description": "and_description_here",
-    "license": "MIT",
-    "keywords": [
-        "open-southeners"
-    ],
-    "authors": [
-        {
-            "name": "Ruben Robles",
-            "email": "[email protected]",
-            "homepage": "https://d8vjork.com"
-        }
-    ],
-    "funding": [
-        {
-            "type": "github",
-            "url": "https://github.com/sponsors/open-southeners"
-        }
-    ],
-    "require": {
-        "php": "^8.1"
-    },
-    "require-dev": {
-        "larastan/larastan": "^2.0",
-        "orchestra/testbench": "^8.0 || ^9.0",
-        "phpstan/phpstan": "^1.0",
-        "phpunit/phpunit": "^10.0"
-    },
-    "minimum-stability": "stable",
-    "prefer-stable": true,
-    "autoload": {
-        "psr-4": {
-            "OpenSoutheners\\PhpPackage\\": "src"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "OpenSoutheners\\PhpPackage\\Tests\\": "tests"
-        }
-    },
-    "config": {
-        "sort-packages": true
-    },
-    "extra": {
-        "laravel": {
-            "providers": [
-                "OpenSoutheners\\PhpPackage\\ServiceProvider"
-            ]
-        }
+  "name": "open-southeners/laravel-console-file-menu",
+  "description": "Laravel Console Menu for files and directories",
+  "license": "MIT",
+  "keywords": [
+    "open-southeners",
+    "files",
+    "symfony-finder",
+    "console",
+    "command-line",
+    "php",
+    "cli",
+    "laravel-zero",
+    "laravel",
+    "artisan",
+    "symfony"
+  ],
+  "authors": [
+    {
+      "name": "Ruben Robles",
+      "email": "[email protected]",
+      "homepage": "https://d8vjork.com"
     }
-}
+  ],
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/open-southeners"
+    }
+  ],
+  "require": {
+    "php": "^8.1",
+    "illuminate/console": "^10.0 || ^11.0",
+    "illuminate/support": "^10.0 || ^11.0",
+    "nunomaduro/laravel-console-menu": "^3.5.0",
+    "symfony/finder": "^6.2 || ^7.0"
+  },
+  "require-dev": {
+    "larastan/larastan": "^2.0",
+    "phpstan/phpstan": "^1.0",
+    "phpunit/phpunit": "^10.0"
+  },
+  "minimum-stability": "stable",
+  "prefer-stable": true,
+  "autoload": {
+    "psr-4": {
+      "OpenSoutheners\\LaravelConsoleFileMenu\\": "src"
+    }
+  },
+  "config": {
+    "sort-packages": true
+  },
+  "extra": {
+    "laravel": {
+      "providers": ["OpenSoutheners\\LaravelConsoleFileMenu\\ServiceProvider"]
+    }
+  }
+}