yazi: Fix expected structure of flavors
This commit is contained in:
parent
16f86c94ce
commit
216d51eb22
9 changed files with 75 additions and 13 deletions
0
tests/modules/programs/yazi/flavor/LICENSE
Normal file
0
tests/modules/programs/yazi/flavor/LICENSE
Normal file
0
tests/modules/programs/yazi/flavor/LICENSE-tmtheme
Normal file
0
tests/modules/programs/yazi/flavor/LICENSE-tmtheme
Normal file
50
tests/modules/programs/yazi/flavor/README.md
Normal file
50
tests/modules/programs/yazi/flavor/README.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
<div align="center">
|
||||
<img src="https://github.com/sxyazi/yazi/blob/main/assets/logo.png?raw=true" alt="Yazi logo" width="20%">
|
||||
</div>
|
||||
|
||||
<h3 align="center">
|
||||
Example Flavor for <a href="https://github.com/sxyazi/yazi">Yazi</a>
|
||||
</h3>
|
||||
|
||||
## Cooking up a new flavor
|
||||
|
||||
> [!NOTE]
|
||||
> Please remove this section from your README before publishing.
|
||||
|
||||
1. [x] Fork this repository and rename it to `your-flavor-name.yazi`.
|
||||
2. [ ] Copy the **parts you need to customize** from the [default theme.toml](https://github.com/sxyazi/yazi/blob/main/yazi-config/preset/theme.toml) as `./flavor.toml`, and change them to meet your preferences.
|
||||
3. [ ] Find a `.tmTheme` file on GitHub that matches the color of your flavor, copy it and it's license file as `./tmtheme.xml`, and `LICENSE-tmtheme`.
|
||||
4. [ ] Modify the content and preview image in the README to fit your flavor.
|
||||
|
||||
## 👀 Preview
|
||||
|
||||
<img src="preview.png" width="600" />
|
||||
|
||||
## 🎨 Installation
|
||||
|
||||
<!-- Please replace "username/example.yazi" with your repository name. -->
|
||||
|
||||
```bash
|
||||
# Linux/macOS
|
||||
git clone https://github.com/username/example.yazi.git ~/.config/yazi/flavors/example.yazi
|
||||
|
||||
# Windows
|
||||
git clone https://github.com/username/example.yazi.git %AppData%\yazi\config\flavors\example.yazi
|
||||
```
|
||||
|
||||
## ⚙️ Usage
|
||||
|
||||
Add the these lines to your `theme.toml` configuration file to use it:
|
||||
|
||||
<!-- Please replace "example" with your flavor name. -->
|
||||
|
||||
```toml
|
||||
[flavor]
|
||||
use = "example"
|
||||
```
|
||||
|
||||
## 📜 License
|
||||
|
||||
The flavor is MIT-licensed, and the included tmTheme is also MIT-licensed.
|
||||
|
||||
Check the [LICENSE](LICENSE) and [LICENSE-tmtheme](LICENSE-tmtheme) file for more details.
|
||||
2
tests/modules/programs/yazi/flavor/flavor.toml
Normal file
2
tests/modules/programs/yazi/flavor/flavor.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
# This is a flavor.
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
-- This is a flavor.
|
||||
0
tests/modules/programs/yazi/flavor/preview.png
Normal file
0
tests/modules/programs/yazi/flavor/preview.png
Normal file
0
tests/modules/programs/yazi/flavor/tmtheme.xml
Normal file
0
tests/modules/programs/yazi/flavor/tmtheme.xml
Normal file
|
|
@ -83,7 +83,7 @@
|
|||
## Produces warning
|
||||
#"flavor-with-suffix.yazi" = ./flavor;
|
||||
## Fails assertion
|
||||
#single-file-flavor = ./flavor/init.lua;
|
||||
#single-file-flavor = ./flavor/flavor.toml;
|
||||
#empty-dir-flavor = ./empty;
|
||||
};
|
||||
};
|
||||
|
|
@ -101,7 +101,7 @@
|
|||
${./init.lua}
|
||||
assertFileContent home-files/.config/yazi/plugins/testplugin.yazi/init.lua \
|
||||
${./plugin/init.lua}
|
||||
assertFileContent home-files/.config/yazi/flavors/testflavor.yazi/init.lua \
|
||||
${./flavor/init.lua}
|
||||
assertFileContent home-files/.config/yazi/flavors/testflavor.yazi/flavor.toml \
|
||||
${./flavor/flavor.toml}
|
||||
'';
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue