Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nberlette/gitpod-enhanced
Turbocharge your Gitpod Workspaces with my custom built version of gitpod/workspace-full.
https://github.com/nberlette/gitpod-enhanced
automation bash cli docker dockerfile dotfiles git-prompt gitpod gitpod-enhanced gitpod-workspace ide starship starship-prompt typescript vscode
Last synced: 3 months ago
JSON representation
Turbocharge your Gitpod Workspaces with my custom built version of gitpod/workspace-full.
- Host: GitHub
- URL: https://github.com/nberlette/gitpod-enhanced
- Owner: nberlette
- License: mit
- Created: 2021-12-04T19:35:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-11T03:38:31.000Z (about 1 year ago)
- Last Synced: 2024-07-27T07:33:12.246Z (3 months ago)
- Topics: automation, bash, cli, docker, dockerfile, dotfiles, git-prompt, gitpod, gitpod-enhanced, gitpod-workspace, ide, starship, starship-prompt, typescript, vscode
- Language: Dockerfile
- Homepage: https://gitpod.tk
- Size: 1.24 MB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
gitpod-enhanced
Turbocharged [Gitpod.io](https://gitpod.io) [workspace image](https://hub.docker.com/r/nberlette/gitpod-enhanced) (built on-top of the official [**gitpod/workspace-full**](https://hub.docker.com/r/gitpod/workspace-full)) with some tasteful enhancements to improve developer experience.
---
## Getting Started
```yaml
# add to .gitpod.yml
image: nberlette/gitpod-enhanced
```
---
## Features
### Git Enhancements
- Displays git info with ([`git-prompt.sh` from official git repo](https://git.io/git-ps1))
- [GitHub CLI](https://cli.github.com), [`git-extras`](https://github.com/tj/git-extras), `fzf`, and `neovim`
- [GPG support](#gpg-support) for PGP-signing commits (with VSCode integration)
### Package Management
- [`pnpm`](https://npm.im/pnpm), [`degit`](https://npm.im/degit), [`@antfu/ni`](https://npm.im/@antfu/ni) for simple package management
- [`typescript`](https://typescriptlang.org), [`ts-node`](https://npm.im/ts-node), [`ts-standard`](https://npm.im/ts-standard)
- `yarn global bin` prepended to the `$PATH` (e.g. allows command `next` instead of `npx next`!)
### Other terminal addons
- Installs sensible defaults for `ls`, `diff`, `grep` - all with `color`
- Bundled with many useful aliases, tools, and various other functional upgrades
- Removes duplicate entries from `$PATH` variable
---
## Configuration
> For more details on builtin workspace features, see the [Gitpod documentation](https://gitpod.io/docs/configuration.html).
### GitHub CLI Authentication
I'm currently working (on minimal bandwidth) to integrate the newly-released `dotfiles` support with gitpod-enhanced, which will allow for a lot more streamlined configuration for settings such as this.
Until then, however, we have only the finest of janky solutions!
```bash
GITHUB_TOKEN="ghp_2ed23idj023ijmdjqkfewjdsnfe"
# set with gitpod's CLI:
eval $(gp env -e GITHUB_TOKEN=$GITHUB_TOKEN)
```
Setting the $GITHUB_TOKEN variable with a properly-scoped PAT (personal access token), will direct `gitpod-enhanced` to automatically authenticate your account with the GitHub CLI.
This means you'll be able to use the full list of features as soon as you fire up your workspaces!
---
### GPG Support
I've recently included (experimental) support for GPG commit signatures, via the command line or Visual Studio Code UI.
If you create a new PGP key within a Gitpod workspace using the GitHub CLI (`gh`), it's pretty straightforward:
```bash
# find using gpg (or in output of `gh keys`)
gpg --list-secret-keys --keyid-format LONG
# save as $GPG_KEY_ID
GPG_KEY_ID=""
# export to gitpod
gp env GPG_KEY=$(gpg --export-secret-keys $GPG_KEY_ID | base64 -w 0)
# saves key-id; exports all gp vars to current workspace
eval $(gp env -e GPG_KEY_ID=$GPG_KEY_ID)
# source our .bashrc file for changes to take effect
source ~/.bashrc
```
---
### Formatting `PS1` and `GIT_PS1`
The `GIT_PS1_` environment variables control the functions and display of the git-integrated shell prompt.
These are the currently available options and their default:
```bash
GIT_PS1_SHOWCOLORHINTS="1"
GIT_PS1_SHOWDIRTYSTATE="1"
GIT_PS1_SHOWSTASHSTATE=""
GIT_PS1_SHOWUNTRACKEDFILES=""
GIT_PS1_SHOWUPSTREAM="auto"
GIT_PS1_OMITSPARSESTATE="1"
GIT_PS1_STATESEPARATOR=""
GIT_PS1_DESCRIBE_STYLE="tag"
GIT_PS1_HIDE_IF_PWD_IGNORED="1"
```
The last three options are `GIT_PS1_PREFIX`, `GIT_PS1_SUFFIX`, `GIT_PS1_FORMAT`.
These allow you to change the colors and format of the surrounding `PS1` prompt string.
```bash
GIT_PS1_PREFIX="\[\e]0;\u \W\e\]\[\e[1;7;33m\] \u \[\e[0;7;36m\] \w \[\e[0;1m\] git:("
GIT_PS1_SUFFIX="\[\e[1m\])\[\e[0m\]\n\[\e[1;32;6m\]\$\[\e[0m\] "
GIT_PS1_FORMAT="%s"
```
They have no `git config` equivalent, and must be set in `settings.json`, the Gitpod Dashboard, or through the command `gp env` in the terminal:
```bash
eval $(gp env -e GIT_PS1_PREFIX="\[\e[1m\] \w \[\e[0m\] ... ")
```
---
> You may change/remove any of these (with scope!) in **Dashboard > Settings > Variables**.
### Override via `.vscode/settings.json`
```jsonc
// .vscode/settings.json
{
"terminal.integrated.env.linux": {
"GIT_PS1_SHOWUPSTREAM": "auto verbose name",
"GIT_PS1_SHOWUNTRACKEDFILES": ""
}
}
```
---
### Override via `.gitpod.yml`
```yaml
# .gitpod.yml
gitConfig:
bash.showUpstream: "false"
bash.hideIfPwdIgnored: "false"
```
Note: only ***some*** of the variables have an equivalent `git config` value, which allows you to override them on a per-repository level, right from the `.gitpod.yml` configuration file.
---
## Contributing
Community contributions are paramount to the success of Open Source projects such as this, and maintainers like me rely on people like you to help keep the code alive. **You are more than welcome** to make any contributions, and I highly encourage you to make a pull request - regardless of whether you're adding, editing, or deleting code. It's all welcome here.
---
## Code of Conduct
Please [read the guidelines for contributing](./.github/CONTRIBUTING.md), as well as our [community code of conduct](./.github/CODE_OF_CONDUCT.md) before you make any contributions. Once you feel familiar with them, if you have any questions just [open an issue](./issues) or contact me.
---
## License
[MIT](https://mit-license.org) © 2022 [Nicholas Berlette](https://github.com/nberlette) • all rights reserved