haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix(nodejs): use e718 as the default of symbol in node configuration (#3533) 

* fix: use e718 as the default of symbol in node configuration

* wip: change nodejs symbol in docs/config & add a nodejs symbol configuration in docs/presets

* wip: update CONTRIBUTING.md
This commit is contained in:
TrickyPi 2022-01-30 17:28:00 +08:00 committed by GitHub
parent e680540cfc
commit 65f29754d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -8,9 +8,9 @@ If you have any questions that aren't addressed in this document, please don't h
## Glossary ## Glossary
- **Module**: A component in the prompt giving information based on contextual information from your OS. For example, the `nodejs` module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. - **Module**: A component in the prompt giving information based on contextual information from your OS. For example, the `rust` module shows the version of Rust that is currently installed on your computer, if your current directory is a Rust project.
- **Segment**: Smaller sub-components that compose a module. For example, the `symbol` segment in the `nodejs` module contains the character that is shown before the version number (`⬢` by default). - **Segment**: Smaller sub-components that compose a module. For example, the `symbol` segment in the `rust` module contains the character that is shown before the version number (`🦀` by default).
## Philosophy ## Philosophy

2
docs/config/README.md
View File

@ -2169,7 +2169,7 @@ By default the module will be shown if any of the following conditions are met:
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | A format string representing the symbol of Node.js. | | `symbol` | `" "` | A format string representing the symbol of Node.js. |
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | | `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. |
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | | `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |

3
docs/presets/README.md
View File

@ -62,6 +62,9 @@ symbol = " "
[nix_shell] [nix_shell]
symbol = " " symbol = " "
[nodejs]
symbol = " "
[package] [package]
symbol = " " symbol = " "

2
src/configs/nodejs.rs
View File

@ -21,7 +21,7 @@ impl<'a> Default for NodejsConfig<'a> {
NodejsConfig { NodejsConfig {
format: "via [$symbol($version )]($style)", format: "via [$symbol($version )]($style)",
version_format: "v${raw}", version_format: "v${raw}",
symbol: " ", symbol: " ",
style: "bold green", style: "bold green",
disabled: false, disabled: false,
not_capable_style: "bold red", not_capable_style: "bold red",

20
src/modules/nodejs.rs
View File

@ -139,7 +139,7 @@ mod tests {
File::create(dir.path().join("package.json"))?.sync_all()?; File::create(dir.path().join("package.json"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -163,7 +163,7 @@ mod tests {
File::create(dir.path().join(".node-version"))?.sync_all()?; File::create(dir.path().join(".node-version"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -174,7 +174,7 @@ mod tests {
File::create(dir.path().join(".nvmrc"))?.sync_all()?; File::create(dir.path().join(".nvmrc"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -185,7 +185,7 @@ mod tests {
File::create(dir.path().join("index.js"))?.sync_all()?; File::create(dir.path().join("index.js"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -196,7 +196,7 @@ mod tests {
File::create(dir.path().join("index.mjs"))?.sync_all()?; File::create(dir.path().join("index.mjs"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -207,7 +207,7 @@ mod tests {
File::create(dir.path().join("index.cjs"))?.sync_all()?; File::create(dir.path().join("index.cjs"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -218,7 +218,7 @@ mod tests {
File::create(dir.path().join("index.ts"))?.sync_all()?; File::create(dir.path().join("index.ts"))?.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -230,7 +230,7 @@ mod tests {
fs::create_dir_all(&node_modules)?; fs::create_dir_all(&node_modules)?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -249,7 +249,7 @@ mod tests {
file.sync_all()?; file.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Green.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }
@ -268,7 +268,7 @@ mod tests {
file.sync_all()?; file.sync_all()?;
let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect(); let actual = ModuleRenderer::new("nodejs").path(dir.path()).collect();
let expected = Some(format!("via {}", Color::Red.bold().paint(" v12.0.0 "))); let expected = Some(format!("via {}", Color::Red.bold().paint(" v12.0.0 ")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
dir.close() dir.close()
} }