pass specs

Author: Aerijo

lib/insertion.js

@@ -45,19 +45,16 @@ function transformText (str, flags) {
 }
 
 class Insertion {
-  constructor ({ range, substitution }) {
+  constructor ({ range, transformation }) {
     this.range = range
-    this.substitution = substitution
-    if (substitution) {
-      if (substitution.replace === undefined) {
-        substitution.replace = ''
-      }
-      this.replacer = this.makeReplacer(substitution.replace)
+    this.transformation = transformation
+    if (transformation) {
+      this.replacer = this.makeReplacer(transformation.replace)
     }
   }
 
   isTransformation () {
-    return !!this.substitution
+    return !!this.transformation
   }
 
   makeReplacer (replace) {
@@ -73,8 +70,8 @@ class Insertion {
       replace.forEach(token => {
         if (typeof token === 'string') {
           result.push(transformText(token, flags))
-        } else if (token.escape) {
-          ESCAPES[token.escape](flags, result)
+        } else if (token.modifier) {
+          ESCAPES[token.modifier](flags, result)
         } else if (token.backreference) {
           let transformed = transformText(match[token.backreference], flags)
           result.push(transformed)
@@ -85,9 +82,9 @@ class Insertion {
   }
 
   transform (input) {
-    let { substitution } = this
-    if (!substitution) { return input }
-    return input.replace(substitution.find, this.replacer)
+    let { transformation } = this
+    if (!transformation) { return input }
+    return input.replace(transformation.find, this.replacer)
   }
 }
 

lib/snippet-body.pegjs

@@ -65,10 +65,10 @@ tabStopContent = c:(tabStopText / escapedTabStop / tabStop / choice / variable /
 tabStop = '$' t:(tabStopSimple / tabStopWithoutPlaceholder / tabStopWithPlaceholder / tabStopWithTransform) { return t; }
 
 // The simplest form is just $n for some integer `n`
-tabStopSimple = n:integer { return { index: n, content: [] }; }
+tabStopSimple = n:integer { return { index: n }; }
 
 // The next simplest form is equivalent to the above, but wrapped in `{}`
-tabStopWithoutPlaceholder = '{' n:integer '}' { return { index: n, content: [] }; }
+tabStopWithoutPlaceholder = '{' n:integer '}' { return { index: n }; }
 
 // When a ':' follows `n`, the content after the ':' is the placeholder and it can be anything
 tabStopWithPlaceholder = '{' n:integer ':' content:tabStopContent '}' { return { index: n, content }; }

lib/snippet.js

@@ -24,16 +24,16 @@ module.exports = class Snippet {
     let extractTabStops = bodyTree => {
       for (const segment of bodyTree) {
         if (segment.index != null) {
-          let {index, content, substitution} = segment
+          let {index, content, transformation} = segment
           if (index === 0) { index = Infinity; }
           const start = [row, column]
-          extractTabStops(content)
+          if (content) { extractTabStops(content); }
           const range = new Range(start, [row, column])
           const tabStop = this.tabStopList.findOrCreate({
             index,
             snippet: this
           })
-          tabStop.addInsertion({ range, substitution })
+          tabStop.addInsertion({ range, transformation })
         } else if (typeof segment === 'string') {
           bodyText.push(segment)
           var segmentLines = segment.split('\n')

lib/tab-stop.js

@@ -1,5 +1,5 @@
 const {Range} = require('atom')
-const Insertion = require('./insertion')
+const Insertion = require('./insertion').default
 
 // A tab stop:
 // * belongs to a snippet
@@ -20,8 +20,8 @@ class TabStop {
     return !all
   }
 
-  addInsertion ({ range, substitution }) {
-    let insertion = new Insertion({ range, substitution })
+  addInsertion ({ range, transformation }) {
+    let insertion = new Insertion({ range, transformation })
     let insertions = this.insertions
     insertions.push(insertion)
     insertions = insertions.sort((i1, i2) => {
@@ -38,15 +38,15 @@ class TabStop {
   copyWithIndent (indent) {
     let { snippet, index, insertions } = this
     let newInsertions = insertions.map(insertion => {
-      let { range, substitution } = insertion
+      let { range, transformation } = insertion
       let newRange = Range.fromObject(range, true)
       if (newRange.start.row) {
         newRange.start.column += indent.length
         newRange.end.column += indent.length
       }
       return new Insertion({
         range: newRange,
-        substitution
+        transformation
       })
     })
 

spec/body-parser-spec.js

@@ -11,24 +11,24 @@ describe("Snippet Body Parser", () => {
   describe("when parsing tab stops", () => {
     it("parses simple tab stops", () => {
       expectMatch("hello$1world${2}", [
-        "hello", { index: 1, content: [] }, "world", { index: 2, content: [] },
+        "hello", { index: 1 }, "world", { index: 2 },
       ]);
     });
 
     it("skips escaped tab stops", () => {
       expectMatch("$1 \\$2 $3", [
-        { index: 1, content: [] },
+        { index: 1 },
         " $2 ",
-        { index: 3, content: [] },
+        { index: 3 },
       ]);
     });
 
     it("only allows non-negative integer stop numbers", () => {
-      expectMatch("$0", [{ index: 0, content: [] }]);
-      expectMatch("$99999", [{ index: 99999, content: [] }]);
+      expectMatch("$0", [{ index: 0 }]);
+      expectMatch("$99999", [{ index: 99999 }]);
       expectMatch("$-1", ["$-1"]);
       expectMatch("${-1}", ["${-1}"]);
-      expectMatch("$1.5", [{ index: 1, content: [] }, ".5"]);
+      expectMatch("$1.5", [{ index: 1 }, ".5"]);
       expectMatch("${1.5}", ["${1.5}"]);
     });
 
@@ -42,7 +42,7 @@ describe("Snippet Body Parser", () => {
           {
             index: 1,
             content: [
-              { index: 2, content: [] },
+              { index: 2 },
               { variable: "foo" },
               { index: 3, choices: ["a", "b"] },
             ]
@@ -144,7 +144,7 @@ describe("Snippet Body Parser", () => {
       });
 
       it("doesn't allow names to start with a number", () => {
-        expectMatch("$1foo", [{ index: 1, content: [] }, "foo"]);
+        expectMatch("$1foo", [{ index: 1 }, "foo"]);
       });
     });
 
@@ -156,7 +156,7 @@ describe("Snippet Body Parser", () => {
           {
             variable: "foo",
             content: [
-              { index: 2, content: [] },
+              { index: 2 },
               { variable: "bar" },
               { index: 3, choices: ["a", "b"] },
             ]
@@ -242,7 +242,7 @@ describe("Snippet Body Parser", () => {
       expectMatch("${1/foo/bar/a}", ["${1/foo/bar/a}"]); // invalid flag
       expectMatch("${1/fo)o$1/$bar/}", [
         "${1/fo)o",
-        { index: 1, content: [] },
+        { index: 1 },
         "/",
         { variable: "bar" },
         "/}"
@@ -433,8 +433,8 @@ describe("Snippet Body Parser", () => {
     it("accepts the first character as text and resumes", () => {
       expectMatch("${1:${2}${3}", [
         "${1:",
-        { index: 2, content: [] },
-        { index: 3, content: [] }
+        { index: 2 },
+        { index: 3 }
       ]);
     });
   });
@@ -443,7 +443,7 @@ describe("Snippet Body Parser", () => {
     it("breaks a snippet body into lines, with each line containing tab stops at the appropriate position", () => {
       expectMatch("the quick brown $1fox ${2:jumped ${3:over}\n}the ${4:lazy} dog", [
         "the quick brown ",
-        { index: 1, content: [] },
+        { index: 1 },
         "fox ",
         {
           index: 2,
@@ -492,7 +492,7 @@ describe("Snippet Body Parser", () => {
         '<',
         { index: 1, content: ['p'] },
         '>',
-        { index: 0, content: [] },
+        { index: 0 },
         '</',
         { index: 1, transformation: { find: /f/, replace: ['F'] } },
         '>',
@@ -514,7 +514,7 @@ describe("Snippet Body Parser", () => {
           },
         },
         ' ',
-        { index: 1, content: [] },
+        { index: 1 },
         ' ',
         { index: 2, content: ['ANOTHER'] },
         ' ',
@@ -529,7 +529,7 @@ describe("Snippet Body Parser", () => {
           },
         },
         ' ',
-        { index: 2, content: [] },
+        { index: 2 },
       ]);
     });
 
@@ -548,7 +548,7 @@ describe("Snippet Body Parser", () => {
           },
         },
         '\n',
-        { index: 1, content: [] },
+        { index: 1 },
       ]);
     });
 
@@ -557,7 +557,7 @@ describe("Snippet Body Parser", () => {
         '<',
         { index: 1, content: ['p'] },
         '>',
-        { index: 0, content: [] },
+        { index: 0 },
         '</',
         {
           index: 1,
@@ -579,7 +579,7 @@ describe("Snippet Body Parser", () => {
         '<',
         { index: 1, content: ['p'] },
         '>',
-        { index: 0, content: [] },
+        { index: 0 },
         '</',
         {
           index: 1,
@@ -598,38 +598,38 @@ describe("Snippet Body Parser", () => {
 
     it("parses a snippet with a placeholder that mirrors another tab stop's content", () => {
       expectMatch("$4console.${3:log}('${2:$1}', $1);$0", [
-        { index: 4, content: [] },
+        { index: 4 },
         'console.',
         { index: 3, content: ['log'] },
         '(\'',
         {
           index: 2, content: [
-            { index: 1, content: [] }
+            { index: 1 }
           ]
         },
         '\', ',
-        { index: 1, content: [] },
+        { index: 1 },
         ');',
-        { index: 0, content: [] }
+        { index: 0 }
       ]);
     });
 
     it("parses a snippet with a placeholder that mixes text and tab stop references", () => {
       expectMatch("$4console.${3:log}('${2:uh $1}', $1);$0", [
-        { index: 4, content: [] },
+        { index: 4 },
         'console.',
         { index: 3, content: ['log'] },
         '(\'',
         {
           index: 2, content: [
             'uh ',
-            { index: 1, content: [] }
+            { index: 1 }
           ]
         },
         '\', ',
-        { index: 1, content: [] },
+        { index: 1 },
         ');',
-        { index: 0, content: [] }
+        { index: 0 }
       ]);
     });
   });