feat: add dedent function

[aleclarson]

Tip

The owner of this PR can publish a preview release by commenting /publish in this PR. Afterwards, anyone can try it out by running pnpm add radashi@pr<PR_NUMBER>.

Summary

Use dedent to remove indentation from every line of a consistently indented string.

// Explicit indentation
_.dedent('\n    Hello\n    World!\n\n', '  ')
// => '  Hello\n  World!\n'

// Detected indentation
_.dedent('\n    Hello\n    World!\n\n')
// => 'Hello\nWorld!\n'

Features

• Can detect indentation of the first non-empty line

  const string = `
    A
      B
    C
      D
  `
  
  _.dedent(string)
  // => 'A\n  B\nC\n  D'

• Can be used with a tagged template string

  const story = _.dedent`
    Hello
    World!
  `
  // => 'Hello\nWorld!'

• Can handle multi-line, embedded strings

  const foo = _.dedent`
    My list:
      - ${['Jello', 'Party Hats', 'Clown'].join('\n- ')}
  `
  // 'My list:\n' +
  // '  - Jello\n' +
  // '  - Party Hats\n' +
  // '  - Clown'

For any code change,

• Related documentation has been updated, if needed
• Related tests have been added or updated, if needed
• Related benchmarks have been added or updated, if needed

Does this PR introduce a breaking change?

No

Bundle impact

Status	File	Size 1
A	src/string/dedent.ts	385

Footnotes

1. Function size includes the import dependencies of the function. ↩

[radashi-bot]

Benchmark Results

Name	Current
dedent: dedent as tagged template literal	255,642.75 ops/sec ±0.32%
dedent: dedent as direct call	700,527.75 ops/sec ±0.23%

Performance regressions of 30% or more should be investigated, unless they were anticipated. Smaller regressions may be due to normal variability, as we don't use dedicated CI infrastructure.

[radashi-bot]

A stable release 12.3.0 has been published to NPM. 🚀

To install:

pnpm add [email protected]