snippet-injector v1.5.4
Atom Snippet Injector
An easy but powerful snippet management tool for Atom editor.
This atom package provides a JSON based, local snippet management, automated synchronization to Atom's integrated snippet-module and database support for improved teamwork with consistent snippet access. It's easy and fast so you don't have to struggle with difficult UI's or file syntaxes or even worse, define the snippets manually.
Introduction
Snippet Injector basically provides four functions for snippet management. Create, Insert, Update and Delete. They all do exactly what they are called, depending on your configuration, with some extra magic.
All commands are available through the main application menu below Packages > Snippet Injector.
The context menu provides the Delete command in the whole workspace while creation, insertion and updating is only available within a TextEditor instance.
Creation
To create a snippet, just mark all the text that shall be stored as snippet and run the snippet-injector:create command through command palette, context or main menu or hotkey. You will be prompted for a title for the snippet.
Within this input field you may use some additional markers:
- All words starting with a hash (
#foo) are treated as keywords and taken out of the actual title. - A part of the title, wrapped in square brackets, defines the prefix that triggers the snippet in autocompletion. Only the brackets will be removed from the actual title.
Insertion
To insert a snippet, just place the cursor where you want it to appear and run the snippet-injector:insert command the way you prefer. You will be prompted to choose a snippet for insertion, also allowing you to search the list. In the search field you may use the following syntax:
- Plain text searches the title of the snippets
- A word starting with a hash (
#foo) searches for keywords - A word starting with an at-sign (
@bar) searches for author
The options can be combined together. Snippets are filtered by full-text-search, meaning the order of the search keywords needs to be the same as in the title otherwise the Snippets won't match your search. (This will be improved soon.)
Updating
To update a snippets content, just mark all the text that shall be used as new content and run the snippet-injector:update command the way you prefer. You will be prompted to choose a snippet that shall be updated. This list is also searchable with the above mentioned options.
Deletion
To delete a snippet, just run the snippet-injector:delete command the way you prefer. You will be prompted to choose a Snippet in a dropdown list. Before actually deleting a snippet you will be prompted a second time if you are sure.
Features
Stats
While using Snippet Injector it may occur that you collect a whole bunch of snippets. To keep the insertion prompt handy even with a lot of data, there are stats recorded for each snippet. Especially the usage count takes effect as it defines the order in which the snippets are listed so you got the mostly used ones at the top of the list and can access them faster.
Import / Export
Through the main application menu below Packages > Snippet Injector you can access the import and export functionality.
The Export Storage option is intended to create backups of you local storage or if you want to migrate it to a new system.
The Export Snippet(s) option allows you to specify several snippets that you want to export. This was intended to share snippets with others without a database connection.
The Import Snippet(s) option obviously imports snippets from an export back in the storage.
Atom-Sync
You can enable synchronization with Atom's snippet module in the package config.
When activated, all of your snippets will be synchronized with the snippets.cson file. Within this file you can define snippets for fast insertion in Atom. This feature is provided by the core-package snippets.
Writing a CSON file manually is laborious but Snippet Injector automatically generates the needed structure including language scopes and configurable keywords.
When you get prompted for a snippet title you can wrap a part of it in square brackets. This will be used as keyword in autocompletion so you can give your snippets significant names without having to type all of it when inserting it.
You can use Atom's snippet tabstop syntax in snippets. This functionality is only available when inserting through autocompletion. When inserting with the insert command the tabstop markers are stripped from the snippets content, leaving possible default values.
Database Support
Snippet Injector supports Apache CouchDB v2.1 as additional storage.
When enabled, you can mark snippets as shared, meaning they will be stored and synchronized with the CouchDB Server. A database called snippet-injector-data will be created, if not already done. The options for authentication can be left empty if you don't need authentication for your server. (Snippet Injector currently only supports Basic Authentication)
All snippets stored in the database can be used by everyone you give access to the server. That's why this is just an additional storage method, because you possibly don't want to share every snippet with others.
For security reasons, editing of snippets is only permitted to the respective owner, stored in the snippet. The author field is set to the current user account name when creating a snippet. This is no secure protection but prevents snippets from being overwritten or deleted by other users. You may insert a snippet, modify it to your needs and create a new one if needed.
Whenever an error occurs you will be notified through Atom. If possible, there is an option for performing automated repair methods.
Use the Fix Sync Problems button on your own risk! The repair algorithm checks each local snippet for errors with database meta information and synchronization process and resets it's meta if needed. This results in the snippet being treated as unsynchronized and uploaded to the database as a whole new document, what fixes the most common errors.
It may occur that snippet data gets duplicated.
If this option is not available, normally there should be a Retry button instead. It appears that you just misspelled something in the config so whenever an error occurs, check your config and if the server is reachable then click Retry.
Reference
Commands
The following commands are registered by Snippet Injector and can be accessed via the command palette.
snippet-injector:create
This command creates a new snippet from the current selection in the current editor.
You will be prompted for a snippet title.
snippet-injector:update
This command updates an existing snippet's content to the current selection in the current editor.
You will be prompted for choosing an existing snippet.
snippet-injector:insert
This command injects a snippet to the current marker position(s).
You will be prompted to choose a snippet from a list.
snippet-injector:delete
This command deletes a snippet from the local storage.
You will be prompted for the snippet name to delete.
snippet-injector:export
This command exports one or more snippets to a readable JSON.
(intended to share snippets with others)
You will be prompted for the snippets to export and the destination.
snippet-injector:export-all
This command exports the whole storage to a readable JSON.
(intended to use as backup)
You will be prompted for the export destination.
snippet-injector:import
This command imports snippets from a JSON-file into the storage.
You will be prompted for one or more files to import.
snippet-injector:database-syncnow
Manually triggers database synchronization process.
snippet-injector:storage-savenow
Manually triggers storage save to disk.
License information
This package is licensed under the MIT License.
External Sources
All external sources used within this package are subject to their licenses and respective owners.(abtract taken from LICENSE.md)
This package uses the following libraries or contents:
- DEVICON
- jQuery
- couchdb-wrapper
- CSON
6 years ago