laravel-backpack/addon-skeleton

Skeleton for creating Backpack addons with Laravel Packager. Just add meat.

addon-skeleton's Issues

[Refactoring] Move AutomaticServiceProvider from skeleton to CRUD

When doing these PRs I've had to change the AutomaticServiceProvider in all 3 themes, the same way. That's no bueno.

I think at this point it's safe to move the AutomaticServiceProvider to CRUD. If all add-ons and themes extend that one, it means we have a central place for all that code.

This does, however, mean we need to triple-check everything that AutomaticServiceProvider is doing, and go through all packages to use this one, then extensively test that package. It's not a Small task. In fact, I'd say it's a Medium or Large. And we don't really have time for that right now. But considering the fact that this should be non-breaking, I think we can do this later on, in Backpack 6.x. At least for most packages, that just use the AutomaticServiceProvider as-is.

Only the views from the vendor folder are loaded, not the published views

Todo: @promatik

Translation string is ugly

create-dummy-operation::create-dummy-operation.line_name

Right now it looks like we cannot use the vendorName as the namespace, because then a second project won't let us use the same namespace. So we can't do:
promatik::create-dummy-operation.line_name

[Feature Request] .editorconfig file

Consider adding an .editorconfig file to the skeleton… and to all our packages. This should force maintainers and contributors to follow the same code style, without using StyleCI or anything like that. Not sure it’s a 1:1 replacement though but it’s worth a shot.

https://editorconfig.org/

Investigate if we can use the vendorName as namespace for translations

@promatik please?

[Bug] Published lang files are not found

Bug report

What I did

I created an addon, then published lang files from my addon

What I expected to happen

I expetected to override some strings and see changes in the UI

What happened

Changes are ignored

What I've already tried to fix it

I changed AutomaticServiceProvider as follows

protected function publishedLangsPath() {
    app()->langPath(). '/vendor/'. $this->vendorNameDotPackageName();
}

I don't like it, because, publish lang files, creates a weird folder 'company_name.package_name' instead of standard 'company_name' .

It's ugly but laravel 9 can find it.

See vendor/laravel/framework/src/Illuminate/Translation/FileLoader.php , in the specific note the inner working of

• loadNamespaced
• loadNamespaceOverrides

I've no idea how to add additional overrides or hints from the package itself to be able to autopublish to a company_name folder instead of company_name.package_name and ALSO allow Laravel to find overrides in here.

i tried also to leave publishedLangsPath as

return app()->langPath(). '/vendor/'. $this->vendorName;

but change boot()

from

    if ($this->packageDirectoryExistsAndIsNotEmpty('resources/lang')) {
        $this->loadTranslationsFrom($this->packageLangsPath(), $this->vendorNameDotPackageName());
    }

to

    if ($this->packageDirectoryExistsAndIsNotEmpty('resources/lang')) {
        $this->loadTranslationsFrom($this->packageLangsPath(), $this->vendorName);
    }

This causes the desidered folder name, with only the company, but then every occurrency of

trans('company_name.package_name::package_name.string_key') 

must be replaced with

trans('company_name::package_name.string_key') 

Context to replicate the bug - Backpack, Laravel, PHP, DB version

When I run php artisan backpack:version the output is:

### PHP VERSION:
PHP 8.0.3 (cli) (built: Mar  2 2021 23:34:05) ( ZTS Visual C++ 2019 x64 )
Copyright (c) The PHP Group
Zend Engine v4.0.3, Copyright (c) Zend Technologies

### LARAVEL VERSION:
v9.17.0@091e287678ac723c591509ca6374e4ded4a99b1c

### BACKPACK VERSION:
5.1.0@9e1de794137ceb1ade1fa35e3b9366f97285efb3

We should recommend people place their configs inside config/backpack/addon-name.php

See title