finalize the generic printer library

Author: kibanamachine

src/printer/__tests__/builders.test.ts

@@ -5,15 +5,6 @@
  * 2.0.
  */
 
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the "Elastic License
- * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
- * Public License v 1"; you may not use this file except in compliance with, at
- * your election, the "Elastic License 2.0", the "GNU Affero General Public
- * License v3.0 only", or the "Server Side Public License, v 1".
- */
-
 import {
   text,
   line,

src/printer/__tests__/layout.conditional_group.test.ts

@@ -0,0 +1,64 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { text, softline, hardline, group, indent, conditionalGroup, join, layout } from '..';
+
+describe('conditionalGroup', () => {
+  it('uses first state (flat) when it fits', () => {
+    const items = [text('alpha'), text('beta'), text('gamma')];
+
+    const doc = conditionalGroup([
+      // Phase 1: flat with spaces — "alpha, beta, gamma"
+      group(join(text(', '), items)),
+      // Phase 2: compact — "alpha,beta,gamma"
+      group(join([text(','), softline], items)),
+      // Phase 3: one per line
+      group([indent([hardline, join([text(','), hardline], items)]), hardline], {
+        shouldBreak: true,
+      }),
+    ]);
+
+    expect(layout(doc, { printWidth: 20 })).toBe('alpha, beta, gamma');
+    expect(layout(doc, { printWidth: 17 })).toBe('alpha,beta,gamma');
+    expect(layout(doc, { printWidth: 10 })).toBe('\n  alpha,\n  beta,\n  gamma\n');
+  });
+
+  it('three-phase list with brackets', () => {
+    const items = [text('alpha'), text('beta'), text('gamma'), text('delta')];
+    const sep = text(',');
+
+    const doc = conditionalGroup([
+      // Phase 1: all on one line — "(alpha, beta, gamma, delta)" = 27
+      group([text('('), join([sep, text(' ')], items), text(')')]),
+      // Phase 2: compact (no spaces) — "(alpha,beta,gamma,delta)" = 24
+      group([text('('), join([sep, softline], items), text(')')]),
+      // Phase 3: one per line
+      group([text('('), indent([hardline, join([sep, hardline], items)]), hardline, text(')')], {
+        shouldBreak: true,
+      }),
+    ]);
+
+    expect(layout(doc, { printWidth: 30 })).toBe('(alpha, beta, gamma, delta)');
+    expect(layout(doc, { printWidth: 25 })).toBe('(alpha,beta,gamma,delta)');
+    expect(layout(doc, { printWidth: 10 })).toBe('(\n  alpha,\n  beta,\n  gamma,\n  delta\n)');
+  });
+
+  it('with two states only', () => {
+    const doc = conditionalGroup([
+      // Try flat
+      join([text(', ')], [text('aaa'), text('bbb'), text('ccc')]),
+      // Fallback: broken
+      group(
+        [indent([hardline, join([text(','), hardline], [text('aaa'), text('bbb'), text('ccc')])])],
+        { shouldBreak: true }
+      ),
+    ]);
+
+    expect(layout(doc, { printWidth: 20 })).toBe('aaa, bbb, ccc');
+    expect(layout(doc, { printWidth: 10 })).toBe('\n  aaa,\n  bbb,\n  ccc');
+  });
+});

src/printer/__tests__/layout.fill.test.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { text, line, softline, fill, join, layout } from '..';
+
+describe('fill (wrapping layout)', () => {
+  it('renders all items on one line when they fit', () => {
+    const items = ['one', 'two', 'three'].map(text);
+    const doc = fill(join(line, items));
+
+    expect(layout(doc, { printWidth: 80 })).toBe('one two three');
+  });
+
+  it('wraps items across lines', () => {
+    const items = ['aaa', 'bbb', 'ccc', 'ddd', 'eee'].map(text);
+    const doc = fill(join(line, items));
+
+    expect(layout(doc, { printWidth: 12 })).toBe('aaa bbb ccc\nddd eee');
+  });
+
+  it('wraps with softline (no spaces)', () => {
+    const items = ['aaa', 'bbb', 'ccc', 'ddd'].map(text);
+    const doc = fill(join(softline, items));
+
+    expect(layout(doc, { printWidth: 10 })).toBe('aaabbbccc\nddd');
+  });
+
+  it('handles single item', () => {
+    const doc = fill([text('hello')]);
+
+    expect(layout(doc, { printWidth: 80 })).toBe('hello');
+  });
+
+  it('handles two items', () => {
+    const doc = fill([text('hello'), line, text('world')]);
+
+    expect(layout(doc, { printWidth: 80 })).toBe('hello world');
+    expect(layout(doc, { printWidth: 5 })).toBe('hello\nworld');
+  });
+
+  it('handles empty parts', () => {
+    const doc = fill([]);
+
+    expect(layout(doc, { printWidth: 80 })).toBe('');
+  });
+
+  it('wraps words example', () => {
+    const words = 'the quick brown fox jumps over the lazy dog'.split(' ').map(text);
+    const doc = fill(join(line, words));
+
+    expect(layout(doc, { printWidth: 20 })).toBe('the quick brown fox\njumps over the lazy\ndog');
+  });
+
+  it('fill with width 15', () => {
+    const items = ['one', 'two', 'three', 'four', 'five'].map(text);
+    const doc = fill(join(line, items));
+
+    expect(layout(doc, { printWidth: 15 })).toBe('one two three\nfour five');
+  });
+
+  it('fill with width 10', () => {
+    const items = ['one', 'two', 'three', 'four', 'five'].map(text);
+    const doc = fill(join(line, items));
+
+    expect(layout(doc, { printWidth: 10 })).toBe('one two\nthree four\nfive');
+  });
+});

src/printer/__tests__/layout.line_suffix.test.ts

@@ -0,0 +1,96 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { text, hardline, group, lineSuffix, lineSuffixBoundary, layout } from '..';
+
+describe('lineSuffix', () => {
+  it('places comment at end of line', () => {
+    const doc = [text('x'), lineSuffix(text(' # comment')), text(';'), hardline, text('y')];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('x; # comment\ny');
+  });
+
+  it('buffers multiple suffixes', () => {
+    const doc = [
+      text('a'),
+      lineSuffix(text(' // c1')),
+      text('b'),
+      lineSuffix(text(' // c2')),
+      hardline,
+      text('next'),
+    ];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('ab // c1 // c2\nnext');
+  });
+
+  it('flushes suffix at end of document', () => {
+    const doc = [text('code'), lineSuffix(text(' // trailing'))];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('code // trailing');
+  });
+
+  it('suffix ordering with trailing punctuation', () => {
+    const doc = [text('field'), lineSuffix(text(' // comment')), text(','), hardline, text('next')];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('field, // comment\nnext');
+  });
+});
+
+describe('lineSuffixBoundary', () => {
+  it('flushes pending suffix before boundary', () => {
+    const doc = group([text('{'), lineSuffix(text(' # c')), lineSuffixBoundary, text('}')]);
+
+    expect(layout(doc, { printWidth: 80 })).toBe('{ # c\n}');
+  });
+
+  it('does nothing when no suffix is pending', () => {
+    const doc = [text('a'), lineSuffixBoundary, text('b')];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('ab');
+  });
+});
+
+describe('inline block comments (text-based)', () => {
+  it('left and right inline comments are plain text', () => {
+    const doc = [text('/* left */'), text(' '), text('node'), text(' '), text('/* right */')];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('/* left */ node /* right */');
+  });
+});
+
+describe('own-line comments', () => {
+  it('top comment above node', () => {
+    const doc = [text('// top comment'), hardline, text('node')];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('// top comment\nnode');
+  });
+
+  it('bottom comment below node', () => {
+    const doc = [text('node'), hardline, text('// bottom comment')];
+
+    expect(layout(doc, { printWidth: 80 })).toBe('node\n// bottom comment');
+  });
+
+  it('full 5-slot comment model', () => {
+    const nodeDoc = group([text('('), text('value'), text(')')]);
+
+    const doc = [
+      text('// top comment'),
+      hardline,
+      text('/* left */ '),
+      nodeDoc,
+      text(' /* right */'),
+      lineSuffix(text(' // trailing')),
+      hardline,
+      text('// bottom comment'),
+    ];
+
+    expect(layout(doc, { printWidth: 80 })).toBe(
+      '// top comment\n/* left */ (value) /* right */ // trailing\n// bottom comment'
+    );
+  });
+});

src/printer/__tests__/layout.scenarios.test.ts

@@ -5,15 +5,6 @@
  * 2.0.
  */
 
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the "Elastic License
- * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
- * Public License v 1"; you may not use this file except in compliance with, at
- * your election, the "Elastic License 2.0", the "GNU Affero General Public
- * License v3.0 only", or the "Server Side Public License, v 1".
- */
-
 import { text, line, softline, hardline, group, indent, join, fill, layout } from '..';
 
 describe('layout scenarios', () => {

src/printer/__tests__/layout.test.ts

@@ -5,15 +5,6 @@
  * 2.0.
  */
 
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the "Elastic License
- * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
- * Public License v 1"; you may not use this file except in compliance with, at
- * your election, the "Elastic License 2.0", the "GNU Affero General Public
- * License v3.0 only", or the "Server Side Public License, v 1".
- */
-
 import {
   text,
   line,

src/printer/__tests__/prepare.test.ts

@@ -5,15 +5,6 @@
  * 2.0.
  */
 
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the "Elastic License
- * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
- * Public License v 1"; you may not use this file except in compliance with, at
- * your election, the "Elastic License 2.0", the "GNU Affero General Public
- * License v3.0 only", or the "Server Side Public License, v 1".
- */
-
 import { text, line, hardline } from '../builders';
 import { propagateBreaks } from '../prepare';
 import type { GroupNode } from '../types';