Extension development using composer repositories path

sanjays

hi
on "composer update" its deleting my local repository

luceos

sanjays its deleting my local repository

Are you referring to the vendor or extension folder? Please be more specific.

sanjays

luceos extension

extension folder

sanjays

@luceos
I am also getting same error as
'ReflectionException' with message 'Class Cit\Tracker\Listeners\AddFootPrintJs does not exist'
i follow the given guideline for extension develop till hello world , its work fine

I tried to build stand ways as mention by flagrow with same directory structure

extensions
cit-tracker
assets
js
cittracker.js
src

Listeners
AddFootPrintJs.php

    bootstrap.php       
    composer.json

I have also added

require
"cit/cit-tracker": "*@dev" in root composer.json

"repositories": [
        {
            "type": "path",
            "url": "extensions/cit-tracker/"
        }
    ],

i also keep namespace as same for
namespace Cit\Tracker =>> boostrap.php ,
namespace Cit\Tracker\Listeners ==> AddFootPrintJs.php

But after composer update its removed the directory
please correct me if i am wrong some where
thanks for quick reply

sanjays

This is the
composer.json

{
    "name": "cit/cit-tracker",
    "description": "Configure Tracker!",
    "type": "flarum-extension",
    "require": {
        "flarum/core": "^0.1.0-beta.3"
    },
    "extra": {
        "flarum-extension": {
            "title": "CIT Tracker",
            "icon": {
                "name": "line-chart",
                "backgroundColor": "#01a6cb",
                "color": "#ffffff"
            }
        }
    },
    "autoload": {
        "psr-4": {
            "Cit\\Tracker\\": "src/"
        }
    }
}

luceos

Your repository should be in another directory, not in extensions. A symlink will be added by composer pointing from the directory set in the "path" "url" value to the extensions directory.

The directory structure in the base of your Flarum installation:

extensions
vendor
workbench
- cit-tracker
- composer.json

Now add in the composer.json of Flarum:

"repositories": [
        {
            "type": "path",
            "url": "workbench/*/"
        }
    ],

The rest looks ok. If pointing composer with the path directive to your extensions directory it will remove that directory if you already had your extension in there before.

sanjays

luceos hey thanks its work

franklingu

luceos what is the content in the composer.json inside workbench? you do not need that right? just need composer.json under my real package, in sanjays' case: inside cti-tracker?

jordanjay29

franklingu Correct, you need only create a "workbench" (name it as you please) type folder in the root directory of your flarum install, and then point to it in your flarum's composer.json as the tutorial indicates. Everything else is handled for you.

luceos

The "root" (flarum) composer holds the repositories - path reference to workbench/*/*. Inside your workbench you will create a directory with a unique name (don't use vendor/package). Inside the extension directory you do need to have a composer to help identify the package name to the root composer file.

So:

/composer.json - repositories[path] configured
/workbench/my-awesome-package/ -- your package git repository
/workbench/my-awesome-package/composer.json - [name=franklingu/some-extension]

Composer scans all workbench directories then and simply identifies whether a package with that name exists there.

SteveAzz

@luceos What is the equvilant of flarum/composer-installer it seems like that package got removed?

luceos

SteveAzz it's no longer in use, simply remove it from your composer file. It was dropped in b4 or 5 I think.

SteveAzz

So how do I mange to create the symlink? It keeps failing and just copying the file.

wuethrich

If you develop on windows you should use an absolute path to the workbench. Otherwise the extension doesn't get discovered.

    "repositories": [
        {
            "type": "path",
            "url": "C:/xampp/htdocs/flarum/workbench/*"
        }
    ],

c_costel

Thanks for this awesome post! I think your instructions should be added to the documentation. I really had no idea how to start off. Cheers!

iamdonli

Thanks for the explanation. I feel this should be added to the official tutorial too.

In case you don't want to run composer update, you can just run composer require yourExtName:*@dev to just add the extension.

zethon

luceos Register the package in your Flarum

Now once again edit the composer.json in the docroot. If your package name is not mentioned under require, add it. The value should be *@dev. Now with ssh run composer update and you should see that your package is now symlinked from the workbench directory.

Where it says "The value should be *@dev", what value exactly? Composer is not able to find a simple "Hello World" app, and I suspect it's probably because I don't know what value should be *@dev.

zethon

Figures I figured it out immediately after posting the question.

For anyone else wondering, it was a change in my root composer.json file:

    "flarum/flarum-ext-subscriptions": "^0.1.0",
    "flarum/flarum-ext-suspend": "^0.1.0",
    "flarum/flarum-ext-tags": "^0.1.0",
    "acme/flarum-hello-world": "*@dev"    
},
"repositories": [

I originally had "acme/flarum-hello-world": "^0.1.0".

DiegoPino

I am new in flarum and like so much, try to learn how to development a simple extension by myself and have two question:

in the folder workbench under docroot must be create another folder with the name of extention?, for example folder: flarum-ext-name-of-ext or can upload the files to that folder
When run composer update have the error,

See imagen for error

Thans in Advance for the support!

luceos

DiegoPino

Within workbench you have another folder for your extension. The name of this folder doesn't matter as composer will scan each directory inside of workbench for a composer.json file and use the name attribute. For your own sanity it makes sense to name it something so you can identify it with. For instance the folder for byobu is named "messaging" on one of my machines ever since I started out, because I decided on the name after creating the folder. So yes <flarum docroot>/workbench/<extension name>/composer.json is what matters.
This can be caused by several things, check for the following;
- are you running the command inside the flarum docroot?
- is your package constraint *@dev

Hope this helps.

Pollux

luceos is your package constraint `*@Davis

I guess you mean *@dev ?

DiegoPino

luceos I am not an expert in programming but I really like studying its environment and development for testing @luceos Thank You So Much and the community for the support, I am very happy because now have the development environment are ready and its very easy with composer

development environment are ready