extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-10-05 01:43:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(buf): fix spacing & harmonize docs with actual configuration (#4450)

Browse Source 
* fix(buf): add whitespace after version string

* fix: update config schema

* fix: config version and bison emoji

* fix: update documentation format

* fix: dprint

* fix: config schema
This commit is contained in:
wilhelm 2022-10-08 07:07:30 +11:00 committed by GitHub
parent 84bbe3dd03
commit 3d452367bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/config-schema.json vendored
View File

@ -71,9 +71,9 @@
],
"detect_folders": [],
"disabled": false,
"format": "with [$symbol ($version)]($style)",
"format": "with [$symbol($version )]($style)",
"style": "bold blue",
"symbol": "",
"symbol": "🦬 ",
"version_format": "v${raw}"
},
"allOf": [
@ -1721,7 +1721,7 @@
"type": "object",
"properties": {
"format": {
"default": "with [$symbol ($version)]($style)",
"default": "with [$symbol($version )]($style)",
"type": "string"
},
"version_format": {
@ -1729,7 +1729,7 @@
"type": "string"
},
"symbol": {
"default": "",
"default": "🦬 ",
"type": "string"
},
"style": {

30
docs/config/README.md
View File

@ -498,24 +498,24 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------------------------------- | ----------------------------------------------------- |
| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. |
| `version_format` | `"v${raw}"` | The version format. |
| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
| Option | Default | Description |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------- |
| `format` | `"with [$symbol($version )]($style)"` | The format for the `buf` module. |
| `version_format` | `"v${raw}"` | The version format. |
| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. |
### Variables
| Variable | Example | Description |
| ------------- | -------- | ------------------------------------ |
| `buf_version` | `v1.0.0` | The version of `buf` |
| `symbol` | | Mirrors the value of option `symbol` |
| `style`* | | Mirrors the value of option `style` |
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| `version` | `v1.0.0` | The version of `buf` |
| `symbol` | | Mirrors the value of option `symbol` |
| `style`* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string

4
src/configs/buf.rs
View File

@ -21,9 +21,9 @@ pub struct BufConfig<'a> {
impl<'a> Default for BufConfig<'a> {
fn default() -> Self {
BufConfig {
format: "with [$symbol ($version)]($style)",
format: "with [$symbol($version )]($style)",
version_format: "v${raw}",
symbol: "",
symbol: "🦬 ",
style: "bold blue",
disabled: false,
detect_extensions: vec![],

2
src/modules/buf.rs
View File

@ -103,7 +103,7 @@ mod tests {
.sync_all()
.unwrap();
let actual = ModuleRenderer::new("buf").path(dir.path()).collect();
let expected = Some(format!("with {}", Color::Blue.bold().paint(" v1.0.0")));
let expected = Some(format!("with {}", Color::Blue.bold().paint("🦬 v1.0.0 ")));
assert_eq!(expected, actual);
dir.close().unwrap();
}