ThePredators/zshconfig

zsh usage in a clever way

ZSH Config

⭐️ About

This project shows how to interact with zsh in a clever way, to organize your files and keep your mind and zsh usage clean

🔥 How to use ?

1. Clone this repository to /Users/$(whoami)/
2. Edit .zshrc (.zshrc should not contain anything but these lines)

## Zsh config 
alias reload="source /Users/$(whoami)/.zshrc"

## Check CPU type
CPU_TYPE=$(sysctl -n machdep.cpu.brand_string)
if [[ $CPU_TYPE == *"Apple"* ]]; then
    IS_M1_SHIP=true
else
    IS_M1_SHIP=false
fi

## Check OSX Version if greater than or equal to 11.0
IS_MACOS_GT_11=$(if ((`bc <<< "${$(sw_vers -productVersion | awk -F. '{print $1"."$2}')}>11.0"`)); then echo "true"; else echo "false"; fi)

## Source my custom zsh config
source /Users/$(whoami)/zshconfig/.zshc

3. ⚠️ Don't forget to give your script files execution rights. You can do that by simply running this script :

bash scripts/give-script-exec-rights.sh

🔆 How does this work ?

When you create your own config file / alias file / script file you will never need to import it to the .zshrc or .zshc its done automatically.

Now everytime you edit an alias/config/script just run :

reload

⭐️ Project Architecture

zshconfig
│   README.md
│   .zshc  # will contain only Root_PATHS and configs added dynamically
│
└───aliases # will contain all your aliases
│   │   *.sh
│   
└───config # will contain only config files
│   │   *.sh
│   │   zsh.sh # will contain the zsh config
└───m1 # will contain only config files for M1 Apple's
│   │   m1.sh
│   
└───scripts # will contain your scripts ready to be runned
    │   *.sh

⭐️ BackUp your configuration :

Don't foget to save your config on a private Git repository to easily find it or share it across your computers.

To do that follow this steps

1. Git Init in /Users/$(whoami)/

git init

2. Edit the .gitignore and keep only this

# Ignore everything
/*

# do not ignore these files...
!.gitignore
!.zshrc
!.zshenv
!.zprofile

## if you want to backup the zsh command you used 
!.zsh_history

## Backup zshconfig
!/zshconfig

3. Add all, set your private repos and push

You're good to go !

⭐️ Questions :

Why using .sh files in config/aliases folders ? I use ".sh" extension to have great sythaxe format on most of text editors, but you can remove ".sh" extension if you want.

Enjoy :)