Add a new lineComments extension for CodeMirror

app/components/code-mirror.hbs

@@ -22,6 +22,7 @@
   {{did-update this.optionDidChange "indentWithTab" @indentWithTab}}
   {{did-update this.optionDidChange "languageOrFilename" @filename}}
   {{did-update this.optionDidChange "languageOrFilename" @language}}
+  {{did-update this.optionDidChange "lineCommentsOrLineData" (array @lineComments @lineData)}}
   {{did-update this.optionDidChange "lineNumbers" @lineNumbers}}
   {{did-update this.optionDidChange "lineSeparator" @lineSeparator}}
   {{did-update this.optionDidChange "lineWrapping" @lineWrapping}}

app/components/code-mirror.ts

@@ -39,6 +39,7 @@ import { markdown } from '@codemirror/lang-markdown';
 import { highlightNewlines } from 'codecrafters-frontend/utils/code-mirror-highlight-newlines';
 import { collapseUnchangedGutter } from 'codecrafters-frontend/utils/code-mirror-collapse-unchanged-gutter';
 import { highlightActiveLineGutter as highlightActiveLineGutterRS } from 'codecrafters-frontend/utils/code-mirror-gutter-rs';
+import { lineComments, type LineDataCollection } from 'codecrafters-frontend/utils/code-mirror-line-comments';
 
 function generateHTMLElement(src: string): HTMLElement {
   const div = document.createElement('div');
@@ -54,7 +55,7 @@ enum FoldGutterIcon {
 
 type DocumentUpdateCallback = (newValue: string) => void;
 
-type Argument = boolean | string | number | undefined | Extension | DocumentUpdateCallback;
+type Argument = boolean | string | number | undefined | Extension | DocumentUpdateCallback | LineDataCollection;
 
 type OptionHandler = (args: Signature['Args']['Named']) => Extension[] | Promise<Extension[]>;
 
@@ -78,6 +79,7 @@ const OPTION_HANDLERS: { [key: string]: OptionHandler } = {
   indentOnInput: ({ indentOnInput: enabled }) => (enabled ? [indentOnInput()] : []),
   indentUnit: ({ indentUnit: indentUnitText }) => (indentUnitText !== undefined ? [indentUnit.of(indentUnitText)] : []),
   indentWithTab: ({ indentWithTab: enabled }) => (enabled ? [keymap.of([indentWithTab])] : []),
+  lineCommentsOrLineData: ({ lineData, lineComments: enabled }) => (enabled && lineData ? [lineComments(lineData)] : []),
   lineNumbers: ({ lineNumbers: enabled }) => (enabled ? [lineNumbers()] : []),
   foldGutter: ({ foldGutter: enabled }) =>
     enabled
@@ -272,6 +274,14 @@ export interface Signature {
        * Enable indentation of lines or selection using TAB and Shift+TAB keys, otherwise editor loses focus when TAB is pressed
        */
       indentWithTab?: boolean;
+      /**
+       * Enable line comments
+       */
+      lineComments?: boolean;
+      /**
+       * Line data containing comments counts or other line-related metadata
+       */
+      lineData?: LineDataCollection;
       /**
        * Enable the line numbers gutter
        */
@@ -371,6 +381,12 @@ export default class CodeMirrorComponent extends Component<Signature> {
       });
     }
 
+    if (optionName === 'lineCommentsOrLineData') {
+      this.#updateRenderedView({
+        effects: this.#resetCompartment('lineCommentsOrLineData'),
+      });
+    }
+
     // Reconfigure the changed compartment with new options and dispatch new effects to the view
     this.#updateRenderedView({
       effects: await this.#updateCompartment(optionName),

app/controllers/demo/code-mirror.ts

@@ -55,6 +55,7 @@ const OPTION_DEFAULTS = {
   indentWithTab: true,
   language: true,
   lineNumbers: true,
+  lineComments: false,
   lineSeparator: true,
   lineWrapping: true,
   maxHeight: true,
@@ -110,6 +111,7 @@ export default class DemoCodeMirrorController extends Controller {
     'indentUnit',
     'indentWithTab',
     'language',
+    'lineComments',
     'lineNumbers',
     'lineSeparator',
     'lineWrapping',
@@ -163,6 +165,7 @@ export default class DemoCodeMirrorController extends Controller {
   @tracked indentUnits = INDENT_UNITS;
   @tracked indentWithTab = OPTION_DEFAULTS.indentWithTab;
   @tracked language = OPTION_DEFAULTS.language;
+  @tracked lineComments = OPTION_DEFAULTS.lineComments;
   @tracked lineNumbers = OPTION_DEFAULTS.lineNumbers;
   @tracked lineSeparator = OPTION_DEFAULTS.lineSeparator;
   @tracked lineSeparators = LINE_SEPARATORS;

app/routes/demo/code-mirror.ts

@@ -26,6 +26,7 @@ const QUERY_PARAMS = [
   'indentUnit',
   'indentWithTab',
   'language',
+  'lineComments',
   'lineNumbers',
   'lineSeparator',
   'lineWrapping',

app/templates/demo/code-mirror.hbs

@@ -167,6 +167,12 @@
         <Input @type="checkbox" @checked={{this.foldGutter}} />
         <span class="ml-2">foldGutter</span>
       </label>
+      <label class="{{labelClasses}}" title="Enable line comments">
+        <Input @type="checkbox" @checked={{this.lineComments}} />
+        <span class="ml-2">lineComments</span>
+      </label>
+    </codemirror-options-left>
+    <codemirror-options-right class="flex flex-wrap">
       <label class="{{labelClasses}}" title="Enable visual line wrapping for lines exceeding editor width">
         <Input @type="checkbox" @checked={{this.lineWrapping}} />
         <span class="ml-2">lineWrapping</span>
@@ -175,8 +181,6 @@
         <Input @type="checkbox" @checked={{this.scrollPastEnd}} />
         <span class="ml-2">scrollPastEnd</span>
       </label>
-    </codemirror-options-left>
-    <codemirror-options-right class="flex flex-wrap">
       <label class="{{labelClasses}}" title="Limit maximum height of the component's element">
         <Input @type="checkbox" @checked={{this.maxHeight}} />
         <span class="ml-2">maxHeight</span>
@@ -345,6 +349,8 @@
   @history={{this.history}}
   @indentOnInput={{this.indentOnInput}}
   @indentWithTab={{this.indentWithTab}}
+  @lineComments={{this.lineComments}}
+  @lineData={{if this.lineComments this.selectedDocument.lineData}}
   @lineNumbers={{this.lineNumbers}}
   @lineWrapping={{this.lineWrapping}}
   @mergeControls={{this.mergeControls}}

app/utils/code-mirror-documents.ts

@@ -1,11 +1,42 @@
 import { tracked } from '@glimmer/tracking';
 import parseDiffAsDocument from 'codecrafters-frontend/utils/parse-diff-as-document';
+import { LineData, LineDataCollection } from 'codecrafters-frontend/utils/code-mirror-line-comments';
+
+function generateRandomLineData(linesCount = 0) {
+  function getRandomInt(inclusiveMin: number, exclusiveMax: number) {
+    const minCeiled = Math.ceil(inclusiveMin);
+    const maxFloored = Math.floor(exclusiveMax);
+
+    return Math.floor(Math.random() * (maxFloored - minCeiled) + minCeiled);
+  }
+
+  const lineData = Array.from({ length: linesCount }).map(function (_v, lineNumber) {
+    const rnd = Math.random();
+
+    let commentsCount;
+
+    if (rnd < 0.05) {
+      commentsCount = getRandomInt(100, 1000);
+    } else if (rnd < 0.1) {
+      commentsCount = getRandomInt(10, 100);
+    } else if (rnd < 0.8) {
+      commentsCount = 0;
+    } else {
+      commentsCount = getRandomInt(1, 10);
+    }
+
+    return new LineData({ commentsCount, lineNumber: lineNumber + 1 });
+  });
+
+  return new LineDataCollection(lineData);
+}
 
 export class ExampleDocument {
   @tracked document: string = '';
   @tracked originalDocument: string;
   @tracked filename: string;
   @tracked language: string;
+  @tracked lineData?: LineDataCollection;
 
   constructor({
     document = '',
@@ -22,6 +53,8 @@ export class ExampleDocument {
     this.originalDocument = originalDocument || document;
     this.filename = filename;
     this.language = language;
+
+    this.lineData = generateRandomLineData(document?.split('\n').length);
   }
 
   static createEmpty() {

app/utils/code-mirror-line-comments-expanded-plugin.ts

@@ -0,0 +1,54 @@
+import { Decoration, EditorView, ViewPlugin, ViewUpdate, type DecorationSet } from '@codemirror/view';
+import { RangeSetBuilder, StateEffect } from '@codemirror/state';
+import { expandedLineNumbersCompartment, expandedLineNumbersFacet } from 'codecrafters-frontend/utils/code-mirror-line-comments';
+
+const lineCommentsExpandedDecoration = Decoration.line({
+  attributes: { class: 'cm-lineCommentsExpanded' },
+});
+
+function lineCommentsExpandedDecorations(view: EditorView) {
+  const expandedLines = view.state.facet(expandedLineNumbersFacet)[0] || [];
+  const builder = new RangeSetBuilder<Decoration>();
+
+  for (const { from, to } of view.visibleRanges) {
+    for (let pos = from; pos <= to; ) {
+      const line = view.state.doc.lineAt(pos);
+
+      if (expandedLines.includes(line.number)) {
+        builder.add(line.from, line.from, lineCommentsExpandedDecoration);
+      }
+
+      pos = line.to + 1;
+    }
+  }
+
+  return builder.finish();
+}
+
+export function lineCommentsExpandedPlugin() {
+  return ViewPlugin.fromClass(
+    class {
+      decorations: DecorationSet;
+
+      constructor(view: EditorView) {
+        this.decorations = lineCommentsExpandedDecorations(view);
+      }
+
+      update(update: ViewUpdate) {
+        if (update.transactions) {
+          for (const tr of update.transactions) {
+            for (const effect of tr.effects) {
+              if (effect instanceof StateEffect && effect.value?.compartment === expandedLineNumbersCompartment) {
+                this.decorations = lineCommentsExpandedDecorations(update.view);
+                break;
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      decorations: (v) => v.decorations,
+    },
+  );
+}

app/utils/code-mirror-line-comments-gutter.ts

@@ -0,0 +1,118 @@
+import { BlockInfo, EditorView } from '@codemirror/view';
+import { gutter as gutterRS, GutterMarker as GutterMarkerRS } from 'codecrafters-frontend/utils/code-mirror-gutter-rs';
+import { expandedLineNumbersCompartment, expandedLineNumbersFacet, lineDataFacet } from 'codecrafters-frontend/utils/code-mirror-line-comments';
+
+class CommentsCountGutterMarker extends GutterMarkerRS {
+  line: BlockInfo;
+
+  constructor(line: BlockInfo) {
+    super();
+    this.line = line;
+  }
+
+  toDOM(view: EditorView) {
+    const lineNumber = view.state.doc.lineAt(this.line.from).number;
+    const commentsCount = view.state.facet(lineDataFacet)[0]?.dataForLine(lineNumber)?.commentsCount || 0;
+    const elem = document.createElement('div');
+    const classNames = ['cm-commentsCount'];
+
+    if (commentsCount > 99) {
+      classNames.push('cm-commentsCountOver99');
+    }
+
+    elem.className = classNames.join(' ');
+    elem.innerText = `${commentsCount > 99 ? '99+' : commentsCount}`;
+
+    return elem;
+  }
+}
+
+class CommentButtonGutterMarker extends GutterMarkerRS {
+  line: BlockInfo;
+
+  constructor(line: BlockInfo) {
+    super();
+    this.line = line;
+  }
+
+  toDOM() {
+    const elem = document.createElement('div');
+    elem.className = 'cm-commentButton';
+
+    elem.innerText = `💬`;
+
+    return elem;
+  }
+}
+
+function lineCommentsGutterLineMarker(view: EditorView, line: BlockInfo) {
+  const lineNumber = view.state.doc.lineAt(line.from).number;
+  const commentsCount = view.state.facet(lineDataFacet)[0]?.dataForLine(lineNumber)?.commentsCount || 0;
+
+  return new (commentsCount === 0 ? CommentButtonGutterMarker : CommentsCountGutterMarker)(line);
+}
+
+function lineCommentsGutterClickHandler(view: EditorView, line: BlockInfo) {
+  const lineNumber = view.state.doc.lineAt(line.from).number;
+  const expandedLines = view.state.facet(expandedLineNumbersFacet)[0] || [];
+  const newExpandedLines = expandedLines.includes(lineNumber) ? expandedLines.without(lineNumber) : [...expandedLines, lineNumber];
+
+  view.dispatch({
+    effects: [expandedLineNumbersCompartment.reconfigure(expandedLineNumbersFacet.of(newExpandedLines))],
+  });
+
+  return true;
+}
+
+const lineCommentsGutterBaseTheme = EditorView.baseTheme({
+  '.cm-lineCommentsGutter': {
+    minWidth: '24px',
+    textAlign: 'center',
+    userSelect: 'none',
+
+    '& .cm-gutterElement': {
+      cursor: 'pointer',
+
+      '& .cm-commentButton': {
+        opacity: '0.15',
+      },
+
+      '& .cm-commentsCount': {
+        display: 'block',
+        backgroundColor: '#ffcd72c0',
+        borderRadius: '50%',
+        color: '#24292e',
+        transform: 'scale(0.75)',
+        fontWeight: '500',
+        fontSize: '12px',
+
+        '&.cm-commentsCountOver99': {
+          fontSize: '9.5px',
+        },
+      },
+
+      '&:hover': {
+        '& .cm-commentButton': {
+          opacity: '1',
+        },
+
+        '& .cm-commentsCount': {
+          backgroundColor: '#ffa500',
+        },
+      },
+    },
+  },
+});
+
+export function lineCommentsGutter() {
+  return [
+    gutterRS({
+      class: 'cm-lineCommentsGutter',
+      lineMarker: lineCommentsGutterLineMarker,
+      domEventHandlers: {
+        click: lineCommentsGutterClickHandler,
+      },
+    }),
+    lineCommentsGutterBaseTheme,
+  ];
+}