Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 3.2 KB

README.md

File metadata and controls

111 lines (76 loc) · 3.2 KB
Raw

Package manager

Integrity check

Search all package dependencies automatically and register to your project.

📦 Installation & Basic Usage

Simply use Composer:

$ composer require baraja-core/package-manager

And add to your project composer.json this scripts section:

"scripts": {
   "post-autoload-dump": "Baraja\\PackageManager\\PackageRegistrator::composerPostAutoloadDump"
}

Now is your project configured.

After each composer ... command this Package Manager will be called automatically.

🛠️ How to use

In Booting class add create new instance of PackageRegistrator:

new PackageRegistrator(
   __DIR__ . '/../',    // root path
   __DIR__ . '/../temp' // temp path
);

Notice: PackageRegistrator can work alone, Nette framework is not required, only recommended.

🗃️ Package.neon

Imagine you want install new package. Then it you must set specific configuration to your project common.neon.

PackageRegistrator can scan all your installed packages and automatically create package.neon file with merged configuration. In your common.neon you define changes only and required parameters.

For correct work to app/Booting.php add generated configuration.

$configurator->addConfig(__DIR__ . '/config/package.neon')

Warning: Configuration file can be different in all environment. Commit to repository is not recommended.

👷‍♀️ Tasks

After creating internal container with list of packages, call list of special tasks.

Default task list (but you can add more):

  • Config local neon creator and normalizer
  • Assets from packages copier
  • Project composer.json normalizer
  • Clear cache

If you want add your own task, simply create class with name *Task implementing ITask interface. Package manager will find your class automatically in your project or shared package.

Order of tasks can be defined by Priority: xxx doc comment anotation.

🗺️ Default project assert manager

In case of your package contain directory with name install or update, all inner content will be copied to your project automatically.

Structure in directory is same as your project root.

Name convention:

  • install copy file and directories only in case when does not exist in your project structure,
  • update rewrite your project files in all composer actions.

If you want create file jquery.js to /www/js for example, simply define package structure:

/src
   - files...
/install
   /www
      /js
         - jquery.js
- composer.json

📄 License

baraja-core/package-manager is licensed under the MIT license. See the LICENSE file for more details.