Introduce MissingTexts type

BetterThanTomorrow · Jun 25, 2023 · a434f65 · a434f65
1 parent f368d6d
commit a434f65
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/src/cursor-doc/utilities.ts b/src/cursor-doc/utilities.ts
@@ -1,6 +1,11 @@
 import * as model from './model';
 
-export function addMissingBrackets(text: string): { append: string; prepend: string } {
+export type MissingTexts = {
+  append: string;
+  prepend: string;
+};
+
+export function getMissingBrackets(text: string): MissingTexts {
   const doc = new model.StringDocument(text);
   const cursor = doc.getTokenCursor(0);
   const stack: string[] = [];

diff --git a/src/extension-test/unit/cursor-doc/utilities-test.ts b/src/extension-test/unit/cursor-doc/utilities-test.ts
@@ -7,31 +7,31 @@ describe('Utilities that need cursor doc things', () => {
     it('Adds missing brackets', () => {
       const text = '(a b) (c {:d [1 2 3 "four"';
       const append = ']})';
-      expect(utilities.addMissingBrackets(text)).toEqual({ append: append, prepend: '' });
+      expect(utilities.getMissingBrackets(text)).toEqual({ append: append, prepend: '' });
     });
     it('Closes strings', () => {
       const text = '(a b) (c {:d [1 2 3 "four';
       const append = '"]})';
-      expect(utilities.addMissingBrackets(text)).toEqual({ append: append, prepend: '' });
+      expect(utilities.getMissingBrackets(text)).toEqual({ append: append, prepend: '' });
     });
     it('Leaves non-broken structure alone', () => {
       const text = '(a b) (c {:d [1 2 3 "four"] :e :f} g) h';
-      expect(utilities.addMissingBrackets(text)).toEqual({ append: '', prepend: '' });
+      expect(utilities.getMissingBrackets(text)).toEqual({ append: '', prepend: '' });
     });
     it('Adds missing opening brackets', () => {
       const text = '(a b) (c {:d [1 2 3 "four"]}) extra ] closing } brackets)';
       const prepend = '({[';
-      expect(utilities.addMissingBrackets(text)).toEqual({ append: '', prepend: prepend });
+      expect(utilities.getMissingBrackets(text)).toEqual({ append: '', prepend: prepend });
     });
     it('Ignores brackets in strings', () => {
       const text = '(a b) "{{" (c {:d [1 2 3 "four([{" [';
       const append = ']]})';
-      expect(utilities.addMissingBrackets(text)).toEqual({ append: append, prepend: '' });
+      expect(utilities.getMissingBrackets(text)).toEqual({ append: append, prepend: '' });
     });
     it('Ignores brackets in line comments', () => {
       const text = '(a b) (c {:d \n; ( [ ( {\n[1 2 3 "four"';
       const append = ']})';
-      expect(utilities.addMissingBrackets(text)).toEqual({ append: append, prepend: '' });
+      expect(utilities.getMissingBrackets(text)).toEqual({ append: append, prepend: '' });
     });
   });
 });