@zentryc5t/ts-plugin-for-bruno 1.0.0

package/README.md

@@ -0,0 +1,9 @@
+## About the package
+
+This directory provides an `npm` package for a Typescript language service plugin, that allows the Typescript server to handle code blocks from `Bruno` files just like real Javascript code. `Bruno` is an open source API client, see [online docs](https://docs.usebruno.com/) for more infos.
+
+**Disclaimer: All Bruno names, brands, trademarks, service marks and logos are the property of Bruno.**
+
+## Main Features
+
+Only some of the intellisense features for `Bruno` files are provided by this npm package. For a fuller set of intellisense features, you can use the VS Code extension, that is built from the root folder of this git repository. 

package/out/index.js

@@ -0,0 +1,124 @@
+"use strict";
+const path_1 = require("path");
+function init(_modules) {
+    function create(info) {
+        // Set up decorator object
+        const proxy = Object.create(null);
+        for (const k of Object.keys(info.languageService)) {
+            const x = info.languageService[k];
+            // @ts-expect-error - JS runtime trickery which is tricky to type tersely
+            proxy[k] = (...args) => x.apply(info.languageService, args);
+        }
+        proxy.getSyntacticDiagnostics = (fileName) => {
+            return filterDefaultDiagnostics(info, fileName, info.languageService.getSyntacticDiagnostics(fileName));
+        };
+        proxy.getSemanticDiagnostics = (fileName) => {
+            return filterDefaultDiagnostics(info, fileName, info.languageService.getSemanticDiagnostics(fileName));
+        };
+        proxy.getSuggestionDiagnostics = (fileName) => {
+            const defaultDiagnostics = info.languageService.getSuggestionDiagnostics(fileName);
+            if (!isBrunoFile(fileName)) {
+                return defaultDiagnostics;
+            }
+            const allDiagnosticsForCodeBlocks = filterDefaultDiagnostics(info, fileName, defaultDiagnostics);
+            // The ts server always reports errors when importing a Javascript function in a .bru file.
+            return allDiagnosticsForCodeBlocks.filter(({ code, messageText, start }) => {
+                const scriptSnapshot = info.languageServiceHost.getScriptSnapshot(fileName);
+                // ToDo: Improve filtering, so that it is ensured that no valid diagnostics are filtered out by mistake.
+                return !(scriptSnapshot &&
+                    scriptSnapshot.getText(0, start).includes("require(") &&
+                    code == 7044 &&
+                    typeof messageText == "string" &&
+                    messageText.includes("better type may be inferred"));
+            });
+        };
+        // All hovers are provided by the extension implementation
+        proxy.getQuickInfoAtPosition = (fileName, position) => {
+            return isBrunoFile(fileName)
+                ? undefined
+                : info.languageService.getQuickInfoAtPosition(fileName, position);
+        };
+        return proxy;
+    }
+    return {
+        create,
+    };
+}
+function filterDefaultDiagnostics(info, fileName, defaultDiagnostics) {
+    if (!isBrunoFile(fileName)) {
+        return defaultDiagnostics;
+    }
+    else {
+        let fileContent = undefined;
+        const scriptSnapshot = info.languageServiceHost.getScriptSnapshot(fileName);
+        if (scriptSnapshot) {
+            fileContent = scriptSnapshot.getText(0, scriptSnapshot.getLength());
+        }
+        else {
+            fileContent = info.languageServiceHost.readFile(fileName);
+        }
+        if (!fileContent) {
+            return [];
+        }
+        const indizes = [];
+        for (const blockName of Object.values(TextBlockName)) {
+            const indizesForBlock = getTextBlockStartAndEndIndex(fileContent, blockName);
+            if (indizesForBlock) {
+                indizes.push({ blockName, ...indizesForBlock });
+            }
+        }
+        if (indizes.length > 0) {
+            return defaultDiagnostics.filter(({ start, length }) => start != undefined &&
+                length != undefined &&
+                indizes.some(({ startIndex: blockStart, endIndex: blockEnd }) => start >= blockStart && start <= blockEnd) &&
+                // Do not show diagnostics for functions that are provided by Bruno at runtime
+                !["bru", "req", "res", "test", "expect"].includes(fileContent.substring(start, start + length)));
+        }
+        else {
+            return [];
+        }
+    }
+}
+function getTextBlockStartAndEndIndex(fullTextContent, blockName) {
+    const openingBracketChar = "{";
+    const closingBracketChar = "}";
+    const startPattern = new RegExp(`^\\s*${blockName}\\s*${openingBracketChar}\\s*$`, "m");
+    const startMatches = startPattern.exec(fullTextContent);
+    if (!startMatches || startMatches.length == 0) {
+        return undefined;
+    }
+    const contentStartIndex = startMatches.index + startMatches[0].indexOf(openingBracketChar) + 1;
+    const remainingDoc = fullTextContent.substring(contentStartIndex);
+    const remainingDocLength = remainingDoc.length;
+    let openBracketsOnBlockLevel = 1;
+    let remainingDocCurrentIndex = 0;
+    while (openBracketsOnBlockLevel > 0 &&
+        remainingDocCurrentIndex < remainingDocLength) {
+        const currentChar = remainingDoc.charAt(remainingDocCurrentIndex);
+        openBracketsOnBlockLevel +=
+            currentChar == openingBracketChar
+                ? 1
+                : currentChar == closingBracketChar
+                    ? -1
+                    : 0;
+        remainingDocCurrentIndex++;
+    }
+    if (openBracketsOnBlockLevel > 0) {
+        return undefined;
+    }
+    return {
+        startIndex: contentStartIndex,
+        endIndex: remainingDocCurrentIndex + contentStartIndex,
+    };
+}
+function isBrunoFile(fileName) {
+    return (0, path_1.extname)(fileName) == ".bru";
+}
+var TextBlockName;
+(function (TextBlockName) {
+    TextBlockName["Tests"] = "tests";
+    TextBlockName["PreRequestScript"] = "script:pre-request";
+    TextBlockName["PostResponseScript"] = "script:post-response";
+})(TextBlockName || (TextBlockName = {}));
+module.exports = init;
+//# sourceMappingURL=index.js.map

package/out/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAG/B,SAAS,IAAI,CAAC,QAEb;IACG,SAAS,MAAM,CAAC,IAAgC;QAC5C,0BAA0B;QAC1B,MAAM,KAAK,GAAuB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEtD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CACvB,IAAI,CAAC,eAAe,CACS,EAAE,CAAC;YAChC,MAAM,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAE,CAAC;YACnC,yEAAyE;YACzE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QAC3E,CAAC;QAED,KAAK,CAAC,uBAAuB,GAAG,CAAC,QAAQ,EAAE,EAAE;YACzC,OAAO,wBAAwB,CAC3B,IAAI,EACJ,QAAQ,EACR,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAC1B,CAAC;QACrC,CAAC,CAAC;QAEF,KAAK,CAAC,sBAAsB,GAAG,CAAC,QAAQ,EAAE,EAAE;YACxC,OAAO,wBAAwB,CAC3B,IAAI,EACJ,QAAQ,EACR,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CACxD,CAAC;QACN,CAAC,CAAC;QAEF,KAAK,CAAC,wBAAwB,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC1C,MAAM,kBAAkB,GACpB,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YAE5D,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzB,OAAO,kBAAkB,CAAC;YAC9B,CAAC;YACD,MAAM,2BAA2B,GAAG,wBAAwB,CACxD,IAAI,EACJ,QAAQ,EACR,kBAAkB,CACU,CAAC;YAEjC,2FAA2F;YAC3F,OAAO,2BAA2B,CAAC,MAAM,CACrC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC7B,MAAM,cAAc,GAChB,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;gBAEzD,wGAAwG;gBACxG,OAAO,CAAC,CACJ,cAAc;oBACd,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;oBACrD,IAAI,IAAI,IAAI;oBACZ,OAAO,WAAW,IAAI,QAAQ;oBAC9B,WAAW,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CACtD,CAAC;YACN,CAAC,CACJ,CAAC;QACN,CAAC,CAAC;QAEF,0DAA0D;QAC1D,KAAK,CAAC,sBAAsB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YAClD,OAAO,WAAW,CAAC,QAAQ,CAAC;gBACxB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,sBAAsB,CACvC,QAAQ,EACR,QAAQ,CACX,CAAC;QACZ,CAAC,CAAC;QAEF,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QACH,MAAM;KACT,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAC7B,IAAgC,EAChC,QAAgB,EAChB,kBAAiE;IAEjE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,OAAO,kBAAkB,CAAC;IAC9B,CAAC;SAAM,CAAC;QACJ,IAAI,WAAW,GAAuB,SAAS,CAAC;QAChD,MAAM,cAAc,GAChB,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEzD,IAAI,cAAc,EAAE,CAAC;YACjB,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACJ,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAIP,EAAE,CAAC;QAET,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;YACnD,MAAM,eAAe,GAAG,4BAA4B,CAChD,WAAW,EACX,SAAS,CACZ,CAAC;YAEF,IAAI,eAAe,EAAE,CAAC;gBAClB,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,eAAe,EAAE,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,OAAO,kBAAkB,CAAC,MAAM,CAC5B,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAClB,KAAK,IAAI,SAAS;gBAClB,MAAM,IAAI,SAAS;gBACnB,OAAO,CAAC,IAAI,CACR,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,CAC/C,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,QAAQ,CAC/C;gBACD,8EAA8E;gBAC9E,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAC7C,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAC/C,CACR,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;AACL,CAAC;AAED,SAAS,4BAA4B,CACjC,eAAuB,EACvB,SAAwB;IAExB,MAAM,kBAAkB,GAAG,GAAG,CAAC;IAC/B,MAAM,kBAAkB,GAAG,GAAG,CAAC;IAE/B,MAAM,YAAY,GAAG,IAAI,MAAM,CAC3B,QAAQ,SAAS,OAAO,kBAAkB,OAAO,EACjD,GAAG,CACN,CAAC;IACF,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAExD,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,iBAAiB,GACnB,YAAY,CAAC,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEzE,MAAM,YAAY,GAAG,eAAe,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAClE,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAAC;IAC/C,IAAI,wBAAwB,GAAG,CAAC,CAAC;IACjC,IAAI,wBAAwB,GAAG,CAAC,CAAC;IAEjC,OACI,wBAAwB,GAAG,CAAC;QAC5B,wBAAwB,GAAG,kBAAkB,EAC/C,CAAC;QACC,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;QAElE,wBAAwB;YACpB,WAAW,IAAI,kBAAkB;gBAC7B,CAAC,CAAC,CAAC;gBACH,CAAC,CAAC,WAAW,IAAI,kBAAkB;oBACnC,CAAC,CAAC,CAAC,CAAC;oBACJ,CAAC,CAAC,CAAC,CAAC;QAEZ,wBAAwB,EAAE,CAAC;IAC/B,CAAC;IAED,IAAI,wBAAwB,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO;QACH,UAAU,EAAE,iBAAiB;QAC7B,QAAQ,EAAE,wBAAwB,GAAG,iBAAiB;KACzD,CAAC;AACN,CAAC;AAED,SAAS,WAAW,CAAC,QAAgB;IACjC,OAAO,IAAA,cAAO,EAAC,QAAQ,CAAC,IAAI,MAAM,CAAC;AACvC,CAAC;AAED,IAAK,aAIJ;AAJD,WAAK,aAAa;IACd,gCAAe,CAAA;IACf,wDAAuC,CAAA;IACvC,4DAA2C,CAAA;AAC/C,CAAC,EAJI,aAAa,KAAb,aAAa,QAIjB;AAED,iBAAS,IAAI,CAAC"}

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@zentryc5t/ts-plugin-for-bruno",
+  "version": "1.0.0",
+  "main": "./out/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "zentryc5t",
+  "license": "MIT",
+  "description": "",
+  "repository": {"url": "https://github.com/daniel-b92/bruno-vs-code-extension/tree/main/src/tsPlugin"}
+}

package/src/index.ts

@@ -0,0 +1,204 @@
+import { extname } from "path";
+import * as ts from "typescript/lib/tsserverlibrary";
+
+function init(_modules: {
+    typescript: typeof import("typescript/lib/tsserverlibrary");
+}) {
+    function create(info: ts.server.PluginCreateInfo) {
+        // Set up decorator object
+        const proxy: ts.LanguageService = Object.create(null);
+
+        for (const k of Object.keys(
+            info.languageService
+        ) as (keyof ts.LanguageService)[]) {
+            const x = info.languageService[k]!;
+            // @ts-expect-error - JS runtime trickery which is tricky to type tersely
+            proxy[k] = (...args: unknown[]) => x.apply(info.languageService, args);
+        }
+
+        proxy.getSyntacticDiagnostics = (fileName) => {
+            return filterDefaultDiagnostics(
+                info,
+                fileName,
+                info.languageService.getSyntacticDiagnostics(fileName)
+            ) as ts.DiagnosticWithLocation[];
+        };
+
+        proxy.getSemanticDiagnostics = (fileName) => {
+            return filterDefaultDiagnostics(
+                info,
+                fileName,
+                info.languageService.getSemanticDiagnostics(fileName)
+            );
+        };
+
+        proxy.getSuggestionDiagnostics = (fileName) => {
+            const defaultDiagnostics =
+                info.languageService.getSuggestionDiagnostics(fileName);
+
+            if (!isBrunoFile(fileName)) {
+                return defaultDiagnostics;
+            }
+            const allDiagnosticsForCodeBlocks = filterDefaultDiagnostics(
+                info,
+                fileName,
+                defaultDiagnostics
+            ) as ts.DiagnosticWithLocation[];
+
+            // The ts server always reports errors when importing a Javascript function in a .bru file.
+            return allDiagnosticsForCodeBlocks.filter(
+                ({ code, messageText, start }) => {
+                    const scriptSnapshot =
+                        info.languageServiceHost.getScriptSnapshot(fileName);
+
+                    // ToDo: Improve filtering, so that it is ensured that no valid diagnostics are filtered out by mistake.
+                    return !(
+                        scriptSnapshot &&
+                        scriptSnapshot.getText(0, start).includes("require(") &&
+                        code == 7044 &&
+                        typeof messageText == "string" &&
+                        messageText.includes("better type may be inferred")
+                    );
+                }
+            );
+        };
+
+        // All hovers are provided by the extension implementation
+        proxy.getQuickInfoAtPosition = (fileName, position) => {
+            return isBrunoFile(fileName)
+                ? undefined
+                : info.languageService.getQuickInfoAtPosition(
+                      fileName,
+                      position
+                  );
+        };
+
+        return proxy;
+    }
+
+    return {
+        create,
+    };
+}
+
+function filterDefaultDiagnostics(
+    info: ts.server.PluginCreateInfo,
+    fileName: string,
+    defaultDiagnostics: (ts.Diagnostic | ts.DiagnosticWithLocation)[]
+) {
+    if (!isBrunoFile(fileName)) {
+        return defaultDiagnostics;
+    } else {
+        let fileContent: string | undefined = undefined;
+        const scriptSnapshot =
+            info.languageServiceHost.getScriptSnapshot(fileName);
+
+        if (scriptSnapshot) {
+            fileContent = scriptSnapshot.getText(0, scriptSnapshot.getLength());
+        } else {
+            fileContent = info.languageServiceHost.readFile(fileName);
+        }
+
+        if (!fileContent) {
+            return [];
+        }
+
+        const indizes: {
+            blockName: string;
+            startIndex: number;
+            endIndex: number;
+        }[] = [];
+
+        for (const blockName of Object.values(TextBlockName)) {
+            const indizesForBlock = getTextBlockStartAndEndIndex(
+                fileContent,
+                blockName
+            );
+
+            if (indizesForBlock) {
+                indizes.push({ blockName, ...indizesForBlock });
+            }
+        }
+
+        if (indizes.length > 0) {
+            return defaultDiagnostics.filter(
+                ({ start, length }) =>
+                    start != undefined &&
+                    length != undefined &&
+                    indizes.some(
+                        ({ startIndex: blockStart, endIndex: blockEnd }) =>
+                            start >= blockStart && start <= blockEnd
+                    ) &&
+                    // Do not show diagnostics for functions that are provided by Bruno at runtime
+                    !["bru", "req", "res", "test", "expect"].includes(
+                        fileContent.substring(start, start + length)
+                    )
+            );
+        } else {
+            return [];
+        }
+    }
+}
+
+function getTextBlockStartAndEndIndex(
+    fullTextContent: string,
+    blockName: TextBlockName
+) {
+    const openingBracketChar = "{";
+    const closingBracketChar = "}";
+
+    const startPattern = new RegExp(
+        `^\\s*${blockName}\\s*${openingBracketChar}\\s*$`,
+        "m"
+    );
+    const startMatches = startPattern.exec(fullTextContent);
+
+    if (!startMatches || startMatches.length == 0) {
+        return undefined;
+    }
+
+    const contentStartIndex =
+        startMatches.index + startMatches[0].indexOf(openingBracketChar) + 1;
+
+    const remainingDoc = fullTextContent.substring(contentStartIndex);
+    const remainingDocLength = remainingDoc.length;
+    let openBracketsOnBlockLevel = 1;
+    let remainingDocCurrentIndex = 0;
+
+    while (
+        openBracketsOnBlockLevel > 0 &&
+        remainingDocCurrentIndex < remainingDocLength
+    ) {
+        const currentChar = remainingDoc.charAt(remainingDocCurrentIndex);
+
+        openBracketsOnBlockLevel +=
+            currentChar == openingBracketChar
+                ? 1
+                : currentChar == closingBracketChar
+                ? -1
+                : 0;
+
+        remainingDocCurrentIndex++;
+    }
+
+    if (openBracketsOnBlockLevel > 0) {
+        return undefined;
+    }
+
+    return {
+        startIndex: contentStartIndex,
+        endIndex: remainingDocCurrentIndex + contentStartIndex,
+    };
+}
+
+function isBrunoFile(fileName: string) {
+    return extname(fileName) == ".bru";
+}
+
+enum TextBlockName {
+    Tests = "tests",
+    PreRequestScript = "script:pre-request",
+    PostResponseScript = "script:post-response",
+}
+
+export = init;

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es2020",
+        "lib": ["es2020"],
+        "outDir": "out",
+        "sourceMap": true,
+        "strict": true,
+        "rootDir": "src",
+
+        "allowUnreachableCode": false,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "strictPropertyInitialization": true
+    },
+    "exclude": ["node_modules", ".vscode-test"]
+}