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

Flavor specification changes #1076

Closed
1 task
uncenter opened this issue May 22, 2024 · 2 comments
Closed
1 task

Flavor specification changes #1076

uncenter opened this issue May 22, 2024 · 2 comments
Labels
feature New feature request

Comments

@uncenter
Copy link
Contributor

Please describe the problem you're trying to solve

I'd like to move discussion from catppuccin/yazi#2 to here. To summarize, I don't see why Yazi needs to mandate the filenames and presence of files not directly related to Yazi. I understand if the spec requires the syntax highlighting and theme.toml files to exist with certain names, but the rest (README, preview image, licensing) does not need to be mandated.

Would you be willing to contribute this feature?

  • Yes, I'll give it a shot

Describe the solution you'd like

Remove the requirement of the README.md, LICENSE, LICENSE-tmtheme, and preview.png files.

Additional context

No response

@uncenter uncenter added the feature New feature request label May 22, 2024
@sxyazi
Copy link
Owner

sxyazi commented May 22, 2024

Hi, they are files reserved for future plans, they are added to the specification to avoid using different names for files with the same purpose, e.g. a preview image may have different combinations of preview.png, screenshot.png, image.png, etc., which would make it more difficult to deal with them.

It's probably best to have a file that specifies the name of the preview file, something like:

# package.json
{
  "preview_file_name": "preview.png"
}

But I want to avoid it as much as possible, which introduces unnecessary complexity.

On the other hand, this also specifies that the image format used is PNG and not other JPG, WebP, HEIC, JPEG XL, etc. This is to make sure that all users get the same experience, because PNG is a pretty mature format and almost all devices support it, whereas with other such as WebP some devices may not be able to preview them, which would be an inconvenience.

Closing as not in the plan, sorry.

@sxyazi sxyazi closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2024
@uncenter
Copy link
Contributor Author

I'll give this one last shot!

whereas with other such as WebP catppuccin/yazi#2 (comment),

Yazi itself supports WebP preview images though? That should be the only support considered imo.

files reserved for future plans

Any chance you can shed some light on what these future plans are? Would help to understand the reasoning behind the spec.

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

No branches or pull requests

2 participants