Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/malolm/file-names-normalizer
A bash script for normalized renaming of Linux/MacOS directories
https://github.com/malolm/file-names-normalizer
bash-script
Last synced: 27 days ago
JSON representation
A bash script for normalized renaming of Linux/MacOS directories
- Host: GitHub
- URL: https://github.com/malolm/file-names-normalizer
- Owner: MaloLM
- License: apache-2.0
- Created: 2023-12-30T20:21:00.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-01T16:49:03.000Z (about 1 year ago)
- Last Synced: 2024-12-12T08:43:18.825Z (28 days ago)
- Topics: bash-script
- Language: Shell
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# file-names-normalizer
## Overview
This project contains a Bash script (`/scripts/parser.sh`) designed for renaming files and directory names in a given directory, in a standardized way, that you can configure.
It works across different operating systems (macOS and Linux) and modifies file and directory names by performing enabled rules inside the script.
## Features
- Choose normalization rules (inside `parser()` function of /scripts/parser.sh script)
- Same normalization rules will be applied to both directories and files
- Consider applying formatting rules in a consistent order
- Configure directories (`directories_to_ignore`) and file extensions (`extensions_to_ignore`) to ignore, inside the script
## Demonstration
An example directory with inconsistent naming conventions before script execution:
```
project_directory/
│
├── My_File.txt
├── anotherFile.PNG
├── some report.docx
├── Image 01.JPG
├── CODE_snippet.py
│
└── sub_directory/
├── Data Set.csv
├── presentation PPT.pptx
└── README.MD
```
After script execution (assuming base rules configuration):
```
project_directory/
│
├── my_file.txt
├── anotherfile.png
├── some_report.docx
├── image_01.jpg
├── code_snippet.py
│
└── sub_directory/
├── data_set.csv
├── presentation_ppt.pptx
└── readme.md
```
## Usage
To quickly start using the `parser.sh` script, simply navigate to the directory where the script is located and run it in your terminal:
```bash
chmod +x parser.sh
```
Then
```bash
./parser.sh
```
This basic command executes the script in your current working directory. It will process and rename files according to the predefined rules set within the script, making the file names consistent.
Not passing any parameters to the script will execute it in the current directory (.). It is possible to provide an absolute or relative path as the first parameter of the script.
Here's an example:
```bash
# Executing the script in the current directory
./parser.sh
# Executing the script in a specific directory using a relative path
./parser.sh ./path/to/directory
# Executing the script in a specific directory using an absolute path
./parser.sh /absolute/path/to/directory
```
For more advanced setup options, detailed installation instructions, please refer to the [Getting Started Guide](./GETTING_STARTED.md). This guide provides comprehensive step-by-step instructions for both Linux and macOS environments, ensuring a thorough and adaptable setup process.
Base configuration inside the parser.sh script applies following configuration:
- changes filename to lowercase
- replaces spaces by underscores
- deletes suffix and prefix spaces
You can edit rules to your own by commenting/uncommenting/adding rules inside the `parser()` function inside the `parser.sh` script.
## Test
For detailed testing instructions and information, please refer to the [TESTING.md document](./TESTING.md).
## License
This script is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details.
## Support
For support, please contact the project contributors.
## Contributors
- [Baptiste Ledoyen](https://github.com/HoloZoR)
- [Malo Le Mestre](https://github.com/MaloLM)
## Disclaimer
### Caution When Using in High-Level Directories
**Important**: Exercise extreme caution when running `parser.sh` in high-level directories, especially those containing system or critical files. This script recursively processes and renames files within the directory it's executed in, as well as its subdirectories. Renaming system or essential files can lead to unstable behavior, system malfunctions, or even a non-bootable state of your operating system.
It's highly recommended to use this script in controlled environments, such as specific folders containing non-critical data. Always ensure you have a clear understanding of the script's effects and have verified its behavior in a safe, isolated directory before using it in any location with significant data.
### Limitation of Liability
The contributors of `parser.sh` bear no responsibility for any damage, data loss, or system instability that may arise from the use of this script. While effort has been made to ensure the script's reliability, its functioning depends on the specific environment and use case.
As a user, you assume full responsibility for the execution and consequences of this script. It's recommended to perform regular backups of your data and thoroughly test the script in a non-critical environment to understand its behavior and impact before any extensive use.
Use of `parser.sh` indicates your understanding of these risks and your agreement that the contributors are not liable for any adverse outcomes from its use.