granmoe / folder-friend

Folder Friend  📁 😃

Folder Friend is a CLI tool that analyzes the import relationships and folder structure of a given directory and calculates the necessary file/folder moves and renames needed to align your folder structure with Loom's folder structure guidelines (todo: link). You can then optionally have the CLI carry out these file operations for you.

👶 NOTE THAT FOLDER FRIEND IS CURRENTLY IN ITS INFANCY AND MAY SPIT-UP OR POOP ON YOU - USE AT YOUR OWN RISK!

Installation

For now (until we publish this to npm):

1. Clone this repo
2. Install dependencies
3. Run pnpm build
4. Run pnpm link from the project root

(At this point, you can run which folder-friend to confirm that the binary is available globally.)

You can now run npx folder-friend or just folder-friend from anywhere on your system!

Usage

npx folder-friend [--target_dir <path>] [--yolo <boolean>]

• --target_dir (optional): The directory to operate on. Defaults to the current working directory.
• --yolo (optional): If false, the CLI will only print the file operations it would perform without actually performing them. You will then have the option to confirm or cancel the file operations. If true, the changes will be made immediately. Defaults to false.

Help

To see a full overview of the CLI, run:

npx folder-friend --help