README

Table Of Contents

• Introduction


• Installation


• Features


• Shortcuts


• Settings


• Local File manipulation
  
  
  
  • Group Schema
  
  
  • Project Schema
  
  


• Contributors


• Contacts


• A Special Thank You!

Introduction

This is a package built for and by the Atom community. For contribution read below.

This package has grown so much over the last year that I felt the need to make it more stable and community friendly. And this required a more deep refactor with lots of new ideas and improvements, also huge amount of
❤️
and
💦
.

So here it is! Enjoy and contribute!
🌍

Please keep in mind that after Atom 1.17.0 some functionalities changed, and implementations of this package are still being tested for stability.

Installation

In a terminal / command line write the following line apm install project-viewer.

Or just find the package by accessing the menu Atom → Preferences... → Install and search for project-viewer.

Features

• Group nesting;
  
  
  
  • 
    

    
    

    Infinite nesting of groups which can contain also projects;

    
    

  
  
  • 
    

    
    

    projects can be at any level.

    
    

  
  


• Sidebar Left / Right (first or last) position;


• Auto hide sidebar with hover behavior;


• Resizable panel;
  
  
  
  • 
    

    
    

    Double click to default width;

    
    

  
  


• Hide header for more space;
  
  
  
  • 
    

    
    

    This is available through a config option, default is not autohide.

    
    

  
  


• Focus toggle;
  
  
  
  • 
    

    
    

    Toggling focus will switch between current active element and the panel.

    
    

  
  


• SelectListView integration;
  
  
  
  • 
    

    
    

    Only shows projects.

    
    

  
  


• Traverse and select projects with up and down keys;


• Toggle collapse / expand of groups with left and right keys;


• status-bar with the project's' breadcrumb path;


• Drag & Drop groups and projects;
  
  
  
  • Drag and drop a group or project into a group will add it as a child;
  
  
  • Drag and drop a group or project into an project will add it as sibling of the dropped item;
  
  
  • Drag and drop a group or project into a clear space in the panel will add it as a root child;
  
  
  • Order dragged group / project accordingly with dropped group sorting.
  
  


• Open the local database file for direct editing;


• Old database schemas conversion tools;


• Backup services (GitHub's private gist);


• Editor for groups / projects creation and update;
  
  
  
  • Create, update and remove group or project;
  
  
  • Automatic set it's name according to first path base name added;
  
  
  • Batch operation on a project creation;
    
    
    
    • 
      

      
      

      Ability to create individual projects when more than one path is provided;

      
      

    
    
    • 
      

      
      

      Each project will automatically have it's name set to it's path base name.

      
      

    
    
  
  
  • Filtering icons;
  
  
  • List of icons in editor as only icons or icon and description;
    
    
    
    • 
      

      
      

      This is available through a config option, default is icon and description.

      
      

    
    
  
  
  • Sort children groups / projects.
    
    
    
    • 
      

      
      

      Sorting root groups / projects is done through a config option.

      
      

    
    
  
  


• Context menu for delete, update and create new group or project;
  
  
  
  • 
    

    
    

    Create option is only available in groups or the root.

    
    

  
  


• Show the given path in a file manager. (in finder or explorer's alike');


• Empty groups and / or projects list message;


• Custom colors for groups and projects;


• Custom colors for main title, for hovering on a project and for selected project;


• Option to open a project in a new window or vice versa;
  
  
  
  • 
    

    
    

    This is available through a config option which will switch between what is the primary option, defaults to open in same window;

    
    

  
  
  • 
    

    
    

    Context menu switching also available.

    
    

  
  


• Elevate current opened folders in tree-view to a project;


• Add Project Folder and Remove Project Folder will update current selected project as well;


• Keep context when switching from projects.
  
  
  
  • 
    

    
    

    This is available through a config option, default is switch contexts.

    
    

  
  

Shortcuts

• shift-ctrl-alt-c toggles sidebar autohide;


• shift-ctrl-alt-v toggles sidebar visibility;


• shift-ctrl-alt-n open the editor tab;


• shift-ctrl-alt-m toggle focus from active panel and the sidebar;


• shift-ctrl-alt-l toggle the select list modal;

Settings

Keep in mind that this package uses Atom's Storage to save all groups and projects. It is wise to save it to the cloud (ex: you can import and export a private Gist through this package!).

Local File manipulation

Change it at your own risk!
🙊

Group Schema

Project Schema

Contributors

Thanks goes to these wonderful people (emoji key):

João Guimarães 💬 🐛 💻 🎨 📖 👀	Hans Koch 💻	Holland Wilson 💻	Roman Huba 💻	Loann Neveu 💻 🐛	Kristian Barrese 🎨 🐛	Nicole 🐛
Damon Cook 🐛	Zach Hudock 🐛	Filip Paço 🐛	Stephen Last 🐛	Jonathan 🐛	◬ 🐛	Erik G. 💻
netizen 💻	Markus M. Deuerlein 🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

If you feel you were left out, just shout!

Contacts

You can follow me on Twitter

A Special Thank You!

I thank you all for giving such great feedback!
🍻
&
🐻
for everyone.