refactor(browser): Make comments emitted by codegen stick to the statement below them

src/codegen/browser/__snapshots__/browser/assertions/element-contains-text.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/element-is-hidden.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/element-is-visible.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/checkbox/aria-input-is-checked.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/checkbox/aria-input-is-indeterminate.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/checkbox/aria-input-is-not-checked.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/checkbox/input-is-checked.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/checkbox/input-is-indeterminate.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/checkbox/input-is-not-checked.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/assertions/input/text-input-has-value.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 import { expect } from "https://jslib.k6.io/k6-testing/0.5.0/index.js";
 

src/codegen/browser/__snapshots__/browser/check-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/click-element-with-modifier-keys.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/click-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/click-with-navigation.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/empty-browser-test.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 export const options = {
   scenarios: { default: { executor: "shared-iterations" } },
 };

src/codegen/browser/__snapshots__/browser/form-submit-with-navigation.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/goto-url.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/css-locator.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/get-by-alt-text.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/get-by-label.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/get-by-placeholder.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/get-by-role.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/get-by-test-id.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/locators/get-by-title.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/reload-page.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/right-click-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/select-multiple-options-on-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/select-single-option-on-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/type-text-on-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/uncheck-element.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/__snapshots__/browser/wait-for-statement.ts

@@ -1,5 +1,4 @@
 // Generated by Grafana k6 Studio (0.0.0-vitest) on 2023-10-01T00:00:00.000Z
-
 import { browser } from "k6/browser";
 
 export const options = {

src/codegen/browser/code/comment.ts

@@ -2,7 +2,10 @@ import { AST_NODE_TYPES, TSESTree as ts } from '@typescript-eslint/types'
 
 import { baseProps } from '@/codegen/estree/nodes'
 
-export function comment(value: string): ts.BlockStatement {
+export function comment(
+  value: string,
+  newLine: ts.NewLine = { after: 'never' }
+): ts.BlockStatement {
   // The type of node here is not important since it's just being used as
   // a placeholder for the comment. A BlockStatement just happens to be one
   // of the simplest nodes to build.
@@ -11,5 +14,6 @@ export function comment(value: string): ts.BlockStatement {
     type: AST_NODE_TYPES.BlockStatement,
     comment: value,
     body: [],
+    newLine,
   }
 }

src/codegen/browser/formatting/formatter.ts

@@ -23,19 +23,11 @@ declare module 'prettier/plugins/estree' {
 }
 
 function applySpacing(node: ts.Node | null, doc: builders.Doc): builders.Doc {
-  if (node?.newLine === 'before') {
-    return [hardline, doc]
-  }
-
-  if (node?.newLine === 'after') {
-    return [doc, hardline]
-  }
-
-  if (node?.newLine === 'both') {
-    return [hardline, doc, hardline]
-  }
-
-  return doc
+  return [
+    node?.newLine?.before === true && hardline,
+    doc,
+    node?.newLine?.after === true && hardline,
+  ].filter((item) => item !== false)
 }
 
 /**

src/codegen/browser/formatting/spacing.ts

@@ -3,37 +3,59 @@ import type { TSESTree as ts } from '@typescript-eslint/types'
 export function trimBefore(
   newLine: ts.NewLine | undefined
 ): ts.NewLine | undefined {
-  return newLine === 'both' ? 'after' : undefined
+  if (newLine === undefined) {
+    return undefined
+  }
+
+  return {
+    ...newLine,
+    before: newLine.before === true ? false : newLine.before,
+  }
 }
 
 export function trimAfter(
   newLine: ts.NewLine | undefined
 ): ts.NewLine | undefined {
-  return newLine === 'both' ? 'before' : undefined
+  if (newLine === undefined) {
+    return undefined
+  }
+
+  return {
+    ...newLine,
+    after: newLine.after === true ? false : newLine.after,
+  }
 }
 
 export function mergeNewLine(
-  newLine: ts.NewLine | undefined,
-  target: ts.NewLine
+  target: ts.NewLine | undefined,
+  newLine: ts.NewLine
 ): ts.NewLine {
-  if (newLine === target) {
+  if (target === undefined) {
     return newLine
   }
 
-  if (newLine === undefined) {
-    return target
-  }
+  const before =
+    newLine.before !== undefined && target?.before === 'never'
+      ? target?.before
+      : newLine.before
+
+  const after =
+    newLine.after !== undefined && target?.after === 'never'
+      ? target?.after
+      : newLine.after
 
-  return 'both'
+  return { before, after }
 }
 
 export function spaceBetween<T extends ts.Node>(nodes: T[]) {
   return nodes.map((node, index) => {
-    if (index === nodes.length - 1) {
+    const nextNode = nodes[index + 1]
+
+    if (nextNode === undefined || nextNode.newLine?.before === 'never') {
       return node
     }
 
-    return { ...node, newLine: mergeNewLine(node.newLine, 'after') }
+    return { ...node, newLine: mergeNewLine(node.newLine, { after: true }) }
   })
 }
 
@@ -46,7 +68,7 @@ export function spaceAfter<T extends ts.Node>(nodes: T[]): T[] {
 
   return [
     ...nodes.slice(0, -1),
-    { ...last, newLine: mergeNewLine(last.newLine, 'after') },
+    { ...last, newLine: mergeNewLine(last.newLine, { after: true }) },
   ]
 }
 
@@ -64,9 +86,9 @@ export function spaceAround<T extends ts.Node>([first, ...rest]: T[]): T[] {
   const middle = rest.slice(0, -1)
 
   return [
-    { ...first, newLine: mergeNewLine(first.newLine, 'before') },
+    { ...first, newLine: mergeNewLine(first.newLine, { before: true }) },
     ...middle,
-    { ...last, newLine: mergeNewLine(last.newLine, 'after') },
+    { ...last, newLine: mergeNewLine(last.newLine, { after: false }) },
   ]
 }
 
@@ -75,7 +97,10 @@ export function spaceBefore<T extends ts.Node>([first, ...rest]: T[]): T[] {
     return []
   }
 
-  return [{ ...first, newLine: mergeNewLine(first.newLine, 'before') }, ...rest]
+  return [
+    { ...first, newLine: mergeNewLine(first.newLine, { before: true }) },
+    ...rest,
+  ]
 }
 
 export function trimSpacing<T extends ts.Node>([first, ...rest]: T[]): T[] {

src/codegen/estree/typescript-estree.d.ts

@@ -1,6 +1,16 @@
 declare module '@typescript-eslint/types' {
   namespace TSESTree {
-    type NewLine = 'before' | 'after' | 'both'
+    /**
+     * Options for specifying new line behavior around a node. Specifying
+     * `"never"` will prevent any new lines from being added in that position,
+     * even if other formatting rules would normally add them.
+     */
+    type NewLineOption = boolean | 'never'
+
+    type NewLine = {
+      before?: NewLineOption
+      after?: NewLineOption
+    }
 
     interface NodeOrTokenData {
       /**