3.0: Roadmap

[denysdovhan]

A checklist and discussion about v3.0 (#148) release and new features.

Roadmap

• Remove deprecation warnings of v2.0
• Drop OMZ as dependency
  • Git status without OMZ (Drop Oh-My-Zsh dependency #147)
  • Remove OMZ from descriptions.
  • Installation over promptinit
  • Rewrite install.zsh in sh
  • Rewrite uninstall.zsh in sh
• Add $SPACESHIP_VERSION
• Fix zgen bug with sourcing install.zsh and uninstall.zsh
• Expose SPACESHIP_OPENED
• Expose options for char (Expose prompt character color variables #115)
• Organize project structure (Organize project tree #127)
  • Split single file into the parts (sections folder)
  • Create lib folder
  • scripts folder for scripts
• Add deprecation warnings for broken options
• Show only root directory in repos (Show git repository folder when inside a git repo #169)
• Add right prompt RPS1 (Added SPACESHIP_RPROMPT_ORDER option for RPS1 prompt #168)
• Added support to always show user host (Added support to always show user host #211)
• Fix bugs
• Intergrate Add kubectl context #197
• Custom sections (Allow to invoke custom functions #262)
• Drop $LS_COLORS (Drop LS_COLORS variable #273)
• Make showing battery on 100% configurable (Make showing battery on 100% configurable #306)
• Update README.md and docs (Docs for 3.0 (#148) #313)

---

• (Optional) Add ability to render prompt with agnoster-like segments
• (Optional) Add tests for basic functionality
• (Optional) Speed up with async rendering

[denysdovhan]

@sfarzy I would like to use Conventional Commits. Very useful for generating changelogs. What do you think?

[denysdovhan]

@sfarzy however, I don't want to introduce new dependency like standard-version. Also, I don't like limitations with this approach.

[salmanulfarzy]

Very useful for generating changelogs

Take a look at skywinder/github-changelog-generator, It's does the job well.

[nfischer]

At ShellJS we created https://github.com/shelljs/changelog. This wraps around skywinder's project.

[salmanulfarzy]

Slow git status checking

Currently we're using git status --porcelain -b in git section. But it was noted slow in multiple issues. Is there any better way in doing this ?

[denysdovhan]

@salmanulfarzy zsh can provide vsc information out of the box, but it wouldn't be as reach as our implementation.

[sei40kr]

@denysdovhan

• (Optional) Speed up with async rendering
  Are you implementing this now?
  I really want this feature, so I would like to implement this if you're not working on now.

[denysdovhan]

@sei40kr I was playing in a playground with zsh-async. However, I don't have enough time to dive deeper and implement this right now. Would be great if you help!

Please, open another PR to the 3.0 branch. Async API has to be discussed.

[denysdovhan]

@sei40kr any updates?

[belak]

What's the status on this?

[denysdovhan]

@belak currently I'm busy at work and don't have enough time to finish this release. Hope I'll have more time soon.

3.0 features are settled. It only needs to implement spaceship_upgrade/spaceship_uninstall, resolve some conflicts, fix some styling issues and update docs.

You can support my efforts by contributing or donations. Thanks for understanding!

[belak]

Not a problem. Thanks for the update! I totally understand being really busy on other stuff.

Since I don't think we need upgrade/uninstall for prezto, I'll add this branch as a theme in our contrib repo and follow this for when there's an official release.

[denysdovhan]

Breaking changes

• SPACESHIP_PROMPT_SYMBOL has been removed. Use SPACESHIP_CHAR_SYMBOL instead.
• SPACESHIP_BATTERY_ALWAYS_SHOW has been removed. Use SPACESHIP_BATTERY_SHOW='always' instead.
• SPACESHIP_BATTERY_CHARGING_SYMBOL has been replaced by SPACESHIP_BATTERY_SYMBOL_CHARGING.
• SPACESHIP_BATTERY_DISCHARGING_SYMBOL has been replaced by SPACESHIP_BATTERY_SYMBOL_DISCHARGING.
• SPACESHIP_BATTERY_FULL_SYMBOL has been replaced by SPACESHIP_BATTERY_SYMBOL_FULL.
• SPACESHIP_HOST_SHOW now accepts value 'always'.
• SPACESHIP_USER_SHOW now accepts value 'always'.
• SPACESHIP_HOST_COLOR equals 'blue' instead of 'green'.
• SPACESHIP_HOST_COLOR_SSH is a new option.
• SPACESHIP_PROMPT_ORDER has been changed.
• SPACESHIP_BATTERY_ALWAYS_SHOW has been removed. Use SPACESHIP_BATTERY_SHOW='always' instead.
• SPACESHIP_PROMPT_FIRST_PREFIX_SHOW is a new option.
• SPACESHIP_DIR_TRUNC_REPO is a new option.

[denysdovhan]

#313 is ready to merge and waiting for approvement.

The work on #148 is finished and it's ready to merge after approvement.

[denysdovhan]

Published as v3.0.0!