Trim excessive comments in the rest of src/content-render (#63278)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 17588eeb-788a-4f82-9d36-b5079fb36521

Author: heiskr

src/content-render/liquid/data.ts

@@ -91,7 +91,6 @@ function handleIndent(tagToken: TagToken, text: string): string {
 // keep the blockquote character on every successive line.
 const blockquoteRegexp = /^\n?([ \t]*>[ \t]?)/
 function handleBlockquote(tagToken: TagToken, text: string): string {
-  // If the text isn't multiline, skip
   if (text.split('\n').length <= 1) return text
 
   // If the line with the liquid tag starts with a blockquote...
@@ -100,7 +99,6 @@ function handleBlockquote(tagToken: TagToken, text: string): string {
   const inputLine = input.split('\n').find((line) => line.includes(content))
   if (!inputLine || !blockquoteRegexp.test(inputLine)) return text
 
-  // Keep the character on successive lines
   const match = inputLine.match(blockquoteRegexp)
   if (!match) return text
   const start = match[0]

src/content-render/liquid/engine.ts

@@ -77,9 +77,6 @@ engine.registerFilter('render_liquid', function (this: FilterScope, input: unkno
   return engine.parseAndRender(input, this.context.environments)
 })
 
-/**
- * Convert the input to a slug
- */
 engine.registerFilter('slugify', (input: string): string => {
   const slugger = new GithubSlugger()
   return slugger.slug(input)

src/content-render/liquid/ifversion.ts

@@ -95,21 +95,19 @@ export default class Ifversion extends Tag {
     for (const branch of this.branches) {
       let resolvedBranchCond = branch.cond
 
-      // Resolve "not" keywords in the conditional, if any.
       resolvedBranchCond = this.handleNots(resolvedBranchCond)
 
       // Resolve special operators in the conditional, if any.
       // This will replace syntax like `fpt or ghes < 3.0` with `fpt or true` or `fpt or false`.
       resolvedBranchCond = this.handleOperators(resolvedBranchCond)
 
-      // Resolve version names to boolean values for Markdown API context.
-      // This will replace syntax like `fpt or ghec` with `true or false` based on current version.
-      // Only apply this transformation in Markdown API context to avoid breaking existing functionality.
+      // Replace syntax like `fpt or ghec` with `true or false` based on the current
+      // version. Only done for the Markdown API, where the version names would
+      // otherwise be undefined.
       if ((ctx.environments as IfversionEnvironments).markdownRequested) {
         resolvedBranchCond = this.handleVersionNames(resolvedBranchCond)
       }
 
-      // Use Liquid's native function for the final evaluation.
       const cond = yield new Value(resolvedBranchCond, this.liquid).value(ctx, ctx.opts.lenientIf)
 
       if (isTruthy(cond, ctx)) {
@@ -125,7 +123,6 @@ export default class Ifversion extends Tag {
 
     const condArray = resolvedBranchCond.split(' ')
 
-    // Find the first index in the array that contains "not".
     const notIndex = condArray.findIndex((el: string) => el === 'not')
 
     // E.g., ['not', 'fpt']
@@ -156,15 +153,13 @@ export default class Ifversion extends Tag {
     // If this conditional contains multiple parts using `or` or `and`, get only the conditional with operators.
     const condArray = resolvedBranchCond.split(' ')
 
-    // Find the first index in the array that contains an operator.
     const operatorIndex = condArray.findIndex((el: string) =>
       supportedOperators.find((op: string) => el === op),
     )
 
     // E.g., ['ghes', '<', '3.1']
     const condParts = condArray.slice(operatorIndex - 1, operatorIndex + 2)
 
-    // Assign to vars.
     const [versionShortName, operator, releaseToEvaluate] = condParts
 
     // Make sure the operator is supported and the release number matches `\d\d?\.\d\d?`
@@ -219,17 +214,12 @@ export default class Ifversion extends Tag {
       return resolvedBranchCond
     }
 
-    // Split the condition into tokens for processing
     const tokens = resolvedBranchCond.split(/\s+/)
     const processedTokens = tokens.map((token: string) => {
-      // Check if the token is a version short name (fpt, ghec, ghes, ghae)
       const versionShortNames = ['fpt', 'ghec', 'ghes', 'ghae']
       if (versionShortNames.includes(token)) {
-        // Transform version names to boolean values for Markdown API
-        // This fixes the original issue where version names were undefined in API context
         return token === this.currentVersionObj!.shortName ? 'true' : 'false'
       }
-      // Return the token unchanged if it's not a version name
       return token
     })
 

src/content-render/liquid/indented-data-reference.ts

@@ -47,7 +47,6 @@ const IndentedDataReference = {
 
     assert(parseInt(numSpaces) || numSpaces === '0', '"spaces=NUMBER" must include a number')
 
-    // Get the referenced value from the context
     const text: string | undefined = getDataByLanguage(
       dataReference,
       scope.environments.currentLanguage,
@@ -63,7 +62,6 @@ const IndentedDataReference = {
       return
     }
 
-    // add spaces to each line
     const renderedReferenceWithIndent: string = text.replace(/^/gm, ' '.repeat(parseInt(numSpaces)))
 
     return this.liquid.parseAndRender(renderedReferenceWithIndent, scope.environments)

src/content-render/liquid/octicon.ts

@@ -25,7 +25,6 @@ const Octicon = {
       throw new TokenizationError(SyntaxHelp, tagToken)
     }
 
-    // Memoize the icon
     this.icon = match.groups.icon
     // Breaking change in octicons 12
     // https://github.com/primer/octicons/releases/tag/v12.0.0
@@ -36,29 +35,24 @@ const Octicon = {
 
     this.options = {}
 
-    // Memoize any options passed
     if (match.groups.options) {
       let optionsMatch: RegExpExecArray | null
 
-      // Loop through each option matching the OptionsSyntax regex
       while ((optionsMatch = OptionsSyntax.exec(match.groups.options))) {
         // Pull out the key/value ([0] is the whole input)
         const [, key, value] = optionsMatch
         this.options[key] = value
 
-        // Alias label to aria-label
         if (key === 'label') this.options['aria-label'] = value
       }
     }
   },
 
   async render(): Promise<string> {
-    // Throw an error if the requested octicon does not exist.
     if (!Object.prototype.hasOwnProperty.call(octicons, this.icon)) {
       throw new Error(`Octicon ${this.icon} does not exist`)
     }
 
-    // Auto-generate aria-label if not provided
     // Replace non-alphanumeric characters with spaces and append " icon"
     if (!this.options['aria-label']) {
       const defaultLabel = `${this.icon.toLowerCase().replace(/[^a-z0-9]+/gi, ' ')} icon`

src/content-render/liquid/prompt.ts

@@ -1,4 +1,3 @@
-// src/content-render/liquid/prompt.ts
 // Defines {% prompt %}…{% endprompt %} to wrap its content in <code> and append the Copilot icon.
 
 import octicons from '@primer/octicons'
@@ -15,7 +14,6 @@ interface LiquidTag {
 export const Prompt: LiquidTag = {
   type: 'block',
 
-  // Collect everything until {% endprompt %}
   parse(tagToken: TagToken, remainTokens: TopLevelToken[]): void {
     this.templates = []
     const stream = this.liquid.parser.parseStream(remainTokens)
@@ -28,12 +26,10 @@ export const Prompt: LiquidTag = {
     stream.start()
   },
 
-  // Render the inner Markdown, wrap in <code>, then append the SVG
   *render(scope: unknown): Generator<unknown, string, unknown> {
     const content = yield this.liquid.renderer.renderTemplates(this.templates, scope)
     const contentString = String(content)
 
-    // build a URL with the prompt text encoded as query parameter
     const promptParam: string = encodeURIComponent(contentString)
     const href: string = `https://github.com/copilot?prompt=${promptParam}`
     // Use murmur hash for deterministic ID (avoids hydration mismatch)

src/content-render/tests/annotate.ts

@@ -22,41 +22,34 @@ describe('annotate', () => {
     const res = await renderContent(example)
     const $ = load(res)
 
-    // Check that the annotation structure is rendered correctly
     const annotation = $('.annotate')
     expect(annotation.length).toBe(1)
     expect(annotation.hasClass('beside')).toBe(true)
 
-    // Check annotation header exists
     const header = $('.annotate-header')
     expect(header.length).toBe(1)
 
-    // Check both beside and inline modes are rendered
     const beside = $('.annotate-beside')
     const inline = $('.annotate-inline')
     expect(beside.length).toBe(1)
     expect(inline.length).toBe(1)
 
-    // Check that we have the correct number of annotation rows
     const rows = $('.annotate-row')
     expect(rows.length).toBe(2)
 
-    // Check that each row has both code and note sections
     rows.each((i, row) => {
       const $row = $(row)
       expect($row.find('.annotate-code').length).toBe(1)
       expect($row.find('.annotate-note').length).toBe(1)
     })
 
-    // Check specific content of the annotations
     const notes = $('.annotate-note p')
     const noteTexts = notes.map((i, el) => $(el).text()).get()
     expect(noteTexts).toEqual([
       'The name of the workflow as it will appear in the "Actions" tab of the GitHub repository.',
       'Add the pull_request event, so that the workflow runs automatically\nevery time a pull request is created.',
     ])
 
-    // Check code content
     const codes = $('.annotate-code pre')
     const codeTexts = codes.map((i, el) => $(el).text()).get()
     expect(codeTexts).toEqual([
@@ -157,7 +150,6 @@ on: [push]
     const rows = $('.annotate-row')
     const notes = $('.annotate-note', rows)
 
-    // Check that AUTOTITLE links were resolved to actual titles
     const firstNote = notes.eq(0).html()
     const secondNote = notes.eq(1).html()
 

src/content-render/tests/copilot-code-blocks.ts

@@ -18,11 +18,8 @@ describe('code-header plugin', () => {
 
       const html = await renderContent(markdown)
 
-      // Should keep copilot as the language (not convert to text without copy meta)
       expect(html).toContain('language-copilot')
-      // Should NOT wrap in code-example div since no copy meta
       expect(html).not.toContain('code-example')
-      // Should NOT have header since no copy meta
       expect(html).not.toContain('<header')
     })
 
@@ -31,13 +28,10 @@ describe('code-header plugin', () => {
 
       const html = await renderContent(markdown)
 
-      // Should be wrapped in code-example div
       expect(html).toContain('code-example')
-      // Should have header with copy button
       expect(html).toContain('<header')
       expect(html).toContain('js-btn-copy')
       expect(html).toContain('language-copilot')
-      // Should NOT have prompt button (no prompt meta)
       expect(html).not.toContain('https://github.com/copilot?prompt=')
     })
 
@@ -46,14 +40,10 @@ describe('code-header plugin', () => {
 
       const html = await renderContent(markdown)
 
-      // Should be wrapped in code-example div
       expect(html).toContain('code-example')
-      // Should have header
       expect(html).toContain('<header')
-      // Should have prompt button
       expect(html).toContain('https://github.com/copilot?prompt=')
       expect(html).toContain('language-copilot')
-      // Should NOT have copy button
       expect(html).not.toContain('js-btn-copy')
     })
 
@@ -62,15 +52,11 @@ describe('code-header plugin', () => {
 
       const html = await renderContent(markdown)
 
-      // Should be wrapped in code-example div
       expect(html).toContain('code-example')
-      // Should have header with copy button
       expect(html).toContain('<header')
       expect(html).toContain('js-btn-copy')
-      // Should have prompt button with encoded URL
       expect(html).toContain('https://github.com/copilot?prompt=')
       expect(html).toContain('Improve%20the%20variable%20names%20in%20this%20function')
-      // Should have Copilot icon button
       expect(html).toContain('aria-label="Run this prompt in Copilot Chat"')
       expect(html).toContain('language-copilot')
     })
@@ -94,12 +80,9 @@ Improve the variable names in this function
 
       const html = await renderContent(markdown)
 
-      // Should have prompt button with both code blocks in URL
       expect(html).toContain('https://github.com/copilot?prompt=')
-      // Should contain encoded content from both the referenced code and the prompt
       expect(html).toContain('function%20logPersonsAge')
       expect(html).toContain('Improve%20the%20variable%20names')
-      // Should have different aria-label indicating context
       expect(html).toContain('aria-label="Run this prompt with context in Copilot Chat"')
     })
 
@@ -122,14 +105,10 @@ Improve the variable names in this function
 
       const html = await renderContent(markdown)
 
-      // Should have prompt button with both code blocks in URL
       expect(html).toContain('https://github.com/copilot?prompt=')
-      // Should contain encoded content from both the referenced code and the prompt
       expect(html).toContain('function%20logPersonsAge')
       expect(html).toContain('Improve%20the%20variable%20names')
-      // Should have different aria-label indicating context
       expect(html).toContain('aria-label="Run this prompt with context in Copilot Chat"')
-      // Should NOT have copy button
       expect(html).not.toContain('js-btn-copy')
     })
   })
@@ -143,19 +122,14 @@ Improve the variable names in this function
 
       const html = await renderContent(markdown)
 
-      // Should warn about missing reference via structured logger
       expect(mockWarn).toHaveBeenCalledWith('Cannot find referenced code block', {
         ref: 'nonexistent-id',
       })
 
-      // Should still render with prompt button using current code only
       expect(html).toContain('https://github.com/copilot?prompt=')
       expect(html).toContain('Improve%20the%20variable%20names%20in%20this%20function')
-      // Should NOT contain any referenced code since none was found
       expect(html).not.toContain('function%20logPersonsAge')
-      // Should have standard aria-label (not context version)
       expect(html).toContain('aria-label="Run this prompt in Copilot Chat"')
-      // Should not crash or fail
       expect(html).toContain('code-example')
 
       mockWarn.mockClear()
@@ -169,7 +143,6 @@ function test() {}
 
       const html = await renderContent(markdown)
 
-      // Should NOT wrap in code-example div (annotated blocks are excluded)
       expect(html).not.toContain('code-example')
     })
 
@@ -178,7 +151,6 @@ function test() {}
 
       const html = await renderContent(markdown)
 
-      // Should render with copy button
       expect(html).toContain('code-example')
       expect(html).toContain('js-btn-copy')
       expect(html).toContain('language-javascript')
@@ -191,7 +163,6 @@ function test() {}
 
       const html = await renderContent(markdown)
 
-      // Should encode quotes and ampersands properly
       expect(html).toContain('%22quotes%22')
       expect(html).toContain('%26%20symbols')
     })
@@ -204,7 +175,6 @@ This is line 2
 
       const html = await renderContent(markdown)
 
-      // Should encode newlines properly
       expect(html).toContain('This%20is%20line%201%0AThis%20is%20line%202')
     })
   })