Composer setup does not install the plugin in the libraries folder

Probably some issue on how you're using composer. Try to rm -rf http/libraries vendor and try to run composer install again.

No, it isn't because the module is also not setting up the installer-paths.

But yes, your site's root composer file must require composer/installers as yours seems to do. It makes no sense to specify a requirement on this, as the module is not really interested on what installs the w8tcha/ckeditor-wordcount-plugin package in web/libraries/{name} instead of in vendor/{name}.

Honestly, this seems to be a problem on your usage of composer. Try maybe to do the following:

rm -rf composer.lock http/core http/modules/contrib http/libraries
composer update

If the above installs the library in the right place, it means something in your existing composer.lock is the source of the problem.

I am able to reproduce this on a standard D8.9 composer install, where adding the project to the "installer-paths" for libraries doesn't seem to queue it for being placed into the defined and working libraries path (as seen by `drupal-ckeditor-libraries-group/notification`).

I wonder if this is the culprit?

https://getcomposer.org/doc/faqs/how-do-i-install-a-package-to-a-custom-...

Note: You cannot use this to change the path of any package. This is only applicable to packages that require composer/installers and use a custom type that it handles.

Indeed, I can confirm that the minimal setup doesn't work. I believe the reason this works for me is that I include the module as part of our company's profile, and the suceeding requirements manage to fool composer/installers into adding it in the right place.

I might have to fork the original repo to change the type to drupal-library.

Tried to require composer/installers to try to fool it into installing the plugin, but it still doesn't work right.

I've raised an issue with composer/installers at https://github.com/composer/installers/issues/460

I use this composer.json's configuration to download the librairy, I hope this could help you.

[
        {
            "type": "composer",
            "url": "https://packages.drupal.org/8"
        },
        {
            "type": "composer",
            "url": "https://asset-packagist.org"
        },
        {
            "type": "package",
            "package": {
                "name": "w8tchaw8tcha/ckeditor-wordcount-plugin",
                "version": "1.17.6",
                "type": "drupal-library",
                "dist": {
                    "url": "https://download.ckeditor.com/wordcount/releases/wordcount_1.17.6.zip",
                    "type": "zip"
                },
                "require": {
                    "composer/installers": "~1.0"
                }
            }
        }
    ],
 

Then composer require w8tchaw8tcha/ckeditor-wordcount-plugin

@weseze:
Thank you for your piece of code in #9, but I had to change your "http/" directory to "web/" (that is the common public directory Name in a Drupal composer installation) and the 2nd last comma must be removed.

So here is my working code that I added to my root composer.json file before the "extra" section:

    "scripts": {
        "post-install-cmd": [
            "cp -R vendor/w8tcha/ckeditor-wordcount-plugin web/libraries/"
        ],
        "post-update-cmd": [
            "cp -R vendor/w8tcha/ckeditor-wordcount-plugin web/libraries/"
        ]
    },

After that a composer require drupal/ckwordcount worked fine: The library is in the web/libraries/ckeditor-wordcount-plugin/ directory (as well as in the Vendor/w8tcha/ckeditor-wordcount-plugin/ directory where it isn't needed).

Maybe a composer require composer/installers is needed before to prevent composer from overwriting your modifications in composer.json file. But I am not sure if it is needed.

@guisharko:
Can you explain your solution from #12 more detailed. I think by creating your "wrapper" package the version is fixed and won't be updated automatically, right? And I didn't know which composer.json and where in that file your code should be placed.

Maybe the best solution would be to add the ckeditor-wordcount-plugin library to https://www.drupal.org/project/ckeditor_libraries_group because under https://packagist.org/packages/drupal-ckeditor-libraries-group/ you can see the drupal-ckeditor-libraries-group/notification library that is correctly installed to the libraries directory by https://www.drupal.org/project/notification .

So why don't copy this working solution for this module's composer installation option?

Because this plugin is different. It is not packaged under the official CKEditor source like the others. It resides in its own repo.

Hello.

As correctly pointed out by @guisharko in #12 in order for Composer to install that library in the correct location w8tcha/CKEditor-WordCount-Plugin library should have type set to "drupal-library" because this is the directive (["type:drupal-library",) in the extra section that instructs installer-paths to install it at a specific path.

So, to "fix" this issue project page should be updated with the instructions for Composer based installations to include

{
            "type": "package",
            "package": {
                "name": "w8tcha/ckeditor-wordcount-plugin",
                "version": "1.17.8",
                "type": "drupal-library",
                "dist": {
                    "url": "https://github.com/w8tcha/CKEditor-WordCount-Plugin/releases/download/v1.17.8/CKEditor-WordCount-Plugin.zip",
                    "type": "zip"
                },
                "require": {
                    "composer/installers": "~1.0"
                }
            }
        }

in the "repositories" section so it looks like :

"repositories": [
        {
            "type": "composer",
            "url": "https://packages.drupal.org/8"
        },
        {
            "type": "package",
            "package": {
                "name": "w8tcha/ckeditor-wordcount-plugin",
                "version": "1.17.8",
                "type": "drupal-library",
                "dist": {
                    "url": "https://github.com/w8tcha/CKEditor-WordCount-Plugin/releases/download/v1.17.8/CKEditor-WordCount-Plugin.zip",
                    "type": "zip"
                },
                "require": {
                    "composer/installers": "~1.0"
                }
            }
        }
    ]

Reading composer/installers docs again, especially https://github.com/composer/installers#custom-install-paths feels like it should be possible to install arbitrary package to a custom path by name, like suggested on the project page, but for some reason this doesn't work.

Ran into this on D9 - trying what is listed on the description page does not work. #12 seems like the most sensible approach, because it will do that for anyone. I had to remove the module, add the package line, delete it from the vendor, and then require it again for it to download to the correct place. It helps to keep it generic that way, because it will download to the right place (the package is already tagged drupal-library per the composer addition) and not all users are using web as the webroot, some use docroot.

The reason it does not work, I believe, is because the package being requested (w8ctha plugin) is not tagged as a 'drupal-library' type at its source definition. Thats why it winds up in vendor, and not in libraries. This is why #12 works.

I think we should update that so its clear and consistent - the composer post install copy cmd is clever, but is likely too much to do just for this (also unsure if cp works on windows?).

I updated the project page with the method from #12. I tried to be as thorough as possible. I just went through the process on a fresh install and it worked.

Can someone review?

Just noticed its in the README too, and the linked GitHub thread indicates Composer is not going to change the way it does business in this regard.

I think we should get this resolved ASAP as its probably confusing new users.

I think here we need to follow webform's example and add a composer.libraries.json file to download the library. See https://www.drupal.org/docs/8/modules/webform/webform-frequently-asked-q...

Should wikimedia/composer-merge-plugin be used if it's been deprecated in core? #2912387: Stop using wikimedia/composer-merge-plugin

I suppose we could try a fork in https://www.drupal.org/project/ckeditor_libraries_group with the correct composer.json injection?

Doesn't a composer.libraries.json just confuse the matter further? The end result is what adding the package to your composer.json is already.

@Webbeh, core had it's reasons for removing it. One of them was that it wasn't maintained. That used to be true. But since there was a new release 4 days ago, that point is no longer valid. I see many modules solving this problem using the composer.libraries.json solution, and I don't think we in the ckeditor_libraries_group can really solve this issue for all modules and all libraries. There's just too many of them, and this solution shifts the problem to module maintainers.

@kevinquillen, adding the composer.libraries.json is a possible solution to the problem. The other is adding the package repository as you've now documented in the module's page. Both solutions can exist side-by-side. Only that site builders that want to use composer.libraries.json will have it easier since they won't have to keep track of the library in their project's root composer.json.

Marking this fixed, as the documentation on the module page now specifies fully how to add the library via a custom package repository to a site's root composer.json.

I've created a new issue to add the composer.libraries.json file that can be used as an alternative.

The readme also needs updating

I was not able to get this working by any of the methods outlined. Instead I am using this library: https://github.com/oomphinc/composer-installers-extender and ensured that my type name is prefixed with 'drupal-'. No need for any fancy packages in repositories or anything. Just ensure that the type name used in the custom module/library is the same as the one you want to save to your custom directory:

e.g in the module

{
  "name": "myproject/mymodule",
  "type": "drupal-myproject-custom-module",
  ...
}

And in the root composer.json:

          "web/modules/myproject/{$name}": [
                "type:drupal-myproject-custom-module"
           ],

@NewZeal, this thread is about installing the Javascript libraries required by this module, and not a custom module.

To install a custom module, you should not need to use "oomphinc/composer-installers-extender", but can instead use the "composer/installers" library, and give your module the standard "drupal-custom-module" type. See https://www.drupal.org/docs/develop/creating-modules/add-a-composerjson-... for more information.

My apologies. Actually, my intention is to install in a custom folder and not the standard "drupal-custom-module", for which the solution I provided seems essential.

It's a bit off-topic, but if you are OK with installing all your drupal-custom-module in the same directory, you should be fine with the base composer/installers package, and setting the directory in https://github.com/drupal/recommended-project/blob/10.1.x/composer.json#L54

Of course, if you want to install drupal-custom-module in web/modules/custom and some other custom module in web/modules/myproject, the yes, you need to define your own type for this drupal-myproject-custom-module cases. It does seem a bit too many levels of custom modules, but I'm pretty sure if you need that, that there are good reasons for it.

Yes, the reason for the custom folder is that the module has its own git repo that is made available as a package from gitlab, therefore it is not to be altered within the current repo. Meanwhile all modules under custom folder belong to the current repo and should be altered as required within the current repo.

For me it worked like this:

Add this to composer.json

    "extra": {
        "merge-plugin": {
            "include": [
                "[web-root]/modules/contrib/ckwordcount/composer.libraries.json"
            ]
        }
    }

And then

composer require drupal/ckwordcount and not composer require drupal/ckwordcount w8tcha/ckeditor-wordcount-plugin.