@atlaspack/codeframe 2.13.3-canary.51 → 2.13.3-canary.511

package/CHANGELOG.md

@@ -1,5 +1,254 @@
 # @atlaspack/codeframe
 
+## 2.13.38
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.24.1
+
+## 2.13.37
+
+### Patch Changes
+
+- Updated dependencies [[`857962a`](https://github.com/atlassian-labs/atlaspack/commit/857962a352bb0aebaf74a8765e8c44d7e875a4e9)]:
+  - @atlaspack/types-internal@2.24.0
+
+## 2.13.36
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.23.2
+
+## 2.13.35
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.23.1
+
+## 2.13.34
+
+### Patch Changes
+
+- Updated dependencies [[`e058f0e`](https://github.com/atlassian-labs/atlaspack/commit/e058f0e7a0423ba9373e85a7dbd5c1dd43b47916)]:
+  - @atlaspack/types-internal@2.23.0
+
+## 2.13.33
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.8
+
+## 2.13.32
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.7
+
+## 2.13.31
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.6
+
+## 2.13.30
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.5
+
+## 2.13.29
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.4
+
+## 2.13.28
+
+### Patch Changes
+
+- Updated dependencies [[`02cc8b3`](https://github.com/atlassian-labs/atlaspack/commit/02cc8b32c06ca6b51806b33f6f707ca06e55e957)]:
+  - @atlaspack/types-internal@2.22.3
+
+## 2.13.27
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.2
+
+## 2.13.26
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.22.1
+
+## 2.13.25
+
+### Patch Changes
+
+- Updated dependencies [[`00fa643`](https://github.com/atlassian-labs/atlaspack/commit/00fa6433202bfd3311479f6314c9ec878a789f2c)]:
+  - @atlaspack/types-internal@2.22.0
+
+## 2.13.24
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.21.3
+
+## 2.13.23
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.21.2
+
+## 2.13.22
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.21.1
+
+## 2.13.21
+
+### Patch Changes
+
+- Updated dependencies [[`8eb84ee`](https://github.com/atlassian-labs/atlaspack/commit/8eb84ee61a42bfe87c58079b610802b07a6a13e4), [`73168c2`](https://github.com/atlassian-labs/atlaspack/commit/73168c275a5d9abff9907bcf536b340bca1ed5f0), [`617a318`](https://github.com/atlassian-labs/atlaspack/commit/617a318ddc9419b38360257353fec50b9051ee13)]:
+  - @atlaspack/types-internal@2.21.0
+
+## 2.13.20
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.20.8
+
+## 2.13.19
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.20.7
+
+## 2.13.18
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.20.6
+
+## 2.13.17
+
+### Patch Changes
+
+- Updated dependencies [[`c372f3f`](https://github.com/atlassian-labs/atlaspack/commit/c372f3fd6fce8200d5cf47f41bc7895c6cbb5558)]:
+  - @atlaspack/types-internal@2.20.5
+
+## 2.13.16
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.20.4
+
+## 2.13.15
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.20.3
+
+## 2.13.14
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.20.2
+
+## 2.13.13
+
+### Patch Changes
+
+- [#785](https://github.com/atlassian-labs/atlaspack/pull/785) [`0e7dd5e`](https://github.com/atlassian-labs/atlaspack/commit/0e7dd5ec6fbe05aa9e0bb5775a9d0975f206a922) Thanks [@matt-koko](https://github.com/matt-koko)! - We need to re-publish every package in Atlaspack with the corrected types field.
+
+- Updated dependencies [[`0e7dd5e`](https://github.com/atlassian-labs/atlaspack/commit/0e7dd5ec6fbe05aa9e0bb5775a9d0975f206a922)]:
+  - @atlaspack/types-internal@2.20.1
+
+## 2.13.12
+
+### Patch Changes
+
+- Updated dependencies [[`eedcbc4`](https://github.com/atlassian-labs/atlaspack/commit/eedcbc408fc1e86a2a8e25f1a41c57146d8529e1), [`f6532d7`](https://github.com/atlassian-labs/atlaspack/commit/f6532d7a4f7f007bd4e5e36af04dd466f0b9f572)]:
+  - @atlaspack/types-internal@2.20.0
+
+## 2.13.11
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.19.5
+
+## 2.13.10
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.19.4
+
+## 2.13.9
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.19.3
+
+## 2.13.8
+
+### Patch Changes
+
+- [#742](https://github.com/atlassian-labs/atlaspack/pull/742) [`ee040bb`](https://github.com/atlassian-labs/atlaspack/commit/ee040bb6428f29b57d892ddd8107e29077d08ffd) Thanks [@yamadapc](https://github.com/yamadapc)! - Internal changes and bug fixes to environmentDeduplication flag
+
+- Updated dependencies [[`ee040bb`](https://github.com/atlassian-labs/atlaspack/commit/ee040bb6428f29b57d892ddd8107e29077d08ffd)]:
+  - @atlaspack/types-internal@2.19.2
+
+## 2.13.7
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/types-internal@2.19.1
+
+## 2.13.6
+
+### Patch Changes
+
+- Updated dependencies [[`7f5841c`](https://github.com/atlassian-labs/atlaspack/commit/7f5841c39df049f9546cccbeea2a7337e0337b45)]:
+  - @atlaspack/types-internal@2.19.0
+
+## 2.13.5
+
+### Patch Changes
+
+- [#720](https://github.com/atlassian-labs/atlaspack/pull/720) [`d2fd849`](https://github.com/atlassian-labs/atlaspack/commit/d2fd849770fe6305e9c694bd97b1bd905abd9d94) Thanks [@alshdavid](https://github.com/alshdavid)! - Migrate to TypeScript
+
+## 2.13.4
+
+### Patch Changes
+
+- [#645](https://github.com/atlassian-labs/atlaspack/pull/645) [`de23e0c`](https://github.com/atlassian-labs/atlaspack/commit/de23e0ce49d5504fe3947ac26640a3d951087da3) Thanks [@alshdavid](https://github.com/alshdavid)! - Updated build system and added some extra test-specific code
+
+- [#682](https://github.com/atlassian-labs/atlaspack/pull/682) [`a5ed1b4`](https://github.com/atlassian-labs/atlaspack/commit/a5ed1b414498560f393ff491af4da25b6e8dde56) Thanks [@alshdavid](https://github.com/alshdavid)! - Updating build system
+
 ## 2.13.3
 
 ### Patch Changes

package/dist/codeframe.js

@@ -0,0 +1,215 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = codeFrame;
+const chalk_1 = __importDefault(require("chalk"));
+// @ts-expect-error emphasize is not typed
+const emphasize_1 = __importDefault(require("emphasize"));
+const string_width_1 = __importDefault(require("string-width"));
+// @ts-expect-error slice-ansi is not typed
+const slice_ansi_1 = __importDefault(require("slice-ansi"));
+const NEWLINE = /\r\n|[\n\r\u2028\u2029]/;
+const TAB_REPLACE_REGEX = /\t/g;
+const TAB_REPLACEMENT = '  ';
+const DEFAULT_TERMINAL_WIDTH = 80;
+const highlightSyntax = (txt, lang) => {
+    if (lang) {
+        try {
+            return emphasize_1.default.highlight(lang, txt).value;
+        }
+        catch (e) {
+            // fallback for unknown languages...
+        }
+    }
+    return emphasize_1.default.highlightAuto(txt).value;
+};
+function codeFrame(code, highlights, inputOpts = {}) {
+    if (highlights.length < 1)
+        return '';
+    let opts = {
+        useColor: !!inputOpts.useColor,
+        syntaxHighlighting: !!inputOpts.syntaxHighlighting,
+        language: inputOpts.language,
+        maxLines: inputOpts.maxLines ?? 12,
+        terminalWidth: inputOpts.terminalWidth || DEFAULT_TERMINAL_WIDTH,
+        padding: inputOpts.padding || {
+            before: 1,
+            after: 2,
+        },
+    };
+    // Highlights messages and prefixes when colors are enabled
+    const highlighter = (s, bold) => {
+        if (opts.useColor) {
+            let redString = chalk_1.default.red(s);
+            return bold ? chalk_1.default.bold(redString) : redString;
+        }
+        return s;
+    };
+    // Prefix lines with the line number
+    const lineNumberPrefixer = (params) => {
+        let { lineNumber, lineNumberLength, isHighlighted } = params;
+        return `${isHighlighted ? highlighter('>') : ' '} ${lineNumber
+            ? lineNumber.padStart(lineNumberLength, ' ')
+            : ' '.repeat(lineNumberLength)} | `;
+    };
+    // Make columns/lines start at 1
+    let originalHighlights = highlights;
+    highlights = highlights.map((h) => {
+        return {
+            start: {
+                column: h.start.column - 1,
+                line: h.start.line - 1,
+            },
+            end: {
+                column: h.end.column - 1,
+                line: h.end.line - 1,
+            },
+            message: h.message,
+        };
+    });
+    // Find first and last highlight
+    let firstHighlight = highlights.length > 1
+        ? highlights.sort((a, b) => a.start.line - b.start.line)[0]
+        : highlights[0];
+    let lastHighlight = highlights.length > 1
+        ? highlights.sort((a, b) => b.end.line - a.end.line)[0]
+        : highlights[0];
+    // Calculate first and last line index of codeframe
+    let startLine = firstHighlight.start.line - opts.padding.before;
+    startLine = startLine < 0 ? 0 : startLine;
+    let endLineIndex = lastHighlight.end.line + opts.padding.after;
+    let tail;
+    if (endLineIndex - startLine > opts.maxLines) {
+        let maxLine = startLine + opts.maxLines - 1;
+        highlights = highlights.filter((h) => h.start.line < maxLine);
+        lastHighlight = highlights[0];
+        endLineIndex = Math.min(maxLine, lastHighlight.end.line + opts.padding.after);
+        tail = originalHighlights.filter((h) => h.start.line > endLineIndex);
+    }
+    let lineNumberLength = (endLineIndex + 1).toString(10).length;
+    // Split input into lines and highlight syntax
+    let lines = code.split(NEWLINE);
+    let syntaxHighlightedLines = (opts.syntaxHighlighting ? highlightSyntax(code, opts.language) : code)
+        .replace(TAB_REPLACE_REGEX, TAB_REPLACEMENT)
+        .split(NEWLINE);
+    // Loop over all lines and create codeframe
+    let resultLines = [];
+    for (let currentLineIndex = startLine; currentLineIndex < syntaxHighlightedLines.length; currentLineIndex++) {
+        if (currentLineIndex > endLineIndex)
+            break;
+        if (currentLineIndex > syntaxHighlightedLines.length - 1)
+            break;
+        // Find highlights that need to get rendered on the current line
+        let lineHighlights = highlights
+            .filter((highlight) => highlight.start.line <= currentLineIndex &&
+            highlight.end.line >= currentLineIndex)
+            .sort((a, b) => (a.start.line < currentLineIndex ? 0 : a.start.column) -
+            (b.start.line < currentLineIndex ? 0 : b.start.column));
+        // Check if this line has a full line highlight
+        let isWholeLine = lineHighlights.length &&
+            !!lineHighlights.find((h) => h.start.line < currentLineIndex && h.end.line > currentLineIndex);
+        let lineLengthLimit = opts.terminalWidth > lineNumberLength + 7
+            ? opts.terminalWidth - (lineNumberLength + 5)
+            : 10;
+        // Split the line into line parts that will fit the provided terminal width
+        let colOffset = 0;
+        let lineEndCol = lineLengthLimit;
+        let syntaxHighlightedLine = syntaxHighlightedLines[currentLineIndex];
+        if ((0, string_width_1.default)(syntaxHighlightedLine) > lineLengthLimit) {
+            if (lineHighlights.length > 0) {
+                if (lineHighlights[0].start.line === currentLineIndex) {
+                    colOffset = lineHighlights[0].start.column - 5;
+                }
+                else if (lineHighlights[0].end.line === currentLineIndex) {
+                    colOffset = lineHighlights[0].end.column - 5;
+                }
+            }
+            colOffset = colOffset > 0 ? colOffset : 0;
+            lineEndCol = colOffset + lineLengthLimit;
+            syntaxHighlightedLine = (0, slice_ansi_1.default)(syntaxHighlightedLine, colOffset, lineEndCol);
+        }
+        // Write the syntax highlighted line part
+        resultLines.push(lineNumberPrefixer({
+            lineNumber: (currentLineIndex + 1).toString(10),
+            lineNumberLength,
+            isHighlighted: lineHighlights.length > 0,
+        }) + syntaxHighlightedLine);
+        let lineWidth = (0, string_width_1.default)(syntaxHighlightedLine);
+        let highlightLine = '';
+        if (isWholeLine) {
+            highlightLine = highlighter('^'.repeat(lineWidth));
+        }
+        else if (lineHighlights.length > 0) {
+            let lastCol = 0;
+            let highlight = null;
+            let highlightHasEnded = false;
+            for (let highlightIndex = 0; highlightIndex < lineHighlights.length; highlightIndex++) {
+                // Set highlight to current highlight
+                highlight = lineHighlights[highlightIndex];
+                highlightHasEnded = false;
+                // Calculate the startColumn and get the real width by doing a substring of the original
+                // line and replacing tabs with our tab replacement to support tab handling
+                let startCol = 0;
+                if (highlight.start.line === currentLineIndex &&
+                    highlight.start.column > colOffset) {
+                    startCol = lines[currentLineIndex]
+                        .substring(colOffset, highlight.start.column)
+                        .replace(TAB_REPLACE_REGEX, TAB_REPLACEMENT).length;
+                }
+                // Calculate the endColumn and get the real width by doing a substring of the original
+                // line and replacing tabs with our tab replacement to support tab handling
+                let endCol = lineWidth - 1;
+                if (highlight.end.line === currentLineIndex) {
+                    endCol = lines[currentLineIndex]
+                        .substring(colOffset, highlight.end.column)
+                        .replace(TAB_REPLACE_REGEX, TAB_REPLACEMENT).length;
+                    // If the endCol is too big for this line part, trim it so we can handle it in the next one
+                    if (endCol > lineWidth) {
+                        endCol = lineWidth - 1;
+                    }
+                    highlightHasEnded = true;
+                }
+                // If endcol is smaller than lastCol it overlaps with another highlight and is no longer visible, we can skip those
+                if (endCol >= lastCol) {
+                    let characters = endCol - startCol + 1;
+                    if (startCol > lastCol) {
+                        // startCol is before lastCol, so add spaces as padding before the highlight indicators
+                        highlightLine += ' '.repeat(startCol - lastCol);
+                    }
+                    else if (lastCol > startCol) {
+                        // If last column is larger than the start, there's overlap in highlights
+                        // This line adjusts the characters count to ensure we don't add too many characters
+                        characters += startCol - lastCol;
+                    }
+                    // Don't crash (and swallow the original message) if the diagnostic is malformed (end is before start).
+                    characters = Math.max(1, characters);
+                    // Append the highlight indicators
+                    highlightLine += highlighter('^'.repeat(characters));
+                    // Set the lastCol equal to character count between start of line part and highlight end-column
+                    lastCol = endCol + 1;
+                }
+                // There's no point in processing more highlights if we reached the end of the line
+                if (endCol >= lineEndCol - 1) {
+                    break;
+                }
+            }
+            // Append the highlight message if the current highlights ends on this line part
+            if (highlight && highlight.message && highlightHasEnded) {
+                highlightLine += ' ' + highlighter(highlight.message, true);
+            }
+        }
+        if (highlightLine) {
+            resultLines.push(lineNumberPrefixer({
+                lineNumberLength,
+                isHighlighted: true,
+            }) + highlightLine);
+        }
+    }
+    let result = resultLines.join('\n');
+    if (tail && tail.length > 0) {
+        result += '\n\n' + codeFrame(code, tail, inputOpts);
+    }
+    return result;
+}