Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tmarsteel/coding-bash
Various extensions to a bash shell to aid with Git & Coding Projects
https://github.com/tmarsteel/coding-bash
Last synced: 4 days ago
JSON representation
Various extensions to a bash shell to aid with Git & Coding Projects
- Host: GitHub
- URL: https://github.com/tmarsteel/coding-bash
- Owner: tmarsteel
- License: mit
- Created: 2018-05-04T12:23:15.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T14:38:51.000Z (19 days ago)
- Last Synced: 2024-10-27T16:41:51.345Z (19 days ago)
- Language: Shell
- Size: 99.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coding-bash
Various extensions to a bash shell to aid with Git & Coding Projects
## How to install
Run the `setup.sh` file from any directory. Restart your shell and off you go.
### Updating
To update, simply do `git pull`. If you care about the git subcommands, also run `./apply-git-aliases.sh`.
## Features
### Terminal Title
* Displays name current directory
* when you are within the directory tree of a git repository or a directory that is managed by a build tool, indicates that:
* the git root is indicated using `Σ` (adjustable, see below), e.g. `Σ some-repository`
* the build tool root is indicated using `γ` (adjustable, see below), e.g. `γ some-maven-project`
* when git root and build tool root differ, both are displayed separately, e.g. `Σ my-app-server γ submodule1`
* when they are equal, the two indicators are combined: `Σγ my-app-server`
The git root is determined using `git rev-parse --show-toplevel`, see https://git-scm.com/docs/git-rev-parse.
Build tools are recognized using a file sepcific to them (e.g. Gradle: `build.gradle`, Composer: `composer.json`,
Maven: `pom.xml`, Cargo: `Cargo.toml`). You can adjust/extend this, see below.
### Prompt
The prompt **spans two lines** and has this format:
```
[]
```
By default, the prompt char for non-root-users is `λ` and `Ω` for root (can be changed, see below).
E.g.:
```
~
λ cd /tmp
/tmp
λ cd /var/www
/var/www
λ sudo bash
[sudo] password for john.doe:
/var/www
Ω echo "im root!"
im root!
/var/www
Ω
```
#### Repository information
When within a directory that is managed by git, displays the repository name and the current branch, e.g.:
```
~/coding/rust
Σ rust > master λ git remote get-url origin
https://github.com/rust-lang/rust.git
~/coding/rust
Σ rust > master λ git checkout try
Switched to branch 'try'
Your branch is up-to-date with 'origin/try'.
~/coding/rust
Σ rust > try λ echo "hi!"
hi!
~/coding/rust
Σ rust > try λ
```
The repository name is inferred from the URL of the remote `origin`.
#### Exit code
If the exit-code of the previous command is not null, displays `---- exit code $? -----` before the prompt, e.g.
```
~
λ basename
basename: missing operand
Try 'basename --help' for more information.
----- exit code: 1 -----
~
λ
```
### Git-Subcommands
Helpful subcommands are included in the `git-*.sh` files. See [docs/git-subcommands.md](docs/git-subcommands.md) for documentation.
* git ready
* git fuckit
* git qc
* git default-branch
* git update
* git squash
* git reword
### GLaDOS greeting
If you install `fortune` and `cowsay`, you can set up your terminal to greet you with an ASCII art
of GLadDOS and a quote of her:
```bash
sudo ln -s "$(pwd)/greeting/glados" /usr/share/games/fortunes/glados
sudo ln -s "$(pwd)/greeting/glados.dat" /usr/share/games/fortunes/glados.dat
sudo ln -s "$(pwd)/greeting/glados.cow" /usr/share/cowsay/cows/glados
echo "fortune -s glados | cowsay -f glados -W 80" >> ~/.bashrc
```
### Razer Keyboard Scripting
Openrazer is installed, together with a cronjob-ed script that updates the coloring: `razer/keyboard.py`.
### Date Format in the system panel
Installs a gnome extension to customize the panel date format. The format is such that it shifts
the date to the left so that its not obscured by a webcam mounted at the center of your monitor.
If a built-in display (= from laptop) is the primary display, that shifting is not applied.
The builtin-display-is-primary check is done periodically by a cronjob so that it adapts automatically
when you (dis)connect your laptop to/from a monitor.
## Adjusting
Here is where you can change things:
* Indicators in terminal title: `.bash_termtitle`; there are two lines:
`repositoryIndicator="Σ"`
`codingProjectIndicator="γ"`
* repository information indicator: `.bash_gitprompt` on the last line
* prompt chars: `.bashrc`, find these two lines:
`PERM_INDICATOR="λ"`
`PERM_INDICATOR="Ω"`
* coding project detection: to add support for a new build tool, add the file specific to that tool (e.g. `package.json` for NPM)
to this line in `.bash_termtitle`: `codingProjectDetectionFiles=(pom.xml Cargo.toml build.gradle composer.json)`
* Default branch detection in git subcommands: `git-default-branch.sh`
* Panel Date Format behaviour: `set-panel-date-format.sh`
* Razer keyboard colors: `razer/keyboard.py`