Ability to import multiple snippets.cson files

[izuzak]

From @morseldesign on March 29, 2015 19:51

Feature

Ability to do an @import or require() syntax for breaking up snippets into multiple files. For example @import "/snippets/documentation-snippets.cson" or require('snippets/javascript-snippets.cson').

Why

After awhile, snippet files can become pretty overwhelming to manage. Having multiple files would not only help with organization, but make it a little easier to manage changes to certain snippets.

Example

Given a file called snippets/javascript-snippets.cson with contents like:

###
  JavaScript Snippets
###
'.source.js':
  'Console log':
    'prefix': 'log'
    'body': "console.log($1);"

We could import it lnto ~/.atom/snippets.cson like:

# Your snippets
#
# Atom snippets allow you to enter a simple prefix in the editor and hit tab to
# expand the prefix into a larger code block with templated values.
#
# You can create a new snippet in this file by typing "snip" and then hitting
# tab.
#
# An example CoffeeScript snippet to expand log to console.log:
#
# '.source.coffee':
#   'Console log':
#     'prefix': 'log'
#     'body': "console.log $1'"
#

# Syntax #1
@import "snippets/javascript-snippets.cson";

# Syntax #2
require('snippets/javascript-snippets.cson');

Copied from original issue: atom/atom#6155

[thomasjo]

I say we cannot implement the suggestions; CSON is nothing more than JSON. Why not simply support what was previously (or still is?) documented regarding a snippets folder, e.g. ~/atom/snippets, and simply load every all CSON files in that directory? Simple and requires no unnecessary "ceremony".

Should be pretty trivial to implement as well, so might be candidate for good-first label.

[morseldesign]

Can I just have multiple snippets.cson files within ~/atom/snippets as opposed to a single ~/atom/snippets.cson? If so (didn't realized that was the case), I would agree with @thomasjo!

[thomasjo]

Not currently available. It was incorrectly documented that way in the
flight guide. I think it's something we should implement though.
On Mar 31, 2015 6:43 PM, "Morsel" notifications@github.com wrote:

Can I just have multiple snippets.cson files within ~/atom/snippets as
opposed to a single ~/atom/snippets.cson? If so (didn't realized that was
the case), I would agree with @thomasjo https://github.com/thomasjo!

—
Reply to this email directly or view it on GitHub
#124 (comment).

[morseldesign]

Ah. Well in that case, I do prefer your version. Managing imports would be a pain. Auto importing all files from ~/atom/snippets makes a lot more sense.

[thibmaek]

+1 for auto importing but just having anything at all available to manage snippets in partials would be so much better

[castlefields]

+1 this is a real must as my .cson file is becoming unmanageable. A simple ./snippets folder would be an ideal solution...

[NelsonScott]

+1 it's getting difficult to manage all my snippets, especially for different languages.

[castlefields]

The solution, for now, I am using is my own package. Within the package there is a ./snippets folder and within this I am currently creating multiple .cson files. Not ideal as any additional snippets added while working only show after reloading Atom. Therefore I'm using the default snippet.cson while working and then, at then end of the day, pasting any new snippets into my package - ready for start up next day.

Hopefully this solution means that if a ./snippets folder is ever added, as discussed above, I can just copy my .cson files into this...

[thibmaek]

@castlefields Would be great if you published that package to APM so we can use that method for now. 😉

[thibmaek]

@castlefields I created a similar solution to yours because I really got tired of the long snippets file.
Published to apm: https://github.com/thibmaek/modular-snippets

Install with apm install modular-snippets

[pmcalabrese]

👍

[adammagana]

It would be awesome to have project-specific snippet files as well. That way teams/repositories could have version-tracked snippets.cson files. I usually keep my snippets.cson files in a gist but it would be super awesome to have them versioned in my repositories with specific snippets in each. This isn't entirely in the same vein as the proposed idea above but having distributed snippet files is the general idea here. 😄

[wmadden]

👍 to project-specific snippets, as @adammagana proposed. It's particularly annoying when working across projects (sometimes across organizations) with different conventions/linting rules.