Install JS library through composer

I don't know if this can work automatically, generally from this point right here:

{
      "extra": {
        "installer-paths": {
          "web/libraries/{$name}": ["type:drupal-library"]
        }
      }
}

Your root is /web, whereas mine is /docroot.

One more nitpick - I think it should make it clear it goes in the repositories section, and explain adding a repositories section if one doesn't exist.

Here is the patch based on #5. (Nice job @b.lammers!)
I added the whole repositories section, so it's more clear where to place the code.
I also deleted the line with ""codesnippet": " in the repositories section because the patch doesn't work with this line.

Best regards.

+++ b/README.txt
@@ -10,6 +10,43 @@ This module requires the core CKEditor module and the CodeSnippet plugin from CK
+1. Ensure you have 'composer/installer' as a requirement in your main 'composer.json' file. If you do, skip to 4

The drupal-composer project (https://github.com/drupal-composer/drupal-project/blob/8.x/composer.json) uses :

composer/installers

should we change the instructions to use that one?

The rest of this patch is fine and tested using "composer/installers".

Yes @xmacinfo, you're right. It should be "composer/installers" with a "s".

Here is the patch with the correction.

Best regards.

The patch worked well for me as a guide to quickly set up the library but
do we really need to specify the version in:
5. Run 'composer require ckeditor/codesnippet:4.8.0' add the library itself to your composer required list.

I think this is not needed as the version is defined strictly above as part of the repository.

Please have a look at :

https://ckeditor.com/cke4/addon/codesnippet

Codesnippet versions relate to CKEditor version. I believe 4.8.0 is the safest version for Drupal 8 CKEditor. But I did not test newer versions.

No, I mean: we define the repository with "version": "4.8.0",
And if I do composer require ckeditor/codesnippet there is no way I can get anything other than the version defined above. Am I right?

If you do composer require ckeditor/codesnippet the composer.json file will be rewritten and it won't, probably, use 4.8.0.

The problem here as that we use an external package. In the composer file we look specifically for the 4.8.0 ZIP file.

Loading external files not supported by Packagist can be tricky.

Look for :

"url": "https://download.ckeditor.com/codesnippet/releases/codesnippet_4.8.0.zip",

…And replace the version number.

You're absolutely right @hugronaphor !
Here is the patch without indicating the version in the composer require command.

Thx !

Sorry, in the last the patch wasn't with the correct message number.
Now the correct one.

;)

Here is the output code without specifying the version in the composer command composer require ckeditor/codesnippet and it looks that it's downloading the 4.8 version of the library as expected.

vagrant@test01 /v/w/d/drupal> composer require ckeditor/codesnippet
    1/2:	https://packages.drupal.org/8/drupal/provider-2018-4$455e123c7ebb607a782d678dcff4acf68e207446d3168299c7be637000529e53.json
    2/2:	https://packages.drupal.org/8/drupal/provider-2018-2$aecc0bc82404e56c5868652445d55396d743787a72381e89590fc02b973bb112.json
    Finished: success: 2, skipped: 0, failure: 0, total: 2
    1/3:	http://repo.packagist.org/p/provider-latest$038b582e963fca6d9df399cff74744bf66e8c75e690a14c4b5a001da12561105.json
    2/3:	http://repo.packagist.org/p/provider-2018-10$f62f8b08160564f40a8e14d78d81058429713c27e901e498faea2a7714082450.json
    3/3:	http://repo.packagist.org/p/provider-2016$e6d1ca276351f53a94691b33e09119c80d9e9b53c4f62232e2b73936b9f544d7.json
    Finished: success: 3, skipped: 0, failure: 0, total: 3
Using version ^4.8 for ckeditor/codesnippet
./composer.json has been updated
> DrupalProject\composer\ScriptHandler::checkComposerVersion
Loading composer repositories with package information
Updating dependencies (including require-dev)
    1/1:	https://download.ckeditor.com/codesnippet/releases/codesnippet_4.8.0.zip
    Finished: success: 1, skipped: 0, failure: 0, total: 1
Package operations: 1 install, 0 updates, 0 removals
  - Installing ckeditor/codesnippet (4.8.0): Loading from cache
Writing lock file
Generating autoload files
PHP CodeSniffer Config installed_paths set to ../../drupal/coder/coder_sniffer/
> DrupalProject\composer\ScriptHandler::createRequiredFiles

+++ b/README.txt
@@ -10,6 +10,43 @@ This module requires the core CKEditor module and the CodeSnippet plugin from CK
+2. Run 'composer require composer/installer' to add this package to your installation. It will make sure modules and libraries end up in their correct location.

Should be `composer require composer/installers`.

Otherwise this seems fine, am currently using patch (with incorrect text).

Addressed 18th comment

Patch applied and instructions tested. Looks good to me.

Seems like an important addition too, as this module could be deemed unusable with some deployment processes.

Thank you.

Instructions look good, just tried it and worked well. Sorry for the delay on this.

Anyone want to help out with maintaining?

Patch in #20 didn't apply for me.

$ patch -p1 < codesnippet-library-inclusion-2931474-20.patch
patching file README.txt
patch unexpectedly ends in middle of line

And

$ git apply -v codesnippet-library-inclusion-2931474-20.patch
error: corrupt patch at line 58

Here's a new patch that applies correctly, but there's no interdiff.

• Moved the recommended installation (via Composer) above the manual steps
• Named the repository codesnippet to mimic what we already do e.g. for drupal (d.o. composer façade) or assets (Assets Packagist)
• Picked v4.11.4 in the light of #3066927: error CKEDITOR.tools.object.keys when module enabled

P.S.: too bad there's no Bower or NPM Code Snippet package available. This would be way more easier to require the library.

#23 worked for me. Thanks anavarre!!!

#23 worked for me too. Moving to RTBC.

Thanks @anavarre

Here is the more maintainable way of doing this :
https://www.drupal.org/docs/8/modules/webform/webform-frequently-asked-q...

I created a patch for a more uptodate way and easier way
I'm using Drupal recommend composer template and the following patch just works
composer require drupal/codesnippet and that's it

here is the patch

Linking similar discussions.
Here the patch with the dependency on drupal-ckeditor-libraries-group/codesnippet package.
So from the developer side there no needs to provide additional instructions for install via Composer.
You can try how the approach works on the simplytest.me with module ckeditor_font https://simplytest.me/project/ckeditor_font/8.x-1.x

Given the comment in #23:

> P.S.: too bad there's no Bower or NPM Code Snippet package available. This would be way more easier to require the library.

Coupled with the work in #29, marking this as Needs Review for this proposed direction.

I tried the patch in #29. It involved 2 steps.

First, apply the patch to the module using the "patches" section of the composer.json file.
Second, require the libraries using composer: "composer require drupal-ckeditor-libraries-group/codesnippet:4.14.0"

If this is the expected workflow, then it works. I was thinking that the libraries would be installed with the module itself.

The patch wouldn't make any effect on the module in the drupal project. Composer working with the metapackage information before applying the patches. So no-action-required approach would be available when the changes would be done in the codesnippet module repository. In that way drupal.org's packagist will tell for your project composer also to download required module dependency.

Check it out the ckeditor_font module which already uses that approach. Composer resolves library dependency.

Cool. So, it works. After the patch has been committed, the library should automatically be installed.

Yeah, the patch has to be committed in order for it to be installed automatically.

Thanks for the patch, @voleger!

Changed the patch a bit to cope with evolving library versions, and also to state the documented minimum (4.5.11). On my tests, it nevertheless installed 4.14.0.