@sebastienrousseau/dotfiles 0.2.468 → 0.2.469

package/dist/lib/aliases/cd/README.md

@@ -1,65 +1,146 @@
 <!-- markdownlint-disable MD033 MD041 MD043 -->
-
 <img
   src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg"
-  alt="dotfiles logo"
-  width="261"
+  alt="Dotfiles logo"
+  width="66"
   align="right"
 />
-
 <!-- markdownlint-enable MD033 MD041 -->
 
-# Dotfiles (v0.2.468)
+# Dotfiles (v0.2.469)
 
-Designed to seamlessly enhance your shell environment 🐚
+Seamlessly enhance your shell environment 🐚
 
 ![Dotfiles banner][banner]
 
-## 🅲🅳 🅰🅻🅸🅰🆂🅴🆂
+---
+
+## 🚀 Introduction
+
+This repository includes a robust set of shell aliases and scripts designed to
+streamline your command-line experience. The `cd` aliases script simplifies
+filesystem navigation with:
+
+- **Dynamic error handling**
+- **Automatic directory listing**
+- **Customizable paths for frequent directories**
+
+---
+
+## 🛠️ Features
+
+### 🌟 Navigation Shortcuts
+
+| Alias           | Description                           |
+|------------------|--------------------------------------|
+| `-`             | Switch to the previous directory      |
+| `..`, `...`     | Ascend one or two levels in the tree  |
+| `....`, `.....` | Ascend three or four levels           |
+| `hom`           | Navigate to the home directory (`~`)  |
+
+---
+
+### 📂 Custom Directory Access
+
+Quickly access frequently used directories with predefined shortcuts. You can
+customize these paths to fit your needs:
+
+| Alias | Directory Path          | Description            |
+|-------|--------------------------|------------------------|
+| `app` | `${HOME}/Applications`  | Applications directory |
+| `cod` | `${HOME}/Code`          | Code directory         |
+| `des` | `${HOME}/Desktop`       | Desktop directory      |
+| `doc` | `${HOME}/Documents`     | Documents directory    |
+| `dot` | `${HOME}/.dotfiles`     | Dotfiles directory     |
+| `dow` | `${HOME}/Downloads`     | Downloads directory    |
+| `mus` | `${HOME}/Music`         | Music directory        |
+| `pic` | `${HOME}/Pictures`      | Pictures directory     |
+| `vid` | `${HOME}/Videos`        | Videos directory       |
+
+---
+
+### 🔧 System Directories
+
+Effortlessly navigate to critical system directories:
+
+| Alias | Directory Path | Description                    |
+|-------|----------------|--------------------------------|
+| `etc` | `/etc`         | System configuration directory |
+| `var` | `/var`         | Variable files directory       |
+| `tmp` | `/tmp`         | Temporary files directory      |
+
+---
+
+### ⚙️ Enhanced Customization
+
+- **Dynamic Directory Paths**: Customize aliases through environment variables
+- **Error Handling**: Provides clear messages for invalid directories
+- **Optional Directory Listing**: Automatically lists contents after navigation
+- **Tab Completion**: Supports custom tab completion for aliases
+
+---
+
+## 📦 Installation
+
+1. **Clone the repository**:
+
+```bash
+git clone https://github.com/sebastienrousseau/dotfiles.git
+```
+
+1. **Source the script in your shell configuration**:
+
+```bash
+echo 'source /path/to/dotfiles/cd.sh' >> ~/.bashrc
+```
+
+1. **Reload your shell**:
+
+```bash
+source ~/.bashrc
+```
+
+---
+
+## 🧑‍💻 Usage
+
+Here are some examples of how you can use the `cd` aliases:
 
-This set of `cd` command aliases provides an intuitive and efficient way to
-navigate your filesystem. Incorporating dynamic error handling, optional
-directory listing, and customization for an improved command-line experience.
+```bash
+# Navigate to the Code directory
+cod
 
-### Setup
+# Ascend two levels in the directory tree
+...
 
-To use these aliases, integrate the script into your `.bashrc` or `.bash_profile`.
+# Access the Documents directory
+doc
 
-### Navigation Shortcuts
+# Navigate to the system configuration directory
+etc
+```
 
-* `-`: Go to the previous directory.
-* `..`, `...`, `....`, `.....`: Ascend one to four levels in the directory tree.
-* `~`: Navigate to the home directory.
+---
 
-### Custom Directory Access
+## 📚 Documentation
 
-Leverage aliases for quick access to frequently visited directories:
+For advanced configuration and detailed usage examples, visit the
+[official documentation](https://dotfiles.io).
 
-* `app`: Applications directory
-* `cod`: Code directory
-* `des`: Desktop directory
-* `doc`: Documents directory
-* `dot`: Dotfiles directory
-* `dow`: Downloads directory
-* `mus`: Music directory
-* `pic`: Pictures directory
-* `vid`: Videos directory
+---
 
-### System Directories
+## 🛡️ License
 
-Quickly access system directories:
+This project is licensed under the
+[MIT License](https://opensource.org/licenses/MIT).
 
-* `etc`: System configuration (`/etc`)
-* `var`: Variable files (`/var`)
-* `tmp`: Temporary files (`/tmp`)
+---
 
-### Enhanced Customization
+## 👨‍💻 Author
 
-Customize directory paths through environment variables to suit your system's
-structure and preferences. Use concise aliases (`app`, `cod`, `des`, etc.) for
-efficient navigation.
+Created with ♥ by [Sebastien Rousseau](https://sebastienrousseau.com)
 
-For a detailed guide on configuring and using these aliases, plus additional
-information on each command, visit our [documentation](https://dotfiles.io).
+- Website: [https://sebastienrousseau.com](https://sebastienrousseau.com)
+- GitHub: [https://github.com/sebastienrousseau](https://github.com/sebastienrousseau)
 
 [banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg

package/dist/lib/aliases/cd/cd.aliases.sh

@@ -1,56 +1,15 @@
 #!/usr/bin/env bash
-
 ################################################################################
-# 🅳🅾🆃🅵🅸🅻🅴🆂
-# Author: Sebastien Rousseau
-# Copyright: 2015-2024. All rights reserved
-# Description: Enhanced `cd` command aliases with checks, functions, and customization.
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Change directory aliases
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
-# Script: cd.aliases.sh
-# Version: 0.2.468
-# Website: https://dotfiles.io
-
-# Usage:
-#   Customize directory paths via variables and use aliases to navigate.
-#   Example: `cod` to go to the Code directory, `..` to go up one directory.
-
-# Configuration
-DOC_DIR="${HOME}/Documents"
-VID_DIR="${HOME}/Videos"
-# Add more configurable paths here
-
-# Check if directory exists and change to it, listing contents optionally
-change_directory() {
-  local path="$1"
-
-  if [[ -d "${path}" ]]; then
-    cd "${path}" || exit # Exit if cd fails
-  else
-    echo "Directory '${path}' does not exist."
-  fi
-}
-
-# Parent Directory Shortcuts
-alias -- -='cd -'
-alias ..='cd ..'
-alias ...='cd ../..'
-alias ....='cd ../../..'
-alias .....='cd ../../../..'
-
-# Home Directory Shortcut
-alias hom='change_directory "${HOME}" true'
-
-# Frequently Used Directories
-alias doc='change_directory "$DOC_DIR" true' # Documents
-alias vid='change_directory "$VID_DIR" true' # Videos
-# Define more aliases like the above for other directories
-
-# System Directories (consider checks for system-specific paths)
-alias etc='change_directory "/etc" true'
-alias var='change_directory "/var" true'
-alias tmp='change_directory "/tmp" true'
+# This script provides aliases to quickly change directories.
+################################################################################
 
-# Frequently Used Directories with Improved Error Handling and Customization
+#-----------------------------------------------------------------------------
+# Frequently Used Directory Variables
+#-----------------------------------------------------------------------------
+HOME_DIR="${HOME}"
 APP_DIR="${HOME}/Applications"
 CODE_DIR="${HOME}/Code"
 DESK_DIR="${HOME}/Desktop"
@@ -61,13 +20,32 @@ MUSIC_DIR="${HOME}/Music"
 PICS_DIR="${HOME}/Pictures"
 VIDS_DIR="${HOME}/Videos"
 
-# Define functions for each alias with checks and optional ls
-alias app='change_directory "$APP_DIR" true' # Applications
-alias cod='change_directory "$CODE_DIR" true' # Code
-alias des='change_directory "$DESK_DIR" true' # Desktop
-alias doc='change_directory "$DOCS_DIR" true' # Documents
-alias dot='change_directory "$DOTF_DIR" true' # Dotfiles
-alias dow='change_directory "$DOWN_DIR" true' # Downloads
-alias mus='change_directory "$MUSIC_DIR" true' # Music
-alias pic='change_directory "$PICS_DIR" true' # Pictures
-alias vid='change_directory "$VIDS_DIR" true' # Videos
+#-----------------------------------------------------------------------------
+# Parent Directory Shortcuts
+#-----------------------------------------------------------------------------
+alias -- -='cd -'                            # Go to the previous directory
+alias ..='cd ..'                             # Go up one level
+alias ...='cd ../..'                         # Go up two levels
+alias ....='cd ../../..'                     # Go up three levels
+alias .....='cd ../../../..'                 # Go up four levels
+
+#-----------------------------------------------------------------------------
+# Home and Frequently Used Directories
+#-----------------------------------------------------------------------------
+alias app="cd ${APP_DIR} && ls -lh --group-directories-first"    # Applications
+alias cod="cd ${CODE_DIR} && ls -lh --group-directories-first"   # Code
+alias des="cd ${DESK_DIR} && ls -lh --group-directories-first"   # Desktop
+alias doc="cd ${DOCS_DIR} && ls -lh --group-directories-first"   # Documents
+alias dot="cd ${DOTF_DIR} && ls -lh --group-directories-first"   # Dotfiles
+alias dow="cd ${DOWN_DIR} && ls -lh --group-directories-first"   # Downloads
+alias hom="cd ${HOME_DIR} && ls -lh --group-directories-first"   # Home Directory
+alias mus="cd ${MUSIC_DIR} && ls -lh --group-directories-first"  # Music
+alias pic="cd ${PICS_DIR} && ls -lh --group-directories-first"   # Pictures
+alias vid="cd ${VIDS_DIR} && ls -lh --group-directories-first"   # Videos
+
+#-----------------------------------------------------------------------------
+# System Directories
+#-----------------------------------------------------------------------------
+[[ -d "/etc" ]] && alias etc="cd /etc && ls -lh --group-directories-first"   # System configuration
+[[ -d "/var" ]] && alias var="cd /var && ls -lh --group-directories-first"   # Variable data
+[[ -d "/tmp" ]] && alias tmp="cd /tmp && ls -lh --group-directories-first"   # Temporary files

package/dist/lib/aliases/chmod/README.md

@@ -1,109 +1,160 @@
 <!-- markdownlint-disable MD033 MD041 MD043 -->
-
 <img
   src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg"
-  alt="dotfiles logo"
-  width="261"
+  alt="Dotfiles logo"
+  width="66"
   align="right"
 />
-
 <!-- markdownlint-enable MD033 MD041 -->
 
-# Dotfiles (v0.2.468)
+# Dotfiles (v0.2.469)
 
 Simply designed to fit your shell life 🐚
 
 ![Dotfiles banner][banner]
 
-## 🅲🅷🅼🅾🅳 🅰🅻🅸🅰🆂🅴🆂
-
-These aliases provide shortcuts for the chmod command to help you
-quickly change the permissions of files and directories. To use them,
-add the following lines to your .bashrc or .bash_profile file.
-
-### Change permissions
-
-- `000`: (chmod a-rwx) sets permissions so that, (U)ser / owner can't
-  read, can't write and can't execute. (G)roup can't read, can't write
-  and can't execute. (O)thers can't read, can't write and can't execute.
-- `400`: (chmod a-rw) sets permissions so that, (U)ser / owner can't
-  read, can't write and can execute. (G)roup can't read, can't write and
-  can execute. (O)thers can't read, can't write and can execute.
-- `444`: (chmod a-r) sets permissions so that, (U)ser / owner can't
-  read, can't write and can execute. (G)roup can't read, can't write and
-  can execute. (O)thers can't read, can't write and can execute.
-- `600`: (chmod a+rwx,u-x,g-rwx,o-rwx) sets permissions so that, (U)ser
-  / owner can read, can write and can't execute. (G)roup can't read,
-  can't write and can't execute. (O)thers can't read, can't write and
-  can't execute.
-- `644`: (chmod a+rwx,u-x,g-wx,o-wx) sets permissions so that, (U)ser /
-  owner can read, can write and can't execute. (G)roup can read, can't
-  write and can't execute. (O)thers can read, can't write and can't
-  execute.
-- `666`: (chmod a+rwx,u-x,g-x,o-x) sets permissions so that, (U)ser /
-  owner can read, can write and can't execute. (G)roup can read, can
-  write and can't execute. (O)thers can read, can write and can't
-  execute.
-- `755`: (chmod a+rwx,g-w,o-w) sets permissions so that, (U)ser / owner
-  can read, can write and can execute. (G)roup can read, can't write
-  and can execute. (O)thers can read, can't write and can execute.
-- `764`: (chmod a+rwx,g-x,o-wx) sets permissions so that, (U)ser /
-  owner can read, can write and can execute. (G)roup can read, can write
-  and can't execute. (O)thers can read, can't write and can't execute.
-- `777`: (chmod a+rwx) sets permissions so that, (U)ser / owner can
-  read, can write and can execute. (G)roup can read, can write and can
-  execute. (O)thers can read, can write and can execute.
-
-### Change ownership
-
-- `chgrp`: Change group ownership of files or directories.
-- `chgrpr`: Change group ownership of files or directories recursively.
-- `chgrpu`: Change group ownership of files or directories recursively
-  to the current user.
-- `chmod`: Change file mode bits.
-- `chmodr`: Change file mode bits recursively.
-- `chmodu`: Change file mode bits recursively to the current user.
-- `chmox`: Make a file executable.
-- `chown`: Change file owner and group.
-- `chownr`: Change file owner and group recursively.
-- `chownu`: Change file owner and group recursively to the current user.
-
-### Set permissions for specific file types
-
-- `755d`: Set permissions of all directories to rwxr-xr-x.
-- `644f`: Set permissions of all files to rw-r--r--.
-
-### Set permissions for specific user types
-
-- `u+x`: Add execute permission for the owner of the file.
-- `u-x`: Remove execute permission for the owner of the file.
-- `u+w`: Add write permission for the owner of the file.
-- `u-w`: Remove write permission for the owner of the file.
-- `u+r`: Add read permission for the owner of the file.
-- `u-r`: Remove read permission for the owner of the file.
-- `g+x`: Add execute permission for the group owner of the file.
-- `g-x`: Remove execute permission for the group owner of the file.
-- `g+w`: Add write permission for the group owner of the file.
-- `g-w`: Remove write permission for the group owner of the file.
-- `g+r`: Add read permission for the group owner of the file.
-- `g-r`: Remove read permission for the group owner of the file.
-- `o+x`: Add execute permission for others.
-- `o-x`: Remove execute permission for others.
-- `o+w`: Add write permission for others.
-- `o-w`: Remove write permission for others.
-- `o+r`: Add read permission for others.
-- `o-r`: Remove read permission for others.
-
-### Set permissions based on octal notation
-
-- `000`: Set permissions to ----------
-- `400`: Set permissions to r--------
-- `444`: Set permissions to r--r--r--
-- `600`: Set permissions to rw-------
-- `644`: Set permissions to rw-r--r--.
-- `664`: Set permissions to rw-rw-r--.
-- `755`: Set permissions to rwxr-xr-x.
-- `775`: Set permissions to rwxrwxr-x.
-- `777`: Set permissions to rwxrwxrwx.
+---
+
+## 🚀 Introduction
+
+This script provides an enhanced set of shortcuts and functions for the
+`chmod` command, making it easier to manage file and directory permissions.
+With features like input validation, recursive confirmation, and user-friendly
+aliases, you can efficiently customize permissions for files and directories.
+
+---
+
+## 🛠️ Features
+
+### 🌟 Permission Aliases
+
+Quickly apply common permission settings with pre-defined aliases:
+
+| Alias        | Permissions      | Description                               |
+|--------------|------------------|-------------------------------------------|
+| `chmod_000`  | `----------`     | No permissions for anyone                 |
+| `chmod_400`  | `r--------`      | Read-only for the owner                   |
+| `chmod_444`  | `r--r--r--`      | Read-only for everyone                    |
+| `chmod_600`  | `rw-------`      | Read/write for the owner                  |
+| `chmod_644`  | `rw-r--r--`      | Read/write for the owner, read-only other |
+| `chmod_666`  | `rw-rw-rw-`      | Read/write for everyone                   |
+| `chmod_755`  | `rwxr-xr-x`      | Full owner, read/execute for others       |
+| `chmod_764`  | `rwxrw-r--`      | Full owner, read/write for the group,     |
+| `chmod_777`  | `rwxrwxrwx`      | Full permissions for everyone             |
+
+---
+
+### 🔧 Recursive Confirmation for Permissions
+
+The `change_permission` function allows you to recursively apply permissions
+with a confirmation prompt, displaying the number of items affected:
+
+```bash
+change_permission 755 /path/to/directory -R
+```
+
+---
+
+### 📂 User, Group, and Others Shortcuts
+
+Fine-tune permissions for specific user groups (owner, group, or others):
+
+| Alias         | Description                                |
+|---------------|--------------------------------------------|
+| `chmod_u+x`   | Add execute permission for the owner       |
+| `chmod_u-x`   | Remove execute permission for the owner    |
+| `chmod_u+w`   | Add write permission for the owner         |
+| `chmod_u-w`   | Remove write permission for the owner      |
+| `chmod_u+r`   | Add read permission for the owner          |
+| `chmod_u-r`   | Remove read permission for the owner       |
+| `chmod_g+x`   | Add execute permission for the group       |
+| `chmod_g-x`   | Remove execute permission for the group    |
+| `chmod_g+w`   | Add write permission for the group         |
+| `chmod_g-w`   | Remove write permission for the group      |
+| `chmod_g+r`   | Add read permission for the group          |
+| `chmod_g-r`   | Remove read permission for the group       |
+| `chmod_o+x`   | Add execute permission for others          |
+| `chmod_o-x`   | Remove execute permission for others       |
+| `chmod_o+w`   | Add write permission for others            |
+| `chmod_o-w`   | Remove write permission for others         |
+| `chmod_o+r`   | Add read permission for others             |
+| `chmod_o-r`   | Remove read permission for others          |
+
+---
+
+### 📄 Custom Aliases for File Types
+
+Set permissions for specific file types with ease:
+
+| Alias        | Description                                        |
+|--------------|----------------------------------------------------|
+| `chmod_755d` | Set permissions of all directories to `rwxr-xr-x`  |
+| `chmod_644f` | Set permissions of all files to `rw-r--r--`        |
+
+---
+
+## 📦 Installation
+
+1. Clone this repository:
+
+   ```bash
+   git clone https://github.com/sebastienrousseau/dotfiles.git
+   ```
+
+2. Source the script in your shell configuration file:
+
+   ```bash
+   echo 'source /path/to/dotfiles/chmod.sh' >> ~/.bashrc
+   ```
+
+3. Reload your shell:
+
+   ```bash
+   source ~/.bashrc
+   ```
+
+---
+
+## 🧑‍💻 Usage
+
+Here are some examples of how to use the `chmod` aliases and functions:
+
+- Apply common permissions:
+
+  ```bash
+  chmod_644 /path/to/file
+  chmod_755 /path/to/directory
+  ```
+
+- Modify user, group, or others' permissions:
+
+  ```bash
+  chmod_u+x /path/to/script
+  chmod_g-w /path/to/file
+  chmod_o+r /path/to/file
+  ```
+
+- Recursively set permissions with confirmation:
+
+  ```bash
+  change_permission 755 /path/to/directory -R
+  ```
+
+---
+
+## 🛡️ License
+
+This project is licensed under the
+[MIT License](https://opensource.org/licenses/MIT). See the `LICENSE` file for
+more information.
+
+---
+
+## 👨‍💻 Author
+
+Created with ♥ by [Sebastien Rousseau](https://sebastienrousseau.com)
+
+- Website: [https://sebastienrousseau.com](https://sebastienrousseau.com)
+- GitHub: [https://github.com/sebastienrousseau](https://github.com/sebastienrousseau)
 
 [banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg