Added description field

package.json

@@ -1,7 +1,7 @@
 {
     "name": "talon-snippets",
     "displayName": "Talon snippets",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "description": "Snippets library for Talon",
     "author": "Andreas Arvidsson",
     "publisher": "AndreasArvidsson",

src/parser.ts

@@ -39,6 +39,9 @@ function parseContext(text: string): SnippetDocument | undefined {
             case "name":
                 document.name = value;
                 break;
+            case "description":
+                document.description = value;
+                break;
             case "phrase":
                 document.phrases = parseVectorValue(value);
                 break;

src/serializer.ts

@@ -13,6 +13,7 @@ export function serializeSnippetFile(snippetDocuments: SnippetDocument[]): strin
 function getDocumentText(document: SnippetDocument): string {
     const parts: string[] = [
         getOptionalPairString("name", document.name),
+        getOptionalPairString("description", document.description),
         getOptionalPairString("language", document.languages),
         getOptionalPairString("phrase", document.phrases),
         getOptionalPairString("insertionScope", document.insertionScopes),

src/test/parser.test.ts

@@ -13,29 +13,9 @@ suite("parser", () => {
 });
 
 function testFull() {
-    const fixture = `
-name: foo
--
-
-  foo  
-
- bar 
-baz `;
-
-    const expected: SnippetDocument = {
-        name: "foo",
-        body: ["  foo", "", " bar", "baz"],
-        variables: [],
-    };
-
-    const actual = parseSnippetFile(fixture);
-
-    assert.deepEqual(actual, [expected]);
-}
-
-function testWhitespace() {
     const fixture = `\
 name: mySnippet
+description: My snippet
 phrase: try catch
 language: javascript
 insertionScope: statement
@@ -54,6 +34,7 @@ try {
 
     const expected: SnippetDocument = {
         name: "mySnippet",
+        description: "My snippet",
         phrases: ["try catch"],
         languages: ["javascript"],
         insertionScopes: ["statement"],
@@ -78,6 +59,27 @@ try {
     assert.deepEqual(actual, [expected]);
 }
 
+function testWhitespace() {
+    const fixture = `
+name: foo
+-
+
+  foo  
+
+ bar 
+baz `;
+
+    const expected: SnippetDocument = {
+        name: "foo",
+        body: ["  foo", "", " bar", "baz"],
+        variables: [],
+    };
+
+    const actual = parseSnippetFile(fixture);
+
+    assert.deepEqual(actual, [expected]);
+}
+
 function testNameOnly() {
     const fixture = "name: mySnippet";
     const expected: SnippetDocument = {

src/test/serializer.test.ts

@@ -73,6 +73,7 @@ function testMultipleValues() {
     const fixture: SnippetDocument[] = [
         {
             name: "mySnippet",
+            description: "My snippet",
             phrases: ["first", "second"],
             languages: ["javascript", "java"],
             insertionScopes: ["function", "statement"],
@@ -83,6 +84,7 @@ function testMultipleValues() {
 
     const expected = `\
 name: mySnippet
+description: My snippet
 language: javascript | java
 phrase: first | second
 insertionScope: function | statement

src/types.ts

@@ -1,5 +1,6 @@
 export interface SnippetDocument {
     name?: string;
+    description?: string;
     phrases?: string[];
     insertionScopes?: string[];
     languages?: string[];