README.md

j Project root

• Project root
  • Introduction - Stop wasting your time with cd ../
  • Installation
  • Usage

Introduction

Stop wasting your time with cd ../

• This enables you to return to the root directory of your project faster.
• It's meant for people who find it annoying to type cd ../ a lot of times :D
• If you are in ./src/api/routes you can simply use pr and you will automatically cd to the root of the project if its path was saved was pr add command.

.
├── dist
├── node_modules
├── package.json
├── src
│   ├── api
│   │   └── routes
│   │       └── getProduct.ts
│   └── utils
│       └── array.ts
└── tsconfig.json

6 directories, 4 files

Installation

1. Run mkdir ~/.proot
2. Run touch entryPoint.sh
3. Put this in the file entryPoint.sh

function pr {
    output=$(~/.proot/proot $@)
    retCode=$?
    if [[ ( $1 == "go" || $1 == "" || $1 == "back" || $1 == "b" || $1 == "to" || $1 == "t" ) && $retCode -eq 0 ]]; then
        # cd when go or back command. hide output
        cd $output
    else
        echo $output
    fi
    if [ $retCode -ne 0 ]; then
        return $retCode
    fi
    
}

1. Install the proot executable from here and put it in the directory ~/.proot
2. Add source ~/.proot/entryPoint.sh to your .bashrc or .zshrc. (This step is important)
3. Source your shell again or open a new terminal session.
4. Use pr --help

Usage

1. Use pr add [path] to save the current path as a project root.
2. Use pr or pr go from any child directory of your project and you will jump to the root of the project as long as you saved its path like in step 1.
3. Use pr list to list all saved project root paths.
4. Use pr purge to delete any paths that were saved before but don't exist in the file system any more.
5. Use pr clear to delete all saved paths. (use with CAUTION)
6. Use pr back go back to the last path from which you used the pr go command
   • let's say you are in /home/user/project/src/utils and you saved /home/user/project/ as a project root
   • Now you want to go back to the project root (to do something quickly) so you execute pr go or just pr
   • What if you want to go back to /home/user/project/src/utils again to continue you work ? the pr back command helps with such case
   • type pr back and it will cd to /home/user/project/src/utils automatically