mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-12-24 11:05:27 +00:00
New translations README.md (Sorani (Kurdish))
This commit is contained in:
Matan Kushner
parent
dbefe8cdcc
commit
16ea35f3d1
@ -253,6 +253,7 @@ $kubernetes\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$fossil_branch\
|
||||
$fossil_metrics\
|
||||
$git_branch\
|
||||
$git_commit\
|
||||
$git_state\
|
||||
@ -1524,6 +1525,41 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Fossil Metrics
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
|
||||
| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
|
||||
| `added_style` | `'bold green'` | The style for the added count. |
|
||||
| `deleted_style` | `'bold red'` | The style for the deleted count. |
|
||||
| `only_nonzero_diffs` | `true` | Render status only for changed items. |
|
||||
| `disabled` | `true` | Disables the `fossil_metrics` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| ----------------- | ------ | ------------------------------------------- |
|
||||
| added | `1` | The current number of added lines |
|
||||
| deleted | `2` | The current number of deleted lines |
|
||||
| added_style\* | | Mirrors the value of option `added_style` |
|
||||
| deleted_style\* | | Mirrors the value of option `deleted_style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### نموونە
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[fossil_metrics]
|
||||
added_style = 'bold blue'
|
||||
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
```
|
||||
|
||||
## Google Cloud (`gcloud`)
|
||||
|
||||
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
|
||||
@ -2323,7 +2359,7 @@ kotlin_binary = 'kotlinc'
|
||||
|
||||
## Kubernetes
|
||||
|
||||
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
|
||||
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
|
||||
|
||||
::: tip
|
||||
|
||||
@ -2335,18 +2371,40 @@ When the module is enabled it will always be active, unless any of `detect_exten
|
||||
|
||||
### Options
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |
|
||||
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
|
||||
| `style` | `'cyan bold'` | The style for the module. |
|
||||
| `context_aliases` | `{}` | Table of context aliases to display. |
|
||||
| `user_aliases` | `{}` | Table of user aliases to display. |
|
||||
| `context_aliases`* | `{}` | Table of context aliases to display. |
|
||||
| `user_aliases`* | `{}` | Table of user aliases to display. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
|
||||
| `disabled` | `true` | Disables the `kubernetes` module. |
|
||||
|
||||
*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:
|
||||
|
||||
| گۆڕاو | Description |
|
||||
| ----------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. |
|
||||
| `user_pattern` | Regular expression to match current Kubernetes user name. |
|
||||
| `context_alias` | Context alias to display instead of the full context name. |
|
||||
| `user_alias` | User alias to display instead of the full user name. |
|
||||
| `style` | The style for the module when using this context. If not set, will use module's style. |
|
||||
| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. |
|
||||
|
||||
Note that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)).
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
@ -2368,13 +2426,9 @@ When the module is enabled it will always be active, unless any of `detect_exten
|
||||
[kubernetes]
|
||||
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
|
||||
disabled = false
|
||||
[kubernetes.context_aliases]
|
||||
'dev.local.cluster.k8s' = 'dev'
|
||||
'.*/openshift-cluster/.*' = 'openshift'
|
||||
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
|
||||
[kubernetes.user_aliases]
|
||||
'dev.local.cluster.k8s' = 'dev'
|
||||
'root/.*' = 'root'
|
||||
contexts = [
|
||||
{ context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
|
||||
]
|
||||
```
|
||||
|
||||
Only show the module in directories that contain a `k8s` file.
|
||||
@ -2387,25 +2441,36 @@ disabled = false
|
||||
detect_files = ['k8s']
|
||||
```
|
||||
|
||||
#### Regex Matching
|
||||
#### Kubernetes Context specific config
|
||||
|
||||
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
|
||||
|
||||
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
|
||||
|
||||
Long and automatically generated cluster names can be identified and shortened using regular expressions:
|
||||
The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.
|
||||
|
||||
```toml
|
||||
[kubernetes.context_aliases]
|
||||
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
|
||||
'.*/openshift-cluster/.*' = 'openshift'
|
||||
# Or better, to rename every OpenShift cluster at once:
|
||||
'.*/(?P<var_cluster>[\w-]+)/.*' = '$var_cluster'
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[[kubernetes.contexts]]
|
||||
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
|
||||
# equals "admin_user"
|
||||
context_pattern = "production"
|
||||
user_pattern = "admin_user"
|
||||
style = "bold red"
|
||||
context_alias = "prod"
|
||||
user_alias = "admin"
|
||||
|
||||
[[kubernetes.contexts]]
|
||||
# "green" style + a different symbol when Kubernetes current context name contains openshift
|
||||
context_pattern = ".*openshift.*"
|
||||
style = "green"
|
||||
symbol = "💔 "
|
||||
context_alias = "openshift"
|
||||
|
||||
[[kubernetes.contexts]]
|
||||
# Using capture groups
|
||||
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
|
||||
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
|
||||
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
|
||||
'gke_.*_(?P<var_cluster>[\w-]+)' = 'gke-$var_cluster'
|
||||
context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
|
||||
context_alias = "gke-$cluster"
|
||||
```
|
||||
|
||||
## Line Break
|
||||
@ -2678,19 +2743,19 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
|
||||
| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |
|
||||
| `pure_msg` | `'بێخەوش'` | A format string shown when the shell is pure. |
|
||||
| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |
|
||||
| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. |
|
||||
| `disabled` | `false` | Disables the `nix_shell` module. |
|
||||
| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| state | `بێخەوش` | The state of the nix-shell |
|
||||
| name | `lorri` | The name of the nix-shell |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | ------- | ------------------------------------ |
|
||||
| state | `pure` | The state of the nix-shell |
|
||||
| name | `lorri` | The name of the nix-shell |
|
||||
| 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
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user