shel/asset-names

Allows changing uploaded asset filenames in Neos CMS

Installs: 441

Dependents: 0

Suggesters: 0

Security: 0

Stars: 7

Watchers: 1

Forks: 0

Open Issues: 1

Type:neos-plugin

1.2.1 2021-01-20 08:42 UTC

This package is auto-updated.

Last update: 2021-04-20 09:23:35 UTC


README

Latest Stable Version Total Downloads License

Installing this package will change the naming behavior for files when publishing assets in Neos CMS. By default Neos CMS will create a symlink in the public Web folder to the file stored in the private Data/Persistent folder. These symlinks to images and other assets will have the filenames they got when they were uploaded.

New behavior: The symlinks to these assets will have a filename based on their title which can be set in the Media Module.

Advantages

  • You can optimize the filenames for SEO purposes in the Media Module.
  • The actual file name stored in the database is not changed.
  • Old filenames will still work until the Web/Resources folder is cleaned up.

Caveats

  • The final filename will be run through slugify to prevent problematic characters in the filename.
  • The actual file name stored in the database is not changed. Therefore there is an additional query to the database to generate the file name when the public uri is requested. This might be optimized in the future.

In my tests publishing ~1000 resources with this plugin took ~2.5s compared to ~1s without this feature.

How to use it

  1. Install the package via composer composer require --no-update shel/asset-names in your site package.
  2. Run composer update in your project's root folder.
  3. Run ./flow resource:publish.
  4. Change an assets title in the media module and check the resulting filename in the preview.

Adapt the filename schema

You can customise the filename creation via your Settings.yaml. Add the following snippet to your configuration and adapt it to your needs:

Shel:
  AssetNames:
    expression: "${'my-prefix-' + asset.title + '-' + width + 'x' + height}"

It's recommended to keep the width and height suffix.

What the package cannot do yet

It currently doesnt work when not using the provided symlink target.

If you use the copy target or some cloud based filesystem you can extend those targets the same way and provide the change as PR to this package.

Future plans

  • This feature should be in the Neos CMS core at some point.
  • This package is meant to find the best implementation and also support older Neos versions until it's part of the core.

Contributions

Contributions are very welcome!

Please create detailed issues and PRs.

If you use this package and want to support or speed up it's development, use Githubs sponsor button or get in touch with me

License

See License