Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request]: Make installed extensions use preferred names #7539

Open
1 task done
Kettukaa opened this issue Feb 4, 2023 · 9 comments
Open
1 task done

[Feature Request]: Make installed extensions use preferred names #7539

Kettukaa opened this issue Feb 4, 2023 · 9 comments
Labels
enhancement New feature or request

Comments

@Kettukaa
Copy link

Kettukaa commented Feb 4, 2023

Is there an existing issue for this?

  • I have searched the existing issues and checked the recent builds/commits

What would your feature do ?

The extensions listed under the "Available" tab all use the pretty name from Extension-index.md, but the extensions under "Installed" do not. I believe that making the extensions use their clean names could be cleaner.

For instance, under Catppuccin naming conventions, the Catppuccin theme repo is just called "stable-diffusion-webui". Under "Available" the extension comes up at "Catppuccin Theme", but under "Installed" it just shows up as "stable-diffusion-webui". This could cause confusion.

In general, keeping naming parity between the two tabs will make things more clear. This can either be done by checking the index for preferred names, or by giving developers an option to give preferred names in their repos.

Proposed workflow

If the extension index option cannot be used, then I propose allowing extension developers to make "extension-info.yaml" files, where they can populate it with information.

  1. Devs create extension-info.yaml
  2. Populate file with info
info:
 name: "..."
 description:  "..."
}
  1. The yaml info is read by WebUI and written to the extension/installed tab.

Additional information

No response

@Kettukaa Kettukaa added the enhancement New feature or request label Feb 4, 2023
@Harvester62
Copy link
Contributor

I do agree that an extension should have a destination directory named properly, avoiding the Catppuccin situation, which should have been instead installed inside a stable-diffusion-webui-catppuccin directory, by example.

@Kettukaa
Copy link
Author

Kettukaa commented Feb 8, 2023

This also streamlines how extensions can be added to the extension index. Whoever adds them manually doesn't have to come up with reasonable names and descriptions. These names and descriptions can be pulled directly from the proposed yaml file. This can be extended to further functionality too: one could add a category field (script, tab, etc), a purpose (?) field (theme, post process, training, etc), a version field (1.0.3, beta-1.3, etc), and so on.

@Harvester62
Copy link
Contributor

So, if I rename the destination folder when or after cloning an extension's repository will it be parsed for checking updates when pressing the button in the SD Web UI? Using an extension's folder name different from what is recorded in the Extensions Index might overlook it the Check for Updates parsing? I am just asking.

@w-e-w
Copy link
Collaborator

w-e-w commented Feb 18, 2023

the easiest solution would be to add a new field in the json index that would act as an override for the dir
not a perfect / future proof solution, but it should should be good enough for the current situation

@Kettukaa
Copy link
Author

the easiest solution would be to add a new field in the json index that would act as an override for the dir not a perfect / future proof solution, but it should should be good enough for the current situation

@w-e-w Yeah that could potentially work for the time being. Though I do think giving devs the ability to easily add/edit names is a really good idea.

@Kettukaa
Copy link
Author

Returning the conversation here. @w-e-w it seems like changing the name of the repo is unfortunately a no-go. Seems to be an enforced rule of the Catppuccin org :/ A fix would have to lie here. Any ideas on what needs to be done to make this happen? All that really needs to happen is to formalize this "extension-info.yaml" file and add a way for the extension tab to display the preferred name, and not the cloned name.

@Kettukaa
Copy link
Author

*Or using the name in the json index

@w-e-w
Copy link
Collaborator

w-e-w commented Feb 28, 2023

In my opinion the extension-info.yaml is a good solution, but it will require a bigger rework of the extensions tab
also every one will have to be onboard with the idea

in the meantime the json override would be easier, also a small change will have a higher chance of being accepted by AUTO

whichever solution someone will have to muster the energy to do it
since I am on holiday, it will be sometime for me work on it, maybe someone else will beat me to it
as of now it's not a major problem, so it can waite

@TresDtres
Copy link

that was the best idea to stay in time, it seems like an idea from someone who works for mocosoft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants