diff options
author | Shu Kutsuzawa <cappyzawa@yahoo.ne.jp> | 2019-09-13 04:41:23 +0900 |
---|---|---|
committer | Matan Kushner <hello@matchai.me> | 2019-09-12 15:41:23 -0400 |
commit | 482f005d58461a72f4b56451cb649a9d3c93ab6c (patch) | |
tree | 26349bb27cd7b2f0199d7ead111f87d57a9eef8e | |
parent | 478deb09572ab92c4721eed589f111d141d5d5c5 (diff) |
docs(i18n): Localize the configuration documentation in Japanese (#339)
-rw-r--r-- | docs/ja/config/README.md | 620 |
1 files changed, 620 insertions, 0 deletions
diff --git a/docs/ja/config/README.md b/docs/ja/config/README.md new file mode 100644 index 000000000..b3baf57e7 --- /dev/null +++ b/docs/ja/config/README.md @@ -0,0 +1,620 @@ +# èšå® + +::: tip +ð¥Starshipã®éçºã¯çŸåšãé²ãã§ããŸããå€ãã®æ°ãããªãã·ã§ã³ãä»åŸã®ãªãªãŒã¹ã§å©çšå¯èœã«ãªããŸãã +::: + +starshipã®èšå®ãéå§ããã«ã¯ã`~/.config/starship.toml` ãã¡ã€ã«ãäœæããŸãã + +```shell +$ touch ~/.config/starship.toml +``` + +starshipã®ãã¹ãŠã®èšå®ã¯ããã®[TOML](https://github.com/toml-lang/toml)ãã¡ã€ã«ã§è¡ãããŸãã + +```toml +# ããã³ãã衚瀺æã«æ¹è¡ããªã +add_newline = false + +# "â¯" ãã "â" ã«è¡šç€ºãå€æŽ +[character] # The name of the module we are confguring is "character" +symbol = "â" # The "symbol" segment is being set to "â" + +# packageã¢ãžã¥ãŒã«ãç¡å¹ã«ãã +[package] +disabled = true +``` + +### çšèª + +**ã¢ãžã¥ãŒã«**: OSã®ã³ã³ããã¹ãæ
å ±ã«åºã¥ããŠæ
å ±ãæäŸããããã³ããå
ã®ã³ã³ããŒãã³ãã§ããããšãã°ãçŸåšã®ãã£ã¬ã¯ããªãNodeJSãããžã§ã¯ãã§ããå Žåããnodejsãã¢ãžã¥ãŒã«ã¯ãçŸåšã³ã³ãã¥ãŒã¿ãŒã«ã€ã³ã¹ããŒã«ãããŠããNodeJSã®ããŒãžã§ã³ã衚瀺ããŸãã + +**ã»ã°ã¡ã³ã**: ã¢ãžã¥ãŒã«ãæ§æããå°ããªãµãã³ã³ããŒãã³ãã§ããããšãã°ããnodejsãã¢ãžã¥ãŒã«ã®ãsymbolãã»ã°ã¡ã³ãã«ã¯ãããŒãžã§ã³çªå·ã®åã«è¡šç€ºãããæåãå«ãŸããŠããŸãïŒããã©ã«ã: ⬢ïŒã + +以äžã¯Node ã¢ãžã¥ãŒã«ã®è¡šçŸã§ãã次ã®äŸã§ã¯ããã·ã³ãã«ããšãããŒãžã§ã³ãã¯ãã®äžã®ã»ã°ã¡ã³ãã§ãããã¹ãŠã®ã¢ãžã¥ãŒã«ã«ã¯ãããã©ã«ãã®ç«¯æ«è²ã§ããprefixãšsuffixããããŸãã + +``` +[prefix] [symbol] [version] [suffix] + "via " "⬢" "v10.4.1" "" +``` + +### ã¹ã¿ã€ã«ã®èšå® + +starshipã®ã»ãšãã©ã®ã¢ãžã¥ãŒã«ã§ã¯ã衚瀺ã¹ã¿ã€ã«ãèšå®ã§ããŸããããã¯ãèšå®ãæå®ããæååã§ãããšã³ããªïŒ`style`ïŒã§è¡ãããŸããã¹ã¿ã€ã«æååã®äŸãšãã®æ©èœã次ã«ç€ºããŸããå®å
šãªæ§æã®è©³çŽ°ã«ã€ããŠã¯ã詳现㯠[é«åºŠãªèšå®](/advanced-config/)ãåç
§ããŠãã ãã ã + +- `"fg:green bg:blue"`ã¯ãéè²ã®èæ¯ã«ç·è²ã®ããã¹ããèšå®ããŸã +- `"bg:blue fg:bright-green"`ã¯ãéè²ã®èæ¯ã«æããç·è²ã®ããã¹ããèšå®ããŸã +- `"bold fg:27"`ã¯ã [ANSIã«ã©ãŒ](https://i.stack.imgur.com/KTSQa.png) 27ã®å€ªåããã¹ããèšå®ããŸã +- `"underline bg:#bf5700"`ã¯ãçŠãããªã¬ã³ãžè²ã®èæ¯ã«äžç·ä»ãã®ããã¹ããèšå®ããŸã +- `""`ã¯ãã¹ãŠã®ã¹ã¿ã€ã«ãæ瀺çã«ç¡å¹ã«ããŸã + +ã¹ã¿ã€ãªã³ã°ãã©ã®ããã«èŠãããã¯ã端æ«ãšãã¥ã¬ãŒã¿ã«ãã£ãŠå¶åŸ¡ãããããšã«æ³šæããŠãã ãããããšãã°ãäžéšã®ç«¯æ«ãšãã¥ã¬ãŒã¿ã¯ããã¹ãã倪åã«ãã代ããã«è²ãæããããŸãããŸããäžéšã®ã«ã©ãŒããŒãã¯éåžžã®è²ãšæããè²ãšåãå€ã䜿çšããŸãã + +## ããã³ãã + +ããã¯ãããã³ããå
šäœã®ãªãã·ã§ã³ã®ãªã¹ãã§ãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`add_newline` | `true` | ããã³ããã®éå§åã«æ°ããè¡ãè¿œå ããŸãã +`prompt_order` | [link](#%E3%83%87%E3%83%95%E3%82%A9%E3%83%AB%E3%83%88%E3%81%AE%E3%83%97%E3%83%AD%E3%83%B3%E3%83%97%E3%83%88%E9%A0%86) | ããã³ããã¢ãžã¥ãŒã«ãåºåããé åºãèšå®ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +# ããã³ãã衚瀺ã®æ¹è¡ãç¡å¹ã«ãã +add_newline = false +# ããã©ã«ãã®ããã³ãã衚瀺é ãæžãæãã +prompt_order=["rust","line_break","package","line_break","character"] +``` + +### ããã©ã«ãã®ããã³ãã衚瀺é + +`default_prompt_order`ãªãã·ã§ã³ã¯ã空ãŸãã¯`prompt_order`ãæå®ãããŠããªãå Žåã«ãããã³ããã«ã¢ãžã¥ãŒã«ã衚瀺ãããé åºãå®çŸ©ããããã«äœ¿çšãããŸããããã©ã«ãã¯æ¬¡ã®ãšããã§ãã + +``` +default_prompt_order = [ + "username", + "hostname", + "directory", + "git_branch", + "git_state", + "git_status", + "package", + "nodejs", + "ruby", + "rust", + "python", + "golang", + "nix_shell", + "cmd_duration", + "line_break", + "jobs", + "time", + "battery", + "character", +] +``` + +## ããããªãŒ + +`battery`ã¢ãžã¥ãŒã«ã¯ãããã€ã¹ã®ããããªãŒæ®éãšçŸåšã®å
é»ç¶æ
ã瀺ããŸããã¢ãžã¥ãŒã«ã¯ãããã€ã¹ã®ããããªãŒæ®éã10ïŒ
æªæºã®å Žåã«ã®ã¿è¡šç€ºãããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`full_symbol` | `"â¢"` | ããããªãŒãæºã¿ã³ã®ãšãã«è¡šç€ºãããèšå·ã§ãã +`charging_symbol` | `"â¡"` | ããããªãŒã®å
é»äžã«è¡šç€ºãããèšå·ã§ãã +`discharging_symbol` | `"â£"` | ããããªãŒãæŸé»ããŠãããšãã«è¡šç€ºãããèšå·ã§ãã +`style` | `"bold red"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `battery`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[battery] +full_symbol = "ð" +charging_symbol = "â¡ïž" +discharging_symbol = "ð" +``` + +## æå + +`character`ã¢ãžã¥ãŒã«ã¯ã端æ«ã§ããã¹ããå
¥åãããå Žæã®æšªã«æåïŒéåžžã¯ç¢å°ïŒã衚瀺ããŸãã + +æåã¯ãæåŸã®ã³ãã³ããæåãããã©ããã瀺ããŸããããã¯ãè²ã®å€æŽïŒèµ€/ç·ïŒãŸãã¯ãã®åœ¢ç¶ã®å€æŽ(â¯/â)ã®2ã€ã®æ¹æ³ã§è¡ãããšãã§ããŸããåŸè
ã¯`use_symbol_for_status`ã«`true`èšå®ãããŠããå Žåã«ã®ã¿è¡ãããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"â¯"` | ããã³ããã§ããã¹ããå
¥åããåã«äœ¿çšãããèšå·ã§ãã +`error_symbol` | `"â"` | åã®ã³ãã³ãã倱æããå Žåã«ããã¹ãå
¥åã®åã«äœ¿çšãããèšå·ã§ãã +`use_symbol_for_status` | `false` | ã·ã³ãã«ãå€æŽããŠãšã©ãŒã¹ããŒã¿ã¹ã瀺ããŸãã +`vicmd_symbol` | `"â®"` | ã·ã§ã«ãvimã®éåžžã¢ãŒãã§ããå Žåãããã³ããã®ããã¹ãå
¥åã®åã«äœ¿çšãããèšå·ã§ãã +`style_success` | `"bold green"` | æåŸã®ã³ãã³ããæåããå Žåã«äœ¿çšãããã¹ã¿ã€ã«ã§ãã +`style_failure` | `"bold red"` | æåŸã®ã³ãã³ãã倱æããå Žåã«äœ¿çšãããã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `character`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[character] +symbol = "â" +error_symbol = "â" +use_symbol_for_status = true +``` + +## ã³ãã³ãå®è¡æé + +`cmd_duration`ã¢ãžã¥ãŒã«ã¯ãæåŸã®ã³ãã³ãã®å®è¡ã«ããã£ãæéã瀺ããŸããã¢ãžã¥ãŒã«ã衚瀺ãããã®ã¯ãã³ãã³ãã2ç§ä»¥äžããã£ãå ŽåããŸãã¯`min_time`å€ãååšããå Žåã®ã¿ã§ãã + +::: warning Bashã§DEBUGãã©ãããhookããªã +`bash`ã§Starshipãå®è¡ããŠããå Žåã `eval $(starship init $0)`å®è¡ããåŸã«`DEBUG`ãã©ãããããã¯ããªãã§ãã ãããããããªããšããã®ã¢ãžã¥ãŒã«ã**ããããã§ãã**å£ããŸãã +::: + +preexecã®ãããªæ©èœãå¿
èŠãšããBashãŠãŒã¶ãŒã¯ã [rcalorasã®bash_preexecãã¬ãŒã ã¯ãŒã¯](https://github.com/rcaloras/bash-preexec)ã䜿çšã§ããŸãã `eval $(starship init $0)` ãå®è¡ããåã«ã`preexec_functions` ãããã³`precmd_functions`å®çŸ©ããã ãã§ãéåžžã©ããç¶è¡ããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`min_time` | `2` | æéã衚瀺ããæçæéã§ãã +`style` | `"bold yellow"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `cmd_duration`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[cmd_duration] +min_time = 4 +``` + +## ãã£ã¬ã¯ã㪠+ +`directory`ã¢ãžã¥ãŒã«ã«ã¯ãçŸåšã®ãã£ã¬ã¯ããªãžã®ãã¹ã衚瀺ããã3ã€ã®èŠªãã©ã«ãã¯åãæšãŠãããŸãããã£ã¬ã¯ããªã¯ãçŸåšã®gitãªããžããªã§ãããšã«ãŒããšãªããŸãã + +fishã¹ã¿ã€ã«ã®pwdãªãã·ã§ã³ã䜿çšãããšãåãæšãŠããããã¹ãé衚瀺ã«ãã代ããã«ããªãã·ã§ã³ã§æå¹ã«ããçªå·ã«åºã¥ããŠåãã£ã¬ã¯ããªã®ççž®åã衚瀺ãããŸãã + +ããšãã°ã`~/Dev/Nix/nixpkgs/pkgs`ã§ã`nixpkgs`ããªããžããªã«ãŒãã§ããããªãã·ã§ã³ã`1`ã«èšå®ãããŠããå Žåã`~/D/N/nixpkgs/pkgsã衚瀺ãããŸããã以åã¯nixpkgs/pkgs`ã§ããã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`truncation_length` | `3` | çŸåšã®ãã£ã¬ã¯ããªãåãæšãŠã芪ãã©ã«ããŒã®æ°ã§ãã +`truncate_to_repo` | `true` | çŸåšããgitãªããžããªã®ã«ãŒãã«åãæšãŠããã©ããã§ãã +`fish_style_pwd_dir_length` | `0` | fish shellã®pwdãã¹ããžãã¯ãé©çšãããšãã«äœ¿çšããæåæ°ã§ãã +`style` | `"bold cyan"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `directory`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[directory] +truncation_length = 8 +``` + +## Git ãã©ã³ã + +`git_branch`Moduleã¯ãçŸåšã®ãã£ã¬ã¯ããªã«ããã¬ãã®ã¢ã¯ãã£ããªãã©ã³ãã衚瀺ããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"î "` | çŸåšã®ãã£ã¬ã¯ããªã®ãªããžããªã®ãã©ã³ãåã®åã«äœ¿çšãããã·ã³ãã«ã§ãã +`truncation_length` | `2^63 - 1` | gitãã©ã³ããXæžèšçŽ ã«åãæšãŠãŸã +`truncation_symbol` | `"âŠ"` | ãã©ã³ãååãæšãŠãããŠããããšã瀺ãããã®èšå·ã§ããèšå·ãªãã«ããã䜿çšã§ããŸãã +`style` | `"bold purple"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `git_branch`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[git_branch] +symbol = "ð± " +truncation_length = "4" +truncation_symbol = "" +``` + +## Git ã®é²è¡ç¶æ
+ +`git_state` Module ã¯gitãã£ã¬ã¯ããªã®é²è¡ç¶æ
ãè¡šããŸãã +äŸ: *REBASING*, *BISECTING*, ãã®ä» + +é²ææ
å ±ãããå Žå(äŸ: REBASING 3/10)ã¯ãã®æ
å ±ã衚瀺ãããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`rebase` | `"REBASING"` | `rebase`é²è¡äžã«è¡šç€ºãããããã¹ãã§ãã +`merge` | `"MERGING"` | `merge`é²è¡äžã«è¡šç€ºãããããã¹ãã§ãã +`revert` | `"REVERTING"` | `revert`é²è¡äžã«è¡šç€ºãããããã¹ãã§ãã +`cherry_pick` | `"CHERRY-PICKING"` | `cherry-pick`é²è¡äžã«è¡šç€ºãããããã¹ãã§ãã +`bisect` | `"BISECTING"` | `bisect`é²è¡äžã«è¡šç€ºãããããã¹ãã§ãã +`am` | `"AM"` | `apply-mailbox` ïŒ `git am` ïŒã®é²è¡äžã«è¡šç€ºãããããã¹ãã§ãã +`am_or_rebase` | `"AM/REBASE"` | ãããŸããª`apply-mailbox`ãŸãã¯`rebase`ãé²è¡äžã®ãšãã«è¡šç€ºãããããã¹ãã§ãã +`progress_divider` | `"/"` | çŸåšã®é²è¡éãšåèšé²è¡éãåããèšå·ãŸãã¯ããã¹ã(äŸãã°ã `" of "` ã `"3 of 10"` )ã§ãã +`style` | `"bold yellow"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `git_state`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[git_state] +progress_divider = " of " +cherry_pick = "ð PICKING" +``` + +## Gitã®ç¶æ
+ +`git_status`ã¢ãžã¥ãŒã«ã¯ãçŸåšã®ãã£ã¬ã¯ããªã®ãªããžããªã®ç¶æ
ãè¡šãã·ã³ãã«ã衚瀺ããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`conflicted` | `"="` | ãã®ãã©ã³ãã«ã¯ããŒãžã®ç«¶åããããŸãã +`ahead` | `"â¡"` | ãã®ãã©ã³ãã¯ã远跡ããããã©ã³ããããå
ã«ãããŸãã +`behind` | `"â£"` | ãã®ãã©ã³ãã¯ã远跡ãããŠãããã©ã³ãã®èåŸã«ãããŸãã +`diverged` | `"â"` | ãã®ãã©ã³ãã¯ã远跡ãããŠãããã©ã³ãããåå²ããŠããŸãã +`untracked` | `"?"` | äœæ¥ãã£ã¬ã¯ããªã«è¿œè·¡ãããŠããªããã¡ã€ã«ããããŸãã +`stashed` | `"$"` | ããŒã«ã«ãªããžããªçšã®ã¹ã¿ãã·ã¥ãååšããŸãã +`modified` | `"!"` | äœæ¥ãã£ã¬ã¯ããªã«ãã¡ã€ã«ã®å€æŽããããŸãã +`staged` | `"+"` | æ°ãããã¡ã€ã«ãã¹ããŒãžã³ã°é åã«è¿œå ãããŸããã +`renamed` | `"»"` | ååãå€æŽããããã¡ã€ã«ãã¹ããŒãžã³ã°é åã«è¿œå ãããŸããã +`deleted` | `"â"` | ãã¡ã€ã«ã®åé€ãã¹ããŒãžã³ã°é åã«è¿œå ãããŸããã +`show_sync_count` | `false` | 远跡ãããŠãããã©ã³ãã®å
è¡/åŸæ¹ã«ãŠã³ãã衚瀺ããŸãã +`style` | `"bold red"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `git_status`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[git_status] +conflicted = "ð³" +ahead = "ððš" +behind = "ð°" +diverged = "ðµ" +untracked = "ð€·â" +stashed = "ðŠ" +modified = "ð" +staged = "â" +renamed = "ð
" +deleted = "ð" +``` + +## Golang + +`golang`ã¢ãžã¥ãŒã«ã¯ãçŸåšã€ã³ã¹ããŒã«ãããŠããGolangã®ããŒãžã§ã³ã瀺ããŸãã次ã®æ¡ä»¶ã®ãããããæºãããããšãã¢ãžã¥ãŒã«ã衚瀺ãããŸãã + +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`go.mod`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`go.sum`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`glide.yaml`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`Gopkg.yml`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`Gopkg.lock`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`Godeps`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`.go`ã®æ¡åŒµåã®ãã¡ã€ã«ãå«ãŸããŠãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"ð¹ "` | Golangã®ããŒãžã§ã³ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`style` | `"bold cyan"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `golang`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[golang] +symbol = "ððš " +``` + +## ãã¹ãå + +`hostname`ã¢ãžã¥ãŒã«ã«ã¯ãã·ã¹ãã ã®ãã¹ãåã衚瀺ãããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`ssh_only` | `true` | SSHã»ãã·ã§ã³ã«æ¥ç¶ãããŠããå Žåã«ã®ã¿ãã¹ãåã衚瀺ããŸãã +`prefix` | `""` | ãã¹ãåã®çŽåã«è¡šç€ºããprefixã§ãã +`suffix` | `""` | ãã¹ãåã®çŽåŸã«è¡šç€ºããsuffixã§ãã +`style` | `"bold dimmed green"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `hostname`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[hostname] +ssh_only = false +prefix = "âª" +suffix = "â«" +disabled = false +``` + +## ãžã§ã + +`jobs`ã¢ãžã¥ãŒã«ã«ã¯ãå®è¡äžã®ãžã§ãã®çŸåšã®æ°ã衚瀺ãããŸãããã®ã¢ãžã¥ãŒã«ã¯ãå®è¡äžã®ããã¯ã°ã©ãŠã³ããžã§ããããå Žåã«ã®ã¿è¡šç€ºãããŸãã1ã€ä»¥äžã®ãžã§ããããããŸãã¯`threshold`ã«æå®ããå€ä»¥äžã«ãžã§ããããå Žåã¯å®è¡äžã®ãžã§ãã®æ°ã衚瀺ããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"⊠"` | ãžã§ãã®æ°ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`threshold` | `1` | è¶
éããå Žåããžã§ãã®æ°ã衚瀺ããŸãã +`style` | `"bold blue"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `jobs`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[jobs] +symbol = "+ " +threshold = 4 +``` + +## æ¹è¡ + +`line_break`ã¢ãžã¥ãŒã«ã¯ãããã³ããã2è¡ã«åå²ããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`disabled` | `false` | `line_break`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŠãããã³ããã1è¡ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[line_break] +disabled = true +``` + +## Nix-shell + +`nix_shell`ã¢ãžã¥ãŒã«ã¯ãnix-shellç°å¢ã瀺ããŠããŸãããã®ã¢ãžã¥ãŒã«ã¯ãnixã·ã§ã«ç°å¢å
ã«ãããšãã«è¡šç€ºãããŸãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`use_name` | `false` | nix-shellã®ååã衚瀺ããŸãã +`impure_msg` | `impure` | impureã¡ãã»ãŒãžãã«ã¹ã¿ãã€ãºããŸãã +`pure_msg` | `pure` | pureã¡ãã»ãŒãžãã«ã¹ã¿ãã€ãºããŸãã +`style` | `"bold red"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `nix_shell`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[nix_shell] +disabled = true +use_name = true +impure_msg = "impure shell" +pure_msg = "pure shell" +``` + +## NodeJS + +`nodejs`ã¢ãžã¥ãŒã«ã¯ãçŸåšã€ã³ã¹ããŒã«ãããŠããNodeJSã®ããŒãžã§ã³ã瀺ããŸãã次ã®æ¡ä»¶ã®ãããããæºãããããšãã¢ãžã¥ãŒã«ã衚瀺ãããŸãã + +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`package.json`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`node_modules`ãã£ã¬ã¯ããªãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`.js`ã®æ¡åŒµåã®ãã¡ã€ã«ãå«ãŸããŠãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"⬢ "` | NodeJSã®ããŒãžã§ã³ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`style` | `"bold green"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `nodejs`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[nodejs] +symbol = "ð€ " +``` + +## ããã±ãŒãžã®ããŒãžã§ã³ + +`package`ã¢ãžã¥ãŒã«ã¯ãçŸåšã®ãã£ã¬ã¯ããªãããã±ãŒãžã®ãªããžããªã§ããå Žåã«è¡šç€ºãããçŸåšã®ããŒãžã§ã³ã衚瀺ãããŸãããã®ã¢ãžã¥ãŒã«ã¯çŸåšã `npm` ã `cargo` ãããã³`poetry`ããã±ãŒãžããµããŒãããŠããŸãã + +- **npm** â `npm`ããã±ãŒãžããŒãžã§ã³ã¯ãçŸåšã®ãã£ã¬ã¯ããªã«ãã`package.json`ããæœåºãããŸã +- **cargo** â `cargo`ããã±ãŒãžããŒãžã§ã³ã¯ãçŸåšã®ãã£ã¬ã¯ããªã«ãã`Cargo.toml`ããæœåºãããŸãã +- **poetry** â `poetry`ããã±ãŒãžããŒãžã§ã³ã¯ãçŸåšã®ãã£ã¬ã¯ããªã«ãã`pyproject.toml`ããæœåºãããŸã + +> â ïž è¡šç€ºãããããŒãžã§ã³ã¯ãããã±ãŒãžãããŒãžã£ãŒã§ã¯ãªãããœãŒã¹ã³ãŒããçŸåšã®ãã£ã¬ã¯ããªã«ããããã±ãŒãžã®ããŒãžã§ã³ã§ãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"ðŠ "` | ããã±ãŒãžã®ããŒãžã§ã³ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`style` | `"bold red"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `package`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[package] +symbol = "ð " +``` + +## Python + +`python`ã¢ãžã¥ãŒã«ã¯ãçŸåšã€ã³ã¹ããŒã«ãããŠããPythonã®ããŒãžã§ã³ã瀺ããŸãã + +`pyenv_version_name`ã`true`ã«èšå®ãããŠããå Žå ãpyenvã§ã®ããŒãžã§ã³åã衚瀺ãããŸã ã + +ãã以å€ã®å Žåã¯ã `python --version`ããŒãžã§ã³çªå·ã衚瀺ãããã¢ã¯ãã£ãã«ãªã£ãŠããå Žåã¯çŸåšã®Pythonä»®æ³ç°å¢ã衚瀺ãããŸãã + +次ã®æ¡ä»¶ã®ãããããæºãããããšãã¢ãžã¥ãŒã«ã衚瀺ãããŸãã + +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`.python-version`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`requirements.txt`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`pyproject.toml`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`.py`ã®æ¡åŒµåã®ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`Pipfile`ãã¡ã€ã«ãå«ãŸããŠãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"ð "` | Pythonã®ããŒãžã§ã³ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`pyenv_version_name` | `false` | pyenvã䜿çšããŠPythonããŒãžã§ã³ãååŸããŸã +`pyenv_prefix` | `"pyenv "` | pyenvããŒãžã§ã³è¡šç€ºã®åã®prefixïŒããã©ã«ãã®è¡šç€ºã¯`pyenv MY_VERSION` ïŒã§ã +`style` | `"bold yellow"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `python`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[python] +symbol = "ðŸ " +pyenv_version_name = true +pyenv_prefix = "foo " +``` + +## Ruby + +`ruby`ã¢ãžã¥ãŒã«ã¯ãçŸåšã€ã³ã¹ããŒã«ãããŠããRubyã®ããŒãžã§ã³ã瀺ããŸãã次ã®æ¡ä»¶ã®ãããããæºãããããšãã¢ãžã¥ãŒã«ã衚瀺ãããŸãã + +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`Gemfile`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`.rb`ã®æ¡åŒµåã®ãã¡ã€ã«ãå«ãŸããŠãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"ð "` | Rubyã®ããŒãžã§ã³ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`style` | `"bold red"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `ruby`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[ruby] +symbol = "ðº " +``` + +## Rust + +`rust`ã¢ãžã¥ãŒã«ã«ã¯ãçŸåšã€ã³ã¹ããŒã«ãããŠããRustã®ããŒãžã§ã³ã衚瀺ãããŸãã次ã®æ¡ä»¶ã®ãããããæºãããããšãã¢ãžã¥ãŒã«ã衚瀺ãããŸãã + +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`Cargo.toml`ãã¡ã€ã«ãå«ãŸããŠãã +- ã«ã¬ã³ããã£ã¬ã¯ããªã«`.rs`ã®æ¡åŒµåã®ãã¡ã€ã«ãå«ãŸããŠãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`symbol` | `"ðŠ "` | Rustã®ããŒãžã§ã³ã衚瀺ããåã«äœ¿çšãããèšå·ã§ãã +`style` | `"bold red"` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `rust`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[rust] +symbol = "âïž " +``` + +## æå» + +`time`ã¢ãžã¥ãŒã«ã¯ãçŸåšã®**çŸå°**æéã瀺ããŸãã `format`èšå®ã¯ãæéã®è¡šç€ºæ¹æ³ãå¶åŸ¡ããããã«[`chrono`](https://crates.io/crates/chrono)ã¯ã¬ãŒãã«ãã£ãŠäœ¿çšãããŸãã䜿çšå¯èœãªãªãã·ã§ã³ã確èªããã«ã¯ã[chrono strftimeã®ããã¥ã¡ã³ã](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)ãã芧ãã ããã + +::: tip +ãã®ã¢ãžã¥ãŒã«ã¯ããã©ã«ãã§ç¡å¹ã«ãªã£ãŠããŸããæå¹ã«ããã«ã¯ãèšå®ãã¡ã€ã«ã§`disabled`ã`false`ã«èšå®ããŸãã +::: + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`12hr` | `false` | 12æéã®ãã©ãŒããããæå¹ã«ããŸãã +`format` | ãã®è¡šã®äžãåç
§ããŠãã ãã | æå»ã®ãã©ãŒãããã«äœ¿çšããã[ã¯ãããã©ãŒãããæåå](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) ã§ãã +`style` | `bold yellow` | ã¢ãžã¥ãŒã«ã®ã¹ã¿ã€ã«ã§ãã +`disabled` | `true` | `time`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +`12hr`ã`true` ã `format`ããã©ã«ãã§`"%r"`ã§ãããã以å€ã®å Žåãããã©ã«ãã¯`"%T"`ã§ãã `format`ãæåã§èšå®ãããšã `12hr`ã®èšå®ãäžæžããããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[time] +disabled = false +format = "ð[ %T ]" +``` + +## ãŠãŒã¶å + +`username`ã¢ãžã¥ãŒã«ã«ã¯ãã¢ã¯ãã£ããªãŠãŒã¶ãŒã®ãŠãŒã¶ãŒåã衚瀺ãããŸãã次ã®æ¡ä»¶ã®ãããããæºãããããšãã¢ãžã¥ãŒã«ã衚瀺ãããŸãã + +- ã«ã¬ã³ããŠãŒã¶ãŒãroot +- ã«ã¬ã³ããŠãŒã¶ãŒãããã°ã€ã³ããŠãããŠãŒã¶ãŒãšã¯ç°ãªã +- ãŠãŒã¶ãŒãSSHã»ãã·ã§ã³ãšããŠæ¥ç¶ãããŠãã + +### ãªãã·ã§ã³ + +å€æ° | ããã©ã«ã | 説æ +--- | --- | --- +`style_root` | `"bold red"` | ãŠãŒã¶ãŒãrootã®ãšãã«äœ¿çšãããã¹ã¿ã€ã«ã§ãã +`style_user` | `"bold yellow"` | érootãŠãŒã¶ãŒã«äœ¿çšãããã¹ã¿ã€ã«ã§ãã +`disabled` | `false` | `username`ã¢ãžã¥ãŒã«ãç¡å¹ã«ããŸãã + +### èšå®äŸ + +```toml +# ~/.config/starship.toml + +[username] +disabled = true +``` |