Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/skuroda/PackageResourceViewer

Sublime Text plugin to view package resources.
https://github.com/skuroda/PackageResourceViewer

Last synced: 6 days ago
JSON representation

Sublime Text plugin to view package resources.

Awesome Lists containing this project

README 

        
# PackageResourceViewer

Plugin to assist viewing and editing package resources in Sublime Text 2 and Sublime Text 3.



## Installation

Note with either method, you may need to restart Sublime Text for the plugin to load properly.



### Package Control

Installation through [package control](http://wbond.net/sublime_packages/package_control) is recommended. It will handle updating your packages as they become available. To install, do the following.



* In the Command Palette, enter `Package Control: Install Package`

* Search for `PackageResourceViewer`



### Manual

Clone or copy this repository into the packages directory. Ensure it is placed in a folder named `PackageResourceViewer`. By default, the Packages directories for Sublime Text 2 are located at:



* OS X: ~/Library/Application Support/Sublime Text 2/Packages/

* Windows: %APPDATA%/Roaming/Sublime Text 2/Packages/

* Linux: ~/.config/sublime-text-2/Packages/



By default, the Packages directories for Sublime Text 3 are located at:



* OS X: ~/Library/Application Support/Sublime Text 3/Packages/

* Windows: %APPDATA%/Roaming/Sublime Text 3/Packages/

* Linux: ~/.config/sublime-text-3/Packages/



## Usage



### Commands

`PackageResourceViewer: Open Resource`:



Command to open the resource. If saved, the correct directory structure will be created in the `Packages` folder. This command will only be displayed if the `single_command` setting is true.



`PackageResourceViewer: Extract Package`:



Command to extract a package to the `Packages` directory. This command is only available in ST3.



`PackageResourceViewer: View Package Resource`:



Open package resource as read only. This command will only be displayed if the `single_command` setting is false.



`PackageResourceViewer: Edit Package Resource`:



Open package resources as an editable file. Upon execution, this plugin will create a directory (if necessary) as well as save the resource. This command will only be displayed if the `single_command` setting is false.



## Settings

`ignore_patterns`:



A list of regular expressions patterns to ignore. Note that these regular expressions are compared against the file or directory name.



`open_multiple`:



Boolean to keep selection panel open after selecting a resource to open.



`single_command`:



Boolean setting specifying if a single command should be listed in the command palette for viewing and editing files or if multiple commands should be used.



`return_to_previous`:



True if, when moving up a directory, you would like the previous selection to be automatically chosen. False otherwise.



# License



The MIT License (MIT)



Copyright (c) 2013 Scott Kuroda



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and

associated documentation files (the "Software"), to deal in the Software without restriction,

including without limitation the rights to use, copy, modify, merge, publish, distribute,

sublicense, and/or sell copies of the Software, and to permit persons to whom the Software

is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or

substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING

BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

sOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.