fix: allow to have space before ignore format directive and any content after

Author: zardoy

src/moreCompletions.ts

@@ -6,20 +6,20 @@ export default () => {
         defaultJsSupersetLangsWithVue,
         {
             provideCompletionItems(document, position, token, context) {
-                const regex = /\/\/@?[\w-]*/
+                const regex = /\/\/ ?@?[\w-]*/
                 let range = document.getWordRangeAtPosition(position, regex)
                 if (!range) return
                 const rangeText = document.getText(range)
                 if (rangeText !== document.lineAt(position).text.trim()) {
                     return
                 }
 
-                range = range.with(range.start.translate(0, 2), range.end)
+                range = range.with(range.start.translate(0, rangeText.indexOf('@')), range.end)
                 const tsDirectives = ['@ts-format-ignore-line', '@ts-format-ignore-region', '@ts-format-ignore-endregion']
                 return tsDirectives.map((directive, i) => {
                     const completionItem = new vscode.CompletionItem(directive, vscode.CompletionItemKind.Snippet)
                     completionItem.range = range
-                    completionItem.sortText = `z${i}`
+                    completionItem.sortText = `@z${i}`
                     return completionItem
                 })
             },

typescript/src/decorateFormatFeatures.ts

@@ -2,43 +2,41 @@ import { GetConfig } from './types'
 import { patchMethod } from './utils'
 
 export default (proxy: ts.LanguageService, languageService: ts.LanguageService, c: GetConfig) => {
-    // const oldGetAllRules = tsFull.formatting.getAllRules;
-    // tsFull.formatting.getAllRules = () => {
-    // }
+    // todo: add our formatting rules!
+    // tsFull.formatting.getAllRules
 
+    const isExpectedDirective = (line: string | undefined, expected: string) => {
+        if (!line) return false
+        line = line.trim()
+        if (!line.startsWith('//')) return false
+        line = line.slice(2).trim()
+        if (line.startsWith(expected)) return true
+        return false
+    }
     const isFormattingLineIgnored = (sourceFile: ts.SourceFile, position: number) => {
-        // const sourceFile = languageService.getProgram()!.getSourceFile(fileName)!
         const fullText = sourceFile.getFullText()
         // check that lines before line are not ignored
         const linesBefore = fullText.slice(0, position).split('\n')
-        if (linesBefore[linesBefore.length - 2]?.trim() === '//@ts-format-ignore-line') {
+        if (isExpectedDirective(linesBefore[linesBefore.length - 2], '@ts-format-ignore-line')) {
             return true
         }
 
         let isInsideIgnoredRegion = false
         for (const line of linesBefore) {
-            if (line.trim() === '//@ts-format-ignore-region') {
+            if (isExpectedDirective(line, '@ts-format-ignore-region')) {
                 isInsideIgnoredRegion = true
             }
-            if (line.trim() === '//@ts-format-ignore-endregion') {
+            if (isExpectedDirective(line, '@ts-format-ignore-endregion')) {
                 isInsideIgnoredRegion = false
             }
         }
         return isInsideIgnoredRegion
     }
-    // proxy.getFormattingEditsAfterKeystroke = (fileName, position, key, options) => {
-    //     // if (isFormattingLineIgnored(fileName, position)) {
-    //     //     return []
-    //     // }
-    //     return languageService.getFormattingEditsAfterKeystroke(fileName, position, key, options)
-    // }
-    // proxy.getFormattingEditsForDocument = (fileName, options) => {
-    //     return []
-    // }
     const toPatchFormatMethods = ['formatSelection', 'formatOnOpeningCurly', 'formatOnClosingCurly', 'formatOnSemicolon', 'formatOnEnter']
     for (const toPatchFormatMethod of toPatchFormatMethods) {
         patchMethod(tsFull.formatting, toPatchFormatMethod as any, oldFn => (...args) => {
             const result = oldFn(...args)
+            // arg position depends on the method, so we need to find it
             const sourceFile = args.find(arg => ts.isSourceFile(arg as any))
             return result.filter(({ span }) => {
                 if (isFormattingLineIgnored(sourceFile as ts.SourceFile, span.start)) {
@@ -48,12 +46,6 @@ export default (proxy: ts.LanguageService, languageService: ts.LanguageService,
             })
         })
     }
-    // proxy.getFormattingEditsForRange = (fileName, start, end, options) => {
-    //     return languageService.getFormattingEditsForRange(fileName, start, end, options).filter(({ span }) => {
-    //         if (isFormattingLineIgnored(fileName, span.start)) {
-    //             return false
-    //         }
-    //         return true
-    //     })
-    // }
+    // we could easily patch languageService methods getFormattingEditsForDocument, getFormattingEditsAfterKeystroke and getFormattingEditsForRange
+    // but since formatting happens in syntax server, we don't have access to actual sourceFile, so we can't provide implementation
 }

typescript/test/completions.spec.ts

@@ -510,9 +510,9 @@ const a = {
     //@ts-format-ignore-region
     a:   1,
     a1:  2,
-    //@ts-format-ignore-endregion
+    // @ts-format-ignore-endregion
     b:  3,
-    //@ts-format-ignore-line
+    // @ts-format-ignore-line Any content don't care
     c:  4,
 }`)
     const edits = languageService.getFormattingEditsForRange(entrypoint, 0, files[entrypoint]!.length, ts.getDefaultFormatCodeSettings())
@@ -527,7 +527,7 @@ const a = {
           "newText": " ",
           "span": {
             "length": 2,
-            "start": 108,
+            "start": 109,
           },
         },
       ]