feat(pj)!: add new subcommands and autocomplete support

BREAKING CHANGE: The `pj` command has been rewritten with new subcommands.
Existing usage might no longer work. Use `pj add`, `pj mv`, `pj rm`, `pj ls`,
and `pj open -e` instead.

Co-authored-by: ibrahimcetin <mail@ibrahimcetin.dev>

plugins/pj/README.md

@@ -1,11 +1,6 @@
-# pj
+# pj plugin
 
-The `pj` plugin (short for `Project Jump`) allows you to define several
-folders where you store your projects, so that you can jump there directly
-by just using the name of the project directory.
-
-Original idea and code by Jan De Poorter ([@DefV](https://github.com/DefV))
-Source: https://gist.github.com/pjaspers/368394#gistcomment-1016
+The `pj` plugin (short for `Project Jump`) allows you to define a list of directories where your projects are located. You can quickly jump to a project directory using `pj project-name` or open it in your preferred editor with `pj open project-name`.
 
 ## Usage
 
@@ -15,31 +10,108 @@ Source: https://gist.github.com/pjaspers/368394#gistcomment-1016
    plugins=(... pj)
    ```
 
-2. Set `$PROJECT_PATHS` in your ~/.zshrc:
+2. Add project to the registry:
 
    ```zsh
-   PROJECT_PATHS=(~/src ~/work ~/"dir with spaces")
+   $ pj add
    ```
 
-You can now use one of the following commands:
+> This will add the current directory to the registry, using the directory name as the project name.
 
-##### `pj my-project`:
+3. Jump to project directory:
 
-`cd` to the directory named "my-project" found in one of the `$PROJECT_PATHS`
-directories. If there are several directories named the same, the first one
-to appear in `$PROJECT_PATHS` has preference.
+   ```zsh
+   $ pj project-name
+   ```
+> `pj` has auto-complete support for project names.
+
+4. Open the project in your defined `$EDITOR`:
+
+   ```zsh
+   $ pjo project-name
+   ```
+> Opens the project in your default $EDITOR. You can override the editor using `-e`.
+
+## Commands
+
+#### `pj <project-name>`
+
+`cd` to the project directory with the given name. Note: you can use auto-complete for project names.
 
 For example:
 ```zsh
-PROJECT_PATHS=(~/code ~/work)
-$ ls ~/code    # ~/code/blog ~/code/react
-$ ls ~/work    # ~/work/blog ~/work/project
-$ pj blog      # <-- will cd to ~/code/blog
+$ pj my-project
 ```
 
-##### `pjo my-project`
+#### `pj add [path] [name]`
 
-Open the project directory with your defined `$EDITOR`. This follows the same
-directory rules as the `pj` command above.
+Add a project to the registry.
+Note: `pja` is an alias of `pj add`.
 
+For example:
+```zsh
+$ pja
+$ # Add the current directory with the name "my-project"
+$ pja . my-project
+$ # Add the specified directory to the registry with the name "my-project"
+$ pja /path/to/project my-project
+```
+
+##### `pj open <project-name>`
+
+Open the project with your defined `$EDITOR` or specify an editor with the `-e` flag.
 Note: `pjo` is an alias of `pj open`.
+
+For example:
+```zsh
+$ pjo my-project
+$ # open the project path named "my-project" with VSCode
+$ pjo -e code my-project
+$ # open multiple projects
+$ pjo my-project another-project
+```
+
+##### `pj ls [pattern]`
+
+List all the projects in the registry.
+Note: `pjl` is an alias of `pj ls`.
+
+For example:
+```zsh
+$ pj ls
+$ # list all the projects in the registry that match the pattern 'web-*'
+$ pjl 'web-*'
+```
+
+##### `pj rm <project-name>`
+
+Remove a project from the registry.
+
+For example:
+```zsh
+$ pj rm my-project
+$ # remove multiple projects from the registry
+$ pj rm my-project another-project
+```
+
+#### `pj mv <old-name> <new-name>`
+
+Rename a project in the registry.
+
+For example:
+```zsh
+$ pj mv old-name new-name
+```
+
+## Aliases
+| Alias | Command |
+|-------|---------|
+| `pja` | `pj add` |
+| `pjo` | `pj open` |
+| `pjl` | `pj ls` |
+
+## Contributors
+Code by [@ibrahimcetin](https://github.com/ibrahimcetin)
+
+Original idea and code by Jan De Poorter ([@DefV](https://github.com/DefV))
+Source: https://gist.github.com/pjaspers/368394#gistcomment-1016