Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dennykorsukewitz/sublime-addfoldertoproject

This package streamlines the process of adding and removing folders to and from your projects. It provides a set of commands and context menu options to manage your project's folder structure directly from the editor.
https://github.com/dennykorsukewitz/sublime-addfoldertoproject

extension folder helper metrics-sublime package pages project sublime workflow

Last synced: about 1 month ago
JSON representation

This package streamlines the process of adding and removing folders to and from your projects. It provides a set of commands and context menu options to manage your project's folder structure directly from the editor.

Awesome Lists containing this project

README

        

# AddFolderToProject

**AddFolderToProject** is a Sublime Text package that streamlines the process of adding and removing folders to and from your projects. It provides a set of commands and context menu options to manage your project's folder structure directly from the editor.

Of course, you can use the already built-in function (Project -> Add Folder to Project...).
But then you have to click through all the folders again and again.

---

## Note

![Takeover (date)](https://img.shields.io/badge/takeover-07/08/2024-blue)
![Takeover (downloads)](https://img.shields.io/badge/downloads-17733-green)

This package is a `rewrite` of the existing package `AddFolderToProject` by `David Gerva` [AddFolderToProject-SublimePlugin](https://github.com/DavidGerva/AddFolderToProject-SublimePlugin).

Further information can be found here: [Rewrite](#rewrite)

---

| Repository | GitHub | Sublime / Package Control |
| ------ | ------ | ------ |
| ![GitHub release (latest by date)](https://img.shields.io/github/v/release/dennykorsukewitz/Sublime-AddFolderToProject) | ![GitHub open issues](https://img.shields.io/github/issues/dennykorsukewitz/Sublime-AddFolderToProject) ![GitHub closed issues](https://img.shields.io/github/issues-closed/dennykorsukewitz/Sublime-AddFolderToProject?color=#44CC44) | ![Package Control](https://img.shields.io/packagecontrol/dt/Add%20Folder%20To%20Project) |
| ![GitHub license](https://img.shields.io/github/license/dennykorsukewitz/Sublime-AddFolderToProject) | ![GitHub pull requests](https://img.shields.io/github/issues-pr/dennykorsukewitz/Sublime-AddFolderToProject?label=PR) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/dennykorsukewitz/Sublime-AddFolderToProject?color=g&label=PR) | ![Package Control](https://img.shields.io/packagecontrol/dm/Add%20Folder%20To%20Project) |
| ![GitHub language count](https://img.shields.io/github/languages/count/dennykorsukewitz/Sublime-AddFolderToProject?style=flat&label=language) | ![GitHub contributors](https://img.shields.io/github/contributors/dennykorsukewitz/Sublime-AddFolderToProject) | ![Package Control](https://img.shields.io/packagecontrol/dw/Add%20Folder%20To%20Project) |
| ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/dennykorsukewitz/Sublime-AddFolderToProject) | ![GitHub downloads](https://img.shields.io/github/downloads/dennykorsukewitz/Sublime-AddFolderToProject/total?style=flat) | ![Package Control](https://img.shields.io/packagecontrol/dd/Add%20Folder%20To%20Project) |

| Status |
| ------ |
| [![GitHub commits since tagged version](https://img.shields.io/github/commits-since/dennykorsukewitz/Sublime-AddFolderToProject/2.0.0/dev)](https://github.com/dennykorsukewitz/Sublime-AddFolderToProject/compare/2.0.0...dev) ![GitHub Workflow Lint](https://github.com/dennykorsukewitz/Sublime-AddFolderToProject/actions/workflows/lint.yml/badge.svg?branch=dev&style=flat&label=Lint) ![GitHub Workflow Pages](https://github.com/dennykorsukewitz/Sublime-AddFolderToProject/actions/workflows/pages.yml/badge.svg?branch=dev&style=flat&label=GitHub%20Pages) |

## Feature

- [Add Folder to Project](#add-folder-to-project)
- [Remove Folder from Project](#remove-folder-from-project)
- [Add Custom Folder to Project](#add-custom-folder-to-project)
- [Add this Folder to Project](#add-this-folder-to-project)
- [Remove this Folder from Project](#remove-this-folder-from-project)
- [Create Project from File](#create-project-from-file)
- [Copy File Path](#copy-file-path)
- [Copy Dir Path](#copy-dir-path)

### Add Folder to Project

This function provides a searchable list of folders that can be added to the current project.

The list consists of absolute paths (see [Settings](#settings)) `add_folder_to_project_folders` and recursive paths `add_folder_to_project_recursive_folders`.

**Command:** ```AddFolderToProject: Add Folder to Project```

![AddFolderToProject](doc/images/AddFolderToProject.gif)

### Remove Folder from Project

This function provides a list of active folders in the project, that can be removed from the current project.

**Command:** ```AddFolderToProject: Remove Folder from Project```

![RemoveFolderFromProject](doc/images/RemoveFolderFromProject.gif)

### Add Custom Folder to Project

This function allows you to add a custom folder to the project (absolute path).

**Command:** ```AddFolderToProject: Add Custom Folder to Project```

![AddCustomFolderToProject](doc/images/AddCustomFolderToProject.gif)

### Add this Folder to Project

This function adds the folder of the current open file to the project.

**Command:** ```AddFolderToProject: Add this Folder to Project```

![AddThisFolderToProject](doc/images/AddThisFolderToProject.gif)

### Remove this Folder from Project

This function removes the folder of the current open file from the project.

**Command:** ```AddFolderToProject: Remove this Folder from Project```

![RemoveThisFolderFromProject](doc/images/RemoveThisFolderFromProject.gif)

### Create Project from File

This function creates a new project (new sublime window) with the folder of the current open file.

**Command:** ```AddFolderToProject: Create Project from File```

![CreateProjectFromFile](doc/images/CreateProjectFromFile.gif)

### Copy File Path

Copies the file path of the current open file.

**Command:** ```AddFolderToProject: Copy File Path```

![CopyFilePath](doc/images/CopyFilePath.gif)

### Copy Dir Path

Copies the dir path of the current open file.

**Command:** ```AddFolderToProject: Copy Dir Path```

![CopyDirPath](doc/images/CopyDirPath.gif)

### General

#### Save Folder In Settings

Each time a folder is added, the code checks whether it already exists in the configuration (`add_folder_to_project_folders`).
If not, it asks whether this path should be saved.

---

## Menus

These functions are accessible through the context menu and the sidebar menu, making it easy to manage your project's folders without leaving your editor.

### Context Menu

The following functions are available in the Context menu:

- [Add Folder to Project](#add-folder-to-project)
- [Remove Folder from Project](#remove-folder-from-project)
- [Add this Folder to Project](#add-this-folder-to-project)
- [Remove this Folder from Project](#remove-this-folder-from-project)
- [Create Project from File](#create-project-from-file)
- [Copy File Path](#copy-file-path)
- [Copy Dir Path](#copy-dir-path)

![Context-Menu](doc/images/Context-Menu.png)

![Context-Menu](doc/images/Context-Menu.gif)

### Sidebar Menu

The following functions are available in the Sidebar menu:

- [Add Folder to Project](#add-folder-to-project)
- [Remove Folder from Project](#remove-folder-from-project)
- [Add this Folder to Project](#add-this-folder-to-project)
- [Remove this Folder from Project](#remove-this-folder-from-project)
- [Create Project from File](#create-project-from-file)
- [Copy File Path](#copy-file-path)
- [Copy Dir Path](#copy-dir-path)

![Sidebar-Menu](doc/images/Sidebar-Menu.png)

![Sidebar-Menu](doc/images/Sidebar-Menu.gif)

## Settings

`Settings -> Package Settings -> AddFolderToProject -> Settings`

| Name | Description | Default Value |
| - | - | - |
| add_folder_to_project_folders | Provides a searchable list of folders that can be added to the current project. | `/Users/dennykorsukewitz/` |
| add_folder_to_project_recursive_folders | Provides a searchable (only first level) list of folders (recursive) that can be added to the current project. For example: "/Users/" - adds "/Users/dennykorsukewitz/" to list. | `` |

---

## Installation

To install this package, you have **three** options:

### 1. Search Package via `Package Control`

Search and install online package via [Sublime Package Control](http://wbond.net/sublime_packages/package_control).

`Tools` -> `Command Palette` -> `Package Control: Install Package` -> simply search for `AddFolderToProject` to install.

### 2. Install via sublime-package file

Download latest [sublime-package file](https://github.com/dennykorsukewitz/Sublime-AddFolderToProject/releases) and move the package `AddFolderToProject.sublime-package` to `Installed Packages` folder.

#### OSX

cd ~/Library/Application\ Support/Sublime\ Text\ 2/Installed Packages/
- or ST 3 -
cd ~/Library/Application\ Support/Sublime\ Text\ 3/Installed Packages/

#### Linux

cd ~/.config/sublime-text-2/Installed Packages
- or ST 3 -
cd ~/.config/sublime-text-3/Installed Packages

#### Windows

cd "%APPDATA%\Sublime Text 2\Installed Packages"
- or ST 3 -
cd "%APPDATA%\Sublime Text 3\Installed Packages"

### 3. Source code

Clone the latest [dev branch](https://github.com/dennykorsukewitz/Sublime-AddFolderToWorkspace) and unpack it to Sublime Package folder `Packages`.

#### OSX

cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
- or ST 3 -
cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/
git clone [email protected]:dennykorsukewitz/Sublime-AddFolderToWorkspace.git AddFolderToProject

#### Linux

cd ~/.config/sublime-text-2/Packages
- or ST 3 -
cd ~/.config/sublime-text-3/Packages
git clone [email protected]:dennykorsukewitz/Sublime-AddFolderToWorkspace.git AddFolderToProject

#### Windows

cd "%APPDATA%\Sublime Text 2\Packages"
- or ST 3 -
cd "%APPDATA%\Sublime Text 3\Packages"
git clone [email protected]:dennykorsukewitz/Sublime-AddFolderToWorkspace.git AddFolderToProject

---

## Download

For download see [Sublime-AddFolderToProject](https://github.com/dennykorsukewitz/Sublime-AddFolderToProject/releases)

---

## Rewrite

The rewrite was made for the following reasons:

- [AddFolderToProject-SublimePlugin](https://github.com/DavidGerva/AddFolderToProject-SublimePlugin) has not been maintained since 09/02/2015.
- Issues and PullRequest were not further processed. Now all known issues are fixed.
- New functions and the old functions from David Gerva have been compiled and revised.

With David's permission, we have now [changed the source](https://github.com/wbond/package_control_channel/pull/8904) of the package to this repository so that we can continue to offer the functionality to users of this package.

`Many thanks to David Gerva for his wonderful work! ❤️ Open Source ❤️`

---

Enjoy!

Your [Denny Korsukéwitz](https://github.com/dennykorsukewitz) 🚀