Atom Packages Directory

a package directory for a text editor of the 21st Century

Project Viewer

Install with:
    apm install project-viewer
  

README

Join the chat at https://gitter.im/jccguimaraes/atom-project-viewer All Contributors

atom version apm version apm downloads

Travis CI CI AppVeyor CI CircleCI CI

Beerpay paypal

Table Of Contents

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 :heart: and :sweat_drops:.

So here it is! Enjoy and contribute! :earth_africa:

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

Shortcuts

Settings

Settings Type Description Default
visibilityOption String Define what would be the default action for project-viewer visibility on startup. Display on startup
visibilityActive Boolean Relative to the interaction option selected above. true
panelPosition String Position the panel to the left or right of the main pane. Right
autoHide Boolean Panel has auto hide with hover behavior. false
hideHeader Boolean You can have more space for the list by hiding the header. false
keepContext Boolean When switching from items, if set to true, will keep current context. Also will not save contexts between switching. false
openNewWindow Boolean Always open items in a new window. false
statusBar Boolean Will show the breadcrumb to the current opened project in the status-bar. false
customWidth Integer Define a custom width for the panel.
double clicking on the resizer will reset the width
200
rootSortBy Array Sets the root sort by. position
onlyIcons Boolean Will show only the icons in the icon's list true
customPalette String Custom palette to use on editor #F1E4E8, #F7B05B, #595959, #CD5334, #EDB88B, #23282E, #263655, #F75468, #FF808F, #FFDB80, #292E1E, #248232, #2BA84A, #D8DAD3, #FCFFFC, #8EA604, #F5BB00, #EC9F05, #FF5722, #BF3100
customSelectedColor String Set custom selected project color ''
customHoverColor String Set custom hover project color ''
customTitleColor String Set custom main title color ''
disclaimer Object Show release notes on startup true

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! :speak_no_evil:

Group Schema

Parameter Type Description Default Required
type String The type of the model group true
name String The name of the project In theory… any strj g / emoji true
sortBy String Sorting of the nested groups and projects Possible options are position, reserve-position, alphabetically and reverse-alphabetically true
icon String Custom icon octicons or devicons '' false
color String Custom color '' false
expanded Boolean group is collapsed or expanded false true
list Array An array of models (group or project [] true

Project Schema

Parameter Type Description Default Required
type String The type of the model project true
name String The name of the project In theory… any strj g / emoji true
icon String Custom icon octicons or devicons '' false
color String Custom color '' false
devMode Boolean Not working for now false false
config Object Not working for now {} false
paths Array An array of the root files beloging to the project [] true

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

🐛 |

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! :beers: & :bear: for everyone.

Keywords: project, productivity, management, settings, workflow Suggest keywords
Fork me on GitHub