Release Note: Folder Structure CLI Tool v1.1

Overview

We are pleased to announce the release of Folder Structure CLI Tool v1.1! This update introduces support for JSON format, allowing users to define folder structures using JSON files. This enhancement provides greater flexibility and ease of use for users who prefer JSON over YAML or TXT formats.

New Features

• JSON Format Support: Users can now define folder structures using JSON files. The tool will parse the JSON file and create the corresponding directory structure.
• Improved Error Handling: Enhanced error handling for structured TXT format and tree-based indentation method.

Usage

To use the Folder Structure CLI Tool with a JSON file, run the following command:

python cli.py <structure_file.json> <output_directory>

Example JSON File

Here is an example of a JSON file defining a folder structure:

[
{
    "name": "project-name",
    "type": "folder",
    "children": [
        {
            "name": "src",
            "type": "folder",
            "children": [
                {"name": "main.py", "type": "file"},
                {"name": "utils.py", "type": "file"},
            ]
        },
        {
            "name": "tests",
            "type": "folder",
            "children": [
                {"name": "test_main.py", "type": "file"},
            ]
        },
        {"name": ".github/workflows", "type": "folder"},
        {"name": ".gitignore", "type": "file"},
        {"name": "LICENSE", "type": "file"},
        {"name": "README.md", "type": "file"}
    ]
}

]

Contribution

I welcome contributions to improve the Folder Structure CLI Tool. Please fork the repository and submit pull requests for any enhancements or bug fixes.

Thank you for using the Folder Structure CLI Tool! I hope this new feature enhances your experience and makes your project setup process even more efficient and organized.

Folder Structure CLI Tool v1.0

Overview

This is the release of the Folder Structure CLI Tool v1.0! This tool is designed to help you create folder structures based on a given YAML or TXT file. It provides a variety of functionalities to streamline the process of setting up project directories and files.

Features

• Create Folder Structures: Generate folder and file structures from YAML or TXT configuration files.
• List Available Tags: Use the --list-tags option to display all available tags for the tool.
• Update Tool: Easily update the tool to the latest version using the --update or -u option.
• Version Information: Display the current version of the tool with the --version or -v option.

More Features to Come

• Version Information: Display the current version of the tool with the --version or -v option.
• Dry Run Mode: Simulate the creation of the folder structure without actually creating any files or directories using the --dry-run or -dr option.
• Verbose Output: Get detailed output of the operations being performed with the --verbose or -vb option.
• Configuration File: Specify a configuration file for additional settings using the --config option.
• Force Overwrite: Overwrite existing files and directories without prompting using the --force or -f option.

Usage

To use the Folder Structure CLI Tool, run the following command:

python cli.py <structure_file> <output_directory> [options]

Options

• structure_file: Path to the structure file (YAML or TXT).
• output_directory: Target directory for the structure.
• --list-tags: List all available tags.
• -u, --update: Update the tool to the latest version.
• -v, --version: Display the version of the tool.

Example

To create a folder structure from a YAML file and output it to a specified directory, use the following command:

folder-cli structure.yaml output_directory #using the yaml file
folder.cli structure.txt output_directory #using the text file

To update the tool to the latest version, use:

folder-cli --update

Installation

# Clone the repository and navigate to the project directory:
git clone <repository_url>
# Navigate to the scripts directory:
cd folder-structure-cli/scripts
# Make the Setup.sh file Executable:
chmod +x setup.sh
# Navigate to the root directory and run the script
cd ..
. scripts/setup.sh

Contribution

Any contributions to improve the Folder Structure CLI Tool is welcomed. Please fork the repository and submit pull requests for any enhancements or bug fixes.

Thank you for using the Folder Structure CLI Tool! I hope it makes your project setup process more efficient and organized.