feat: detab before wrapping

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.dictionary.txt

@@ -4,6 +4,7 @@ chunker
 commandoptst
 commitlintrc
 dedupe
+detab
 devlop
 fbca
 gpgsign

README.md

@@ -280,7 +280,7 @@ Options for wrapping a string (`interface`).
   — convert a value to a string
 - `stripAnsi?` ([`StripAnsi`](#stripansi) | `boolean` | `null` | `undefined`, optional)
   — whether to remove ANSI escape codes before wrapping, or a function to remove ANSI escape codes
-- `tabSize?` (`number` | `null` | `undefined`, optional)
+- `tabSize?` (`number` | `string` | `undefined`, optional)
   — the number of spaces a tab is equivalent to
   - default: `2`
 - `trim?` (`boolean` | `null` | `undefined`, optional)

package.json

@@ -141,6 +141,7 @@
     "@flex-development/ansi-regex": "1.0.0",
     "@flex-development/fsm-tokenizer": "1.0.0-alpha.1",
     "@flex-development/strip-ansi": "1.0.0",
+    "detab": "3.0.2",
     "devlop": "1.1.0",
     "grapheme-splitter": "1.0.4",
     "micromark-util-character": "2.1.1",

src/interfaces/__tests__/options.spec-d.mts

@@ -60,10 +60,10 @@ describe('unit-d:interfaces/Options', () => {
       .toEqualTypeOf<Nilable<StripAnsi | boolean>>()
   })
 
-  it('should match [tabSize?: number | null | undefined]', () => {
+  it('should match [tabSize?: number | string | null | undefined]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('tabSize')
-      .toEqualTypeOf<Nilable<number>>()
+      .toEqualTypeOf<Nilable<number | string>>()
   })
 
   it('should match [trim?: boolean | null | undefined]', () => {

src/interfaces/options.mts

@@ -80,7 +80,7 @@ interface Options {
    *
    * @default 2
    */
-  tabSize?: number | null | undefined
+  tabSize?: number | string | null | undefined
 
   /**
    * Whether to remove whitespace from the beginning and end of each line.

src/internal/__snapshots__/happy-dom/tokenize.functional.snap

@@ -3423,6 +3423,19 @@ exports[`functional:internal/tokenize > options.stripAnsi > should remove ansi e
 }
 `;
 
+exports[`functional:internal/tokenize > options.tabSize > should replace tabs with equivalent number of spaces 1`] = `
+{
+  "candidate": ""\\t\\t\\t\\ttestingtesting"",
+  "hard": true,
+  "lines": [
+    "    testing",
+    "testing",
+  ],
+  "tabSize": 1,
+  "trim": false,
+}
+`;
+
 exports[`functional:internal/tokenize > options.trim > should not trim lines if disabled (0) 1`] = `
 {
   "candidate": ""   "",

src/internal/__snapshots__/node/tokenize.functional.snap

@@ -3423,6 +3423,19 @@ exports[`functional:internal/tokenize > options.stripAnsi > should remove ansi e
 }
 `;
 
+exports[`functional:internal/tokenize > options.tabSize > should replace tabs with equivalent number of spaces 1`] = `
+{
+  "candidate": ""\\t\\t\\t\\ttestingtesting"",
+  "hard": true,
+  "lines": [
+    "    testing",
+    "testing",
+  ],
+  "tabSize": 1,
+  "trim": false,
+}
+`;
+
 exports[`functional:internal/tokenize > options.trim > should not trim lines if disabled (0) 1`] = `
 {
   "candidate": ""   "",

src/internal/__tests__/tokenize.functional.spec.mts

@@ -92,6 +92,7 @@ describe('functional:internal/tokenize', () => {
       'string',
       'stringify',
       'stripAnsi',
+      'tabSize',
       'token',
       'trim',
       'write'
@@ -541,6 +542,27 @@ describe('functional:internal/tokenize', () => {
     })
   })
 
+  describe('options.tabSize', () => {
+    it('should replace tabs with equivalent number of spaces', () => {
+      // Arrange
+      const tabSize: string = chars.digit1
+      const thing: string = chars.ht.repeat(4) + 'testingtesting'
+
+      // Act
+      const result = testSubject(thing, 11, {
+        hard: true,
+        tabSize,
+        trim: false
+      })
+
+      // Expect
+      expect(result).to.have.keys(keys)
+      expect(result).to.have.property('tabSize', +tabSize)
+      expect(result.lines).to.satisfyColumns(result.columns)
+      expect(snapshot(result, ['hard', 'tabSize', 'trim'])).toMatchSnapshot()
+    })
+  })
+
   describe('options.stringify', () => {
     let options: Options
     let stringify: MockInstance<ToString>

src/internal/tokenize.mts

@@ -26,6 +26,7 @@ import type {
   SpacerFunction
 } from '@flex-development/string-wrap'
 import stripAnsi from '@flex-development/strip-ansi'
+import { detab } from 'detab'
 import { ok } from 'devlop'
 
 export default tokenize
@@ -133,12 +134,23 @@ function tokenize(
       [codes.vcr]: eol,
       [codes.vlf]: eol,
       null: [sequence, eoc]
-    }),
-    tabSize: config.tabSize ?? +chars.digit2
+    })
   })
 
-  void chunks(context.trim ? trimEnd(context.string) : context.string, / /g)
-  return context
+  /**
+   * The string to wrap.
+   *
+   * @var {string} string
+   */
+  let string: string = context.string
+
+  // remove tabs.
+  string = detab(string, context.tabSize)
+
+  // trim string.
+  if (context.trim) string = trimEnd(string)
+
+  return void chunks(string, / /g), context
 
   /**
    * Write chunks to the tokenizer.
@@ -255,6 +267,7 @@ function tokenize(
     self.lines = []
     self.padLeft = spacing(config.padLeft)
     self.padRight = spacing(config.padRight)
+    self.tabSize = number(config.tabSize ?? chars.digit2)
     self.stringify = config.stringify ?? String
     self.trim = config.trim ?? true
 

typings/@flex-development/fsm-tokenizer/index.d.mts

@@ -136,5 +136,13 @@ declare module '@flex-development/fsm-tokenizer' {
      * @override
      */
     stripAnsi: StripAnsi
+
+    /**
+     * The number of spaces a tab is equivalent to.
+     *
+     * @internal
+     * @override
+     */
+    tabSize: number
   }
 }