feat: ansi support

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

.dictionary.txt

@@ -1,5 +1,6 @@
 attw
 cefc
+chunker
 commandoptst
 commitlintrc
 dedupe

.github/infrastructure.yml

@@ -169,7 +169,7 @@ repository:
   automated_security_fixes: true
   default_branch: main
   delete_branch_on_merge: true
-  description: Wrap a string
+  description: Wrap a string to a specified column width
   has_issues: true
   has_projects: true
   has_wiki: false

README.md

@@ -28,6 +28,7 @@ Wrap a string
   - [`LinePadding`](#linepadding)
   - [`LinesInfo`](#linesinfo)
   - [`Options`](#options)
+  - [`StripAnsi`](#stripansi)
   - [`ToString<[T]>`](#tostringt)
 - [Contribute](#contribute)
 
@@ -195,13 +196,15 @@ Options for wrapping a string (`interface`).
   setting this to `true` will break long words.
   > 👉 **note**: setting this to `true` will break words.
 - `indent?` (`number` | `string` | `null` | `undefined`, optional)
-  — the size of the indent, or a string used to indent each line
+  — the size of the string to use for indenting each line (as a number or numeric), or the string itself
 - `padLeft?` (`number` | `string` | `null` | `undefined`, optional)
-  — the size of the string to use for padding the left side of each line (as a number or numeric), or the string to use
+  — the size of the string to use for padding the left side of each line (as a number or numeric), or the string itself
 - `padRight?` (`number` | `string` | `null` | `undefined`, optional)
-  — the size of the string to use for padding the right side of each line (as a number or numeric), or the string to use
+  — the size of the string to use for padding the right side of each line (as a number or numeric), or the string itself
 - `stringify?` ([`ToString`](#tostringt) | `null` | `undefined`, optional)
   — 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)
   — the number of spaces a tab is equivalent to
   - default: `2`
@@ -210,6 +213,23 @@ Options for wrapping a string (`interface`).
   > 👉 **note**: lines are trimmed before applying indents or padding.
   - default: `true`
 
+### `StripAnsi`
+
+Remove ANSI escape codes from a string (`type`).
+
+```ts
+type StripAnsi = (this: void, string: string) => string
+```
+
+#### Parameters
+
+- `string` (`string`)
+  — the string containing ANSI escape codes
+
+#### Returns
+
+(`string`) The string with ANSI escape codes removed
+
 ### `ToString<[T]>`
 
 Convert `value` to a string (`type`).

__fixtures__/ansi-fixture-01.mts

@@ -0,0 +1,18 @@
+/**
+ * @file Fixtures - fixture01
+ * @module fixtures/ansi/fixture01
+ */
+
+import colors from '@flex-development/colors'
+import { chars } from '@flex-development/fsm-tokenizer'
+
+/**
+ * ANSI fixture #1.
+ *
+ * @type {string}
+ */
+export default `The ${colors.bold('quick')} brown` +
+  chars.space +
+  `${colors.red('fox jumped over ')}the ${colors.italic('lazy')}` +
+  chars.space +
+  colors.green('dog and then ran away with the unicorn.')

__fixtures__/ansi-fixture-02.mts

@@ -0,0 +1,14 @@
+/**
+ * @file Fixtures - fixture2
+ * @module fixtures/ansi/fixture2
+ */
+
+import colors from '@flex-development/colors'
+import { chars } from '@flex-development/fsm-tokenizer'
+
+/**
+ * ANSI fixture #2.
+ *
+ * @type {string}
+ */
+export default colors.green('hello world') + chars.space + 'hey!'

__fixtures__/ansi-fixture-03.mts

@@ -0,0 +1,13 @@
+/**
+ * @file Fixtures - fixture3
+ * @module fixtures/ansi/fixture3
+ */
+
+import colors from '@flex-development/colors'
+
+/**
+ * ANSI fixture #3.
+ *
+ * @type {string}
+ */
+export default colors.blue('hello') + '-world'

__fixtures__/ansi-fixture-04.mts

@@ -0,0 +1,13 @@
+/**
+ * @file Fixtures - fixture4
+ * @module fixtures/ansi/fixture4
+ */
+
+import colors from '@flex-development/colors'
+
+/**
+ * ANSI fixture #4.
+ *
+ * @type {string}
+ */
+export default colors.green('helloworld')

__fixtures__/ansi-fixture-05.mts

@@ -0,0 +1,13 @@
+/**
+ * @file Fixtures - fixture5
+ * @module fixtures/ansi/fixture5
+ */
+
+import colors from '@flex-development/colors'
+
+/**
+ * ANSI fixture #5.
+ *
+ * @type {string}
+ */
+export default colors.yellow('hello') + 'world'

__fixtures__/ansi-fixture-06.mts

@@ -0,0 +1,13 @@
+/**
+ * @file Fixtures - fixture6
+ * @module fixtures/ansi/fixture6
+ */
+
+import colors from '@flex-development/colors'
+
+/**
+ * ANSI fixture #6.
+ *
+ * @type {string}
+ */
+export default colors.blue('   foo   bar   ')

__fixtures__/ansi-fixture-07.mts

@@ -0,0 +1,14 @@
+/**
+ * @file Fixtures - fixture7
+ * @module fixtures/ansi/fixture7
+ */
+
+import colors from '@flex-development/colors'
+import { chars } from '@flex-development/fsm-tokenizer'
+
+/**
+ * ANSI fixture #7.
+ *
+ * @type {string}
+ */
+export default colors.bgGreen(chars.space + colors.black('ok') + chars.space)