https://github.com/benzaria/config.any
Make ur Startship Config in multiple file with json, yaml and toml All at Once and Hot Reload on Change.
https://github.com/benzaria/config.any
starship starship-config starship-configuration starship-prompt
Last synced: about 2 months ago
JSON representation
Make ur Startship Config in multiple file with json, yaml and toml All at Once and Hot Reload on Change.
- Host: GitHub
- URL: https://github.com/benzaria/config.any
- Owner: benzaria
- Created: 2025-02-16T19:42:50.000Z (2 months ago)
- Default Branch: mucho
- Last Pushed: 2025-02-19T14:55:13.000Z (2 months ago)
- Last Synced: 2025-02-19T15:44:01.234Z (2 months ago)
- Topics: starship, starship-config, starship-configuration, starship-prompt
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Config-Any
Make ur `Config` in **multiple files** with `json`, `yaml`, `toml` and *More...* **All at Once** and **Hot Reload** on **Change**.
## Shell Integration
bash/zsh
```bash
echo "path-to/config-any [options] &" >> ~/.bashrc # or ~/.zshrc
```
pwsh
```powershell
echo "Start-Process -NoNewWindow path-to/config-any -ArgumentList '[options]'" >> $PROFILE
```
cmd - ('if u have a profile script')
```batch
echo "@start /b path-to/config-any [options]" >> %USERPROFILE%/.batchrc
```
## API
Usage:
```bash
config-any --file ./mainFile.{json,yaml,...} --dir ./config --watch
```
Options:
- `--file, -f `: Specify the output file path (default: ./config.json)
- `--dir, -d `: Specify the directory to watch for config files (default: ./config)
- `--lock, -l `: Specify a custom lock file name (default: tempDir/{outFileName}.lock)
- `--watch, -w`: Enable hot reloading on file changes
- `--verbose, -v`: Enable verbose logging
- `--err, -e`: Enable error logging (default: true)
- `--no-{option}`: Disable any of the boolen options
Supported Formats:
- JSON
- JSONC (JSON with comments)
- YAML
- TOML
To add support for a new format, import the corresponding library and add it to the `Converter` object in index.js.
## Requirements
- [Node v20+](https://nodejs.org/en/download/current)
## Example
```bash
config-any --file $STARSHIP_CONFIG --watch # for starship config
```
`config/.main.toml`
```toml
"$schema" = 'https://starship.rs/config-schema.json'
format = """
${env_var.CSI}1F\
${env_var.CSI}$character╭─$os$username$directory${env_var.nim}[$package${custom.node}${custom.pnpm}${custom.npm}]()
${env_var.CSI}$character╰ \
${env_var.CSI}0m"""
add_newline = true
continuation_prompt = "[|](bright-black) "
fill = { symbol = " " }
```
`config/file-1.json`
```json
{
"$schema" : "https://starship.rs/config-schema.json",
"env_var": {
"CSI": {
"variable": "CSI",
"format": "$env_value",
"disabled": false
},
"nim": {
"variable": "nim_ver",
"format": "with [$symbol$env_value]($style) ",
"style": "bright-cyan bold",
"symbol": " ",
"disabled": true
}
}
}
```
`config/file-2.yml`
```yaml
# yaml-language-server: $schema=../schema.json
aws:
disabled: false
expiration_symbol: X
force_display: false
format: on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)
style: bold yellow
os:
format: "[$symbol]($style)"
style: "bold bright-Blue"
disabled: false
symbols:
Windows: " "
Kali: " "
```
---
output: `starship.toml`
```toml
"$schema" = 'https://starship.rs/config-schema.json'
# From: .frontend.toml
format = """
$fill[[${custom.get-clock-time}](bright-blue bold bg:237)[${custom.git-branch}](bright-blue bold bg:237)${custom.is-git}\r
${env_var.CSI}1F${env_var.CSI}100000C${env_var.CSI}2D[${custom.git-url}](#181717 bg:237)${env_var.CSI}10C](fg:237)\r
${env_var.CSI}1F${env_var.CSI}$character╭─$os$username$directory${env_var.nim}[$package${custom.node}${custom.pnpm}${custom.npm}]()\r
${env_var.CSI}$character╰ ${env_var.CSI}0m"""
add_newline = true
continuation_prompt = "[|](bright-black) "
[fill]
symbol = " "
# From: env_var.json
[env_var.CSI]
variable = "CSI"
format = "$env_value"
disabled = false
[env_var.nim]
variable = "nim_ver"
format = "with [$symbol$env_value]($style) "
style = "bright-cyan bold"
symbol = " "
disabled = true
# From: example.yaml
[aws]
disabled = false
expiration_symbol = "X"
force_display = false
format = "on [$symbol($profile )(\\($region\\) )(\\[$duration\\] )]($style)"
style = "bold yellow"
[os]
format = "[$symbol]($style)"
style = "bold bright-Blue"
disabled = false
[os.symbols]
Windows = " "
Kali = " "
```