@visulima/string 3.0.0-alpha.1 → 3.0.0-alpha.3

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## @visulima/string [3.0.0-alpha.3](https://github.com/visulima/visulima/compare/@visulima/string@3.0.0-alpha.2...@visulima/string@3.0.0-alpha.3) (2025-12-11)
+
+### Bug Fixes
+
+* update package OG images across multiple packages ([f08e4dd](https://github.com/visulima/visulima/commit/f08e4dd2b105ccb29c8412020a9c2be36d6c1e9e))
+
+
+### Dependencies
+
+* **@visulima/colorize:** upgraded to 2.0.0-alpha.3
+
+## @visulima/string [3.0.0-alpha.2](https://github.com/visulima/visulima/compare/@visulima/string@3.0.0-alpha.1...@visulima/string@3.0.0-alpha.2) (2025-12-08)
+
+### Features
+
+* added new excerpt functions ([#582](https://github.com/visulima/visulima/issues/582)) ([1f2059f](https://github.com/visulima/visulima/commit/1f2059f79e8655d868cd9183d8645224c0af4fbb))
+
 ## @visulima/string [3.0.0-alpha.1](https://github.com/visulima/visulima/compare/@visulima/string@2.0.6...@visulima/string@3.0.0-alpha.1) (2025-12-07)
 
 ### ⚠ BREAKING CHANGES

package/LICENSE.md

@@ -27,6 +27,36 @@ The published @visulima/string artifact additionally contains code with the foll
 MIT
 
 # Bundled dependencies:
+## codsen-utils
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
 ## emoji-regex-xs
 License: MIT
 By: Steven Levithan
@@ -100,6 +130,350 @@ Repository: sindresorhus/get-east-asian-width
 >
 > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+---------------------------------------
+
+## html-entities
+License: MIT
+By: Marat Dulin
+Repository: https://github.com/mdevils/html-entities.git
+
+> Copyright (c) 2021 Dulin Marat
+>
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.
+
+---------------------------------------
+
+## lodash-es
+License: MIT
+By: John-David Dalton, Mathias Bynens
+Repository: lodash/lodash
+
+> Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+>
+> Based on Underscore.js, copyright Jeremy Ashkenas,
+> DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
+>
+> This software consists of voluntary contributions made by many
+> individuals. For exact contribution history, see the revision history
+> available at https://github.com/lodash/lodash
+>
+> The following license applies to all parts of this software except as
+> documented below:
+>
+> ====
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+>
+> ====
+>
+> Copyright and related rights for sample code are waived via CC0. Sample
+> code is defined as all source code displayed within the prose of the
+> documentation.
+>
+> CC0: http://creativecommons.org/publicdomain/zero/1.0/
+>
+> ====
+>
+> Files located in the node_modules and vendor directories are externally
+> maintained libraries used by this software which have their own
+> licenses; we recommend you read them, as their terms may differ from the
+> terms above.
+
+---------------------------------------
+
+## ranges-apply
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## ranges-merge
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## ranges-push
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## ranges-sort
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## rfdc
+License: MIT
+By: David Mark Clements
+Repository: git+https://github.com/davidmarkclements/rfdc.git
+
+> Copyright 2019 "David Mark Clements <david.mark.clements@gmail.com>"
+>
+> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
+> documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
+> the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
+> to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in all copies or substantial portions 
+> of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
+> TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
+> THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
+> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
+> IN THE SOFTWARE.
+
+---------------------------------------
+
+## string-collapse-leading-whitespace
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## string-left-right
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## string-strip-html
+License: MIT
+By: Roy Revelt
+Repository: git+https://github.com/codsen/codsen.git
+
+> MIT License
+>
+> Copyright © 2010-2025 Roy Revelt and other contributors
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------
+
+## tiny-invariant
+License: MIT
+By: Alex Reardon
+Repository: https://github.com/alexreardon/tiny-invariant.git
+
+> MIT License
+>
+> Copyright (c) 2019 Alexander Reardon
+>
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.
+
 <!-- /DEPENDENCIES -->
 
 <!-- TYPE_DEPENDENCIES -->

package/README.md

@@ -133,6 +133,25 @@
 
 ---
 
+## Documentation
+
+Comprehensive documentation is available in the [`docs/`](./docs/) directory. The documentation includes:
+
+- **[Getting Started](./docs/index.mdx)** - Overview and quick start guide
+- **[Installation](./docs/installation.mdx)** - Installation instructions and setup
+- **[Case Conversion](./docs/case-conversion.mdx)** - Case conversion utilities (camelCase, PascalCase, etc.)
+- **[String Manipulation](./docs/string-manipulation.mdx)** - Text formatting, truncation, wrapping, and alignment
+- **[Slugification](./docs/slugification.mdx)** - URL slug generation and transliteration
+- **[String Width](./docs/string-width.mdx)** - Visual width calculation for Unicode strings
+- **[String Similarity](./docs/string-similarity.mdx)** - String comparison and similarity algorithms
+- **[Testing](./docs/testing.mdx)** - Testing utilities for ANSI strings
+- **[TypeScript](./docs/typescript.mdx)** - TypeScript support and type definitions
+- **[API Reference](./docs/api.mdx)** - Complete API reference
+
+The documentation follows the [fumadocs.dev](https://fumadocs.dev) markdown format and can be integrated into your documentation site.
+
+---
+
 ## Install
 
 ```sh
@@ -815,19 +834,16 @@ paddedStr.trimEnd<typeof paddedStr>(); // type: '  hello'
 These enhanced types provide several benefits:
 
 1. **Compile-Time Type Safety**:
-
     - Catch type errors before runtime
     - Get accurate type inference for method results
     - Validate string operations at compile time
 
 2. **Better IDE Support**:
-
     - Improved autocompletion
     - More accurate type hints
     - Better refactoring support
 
 3. **Type-Level String Manipulation**:
-
     - Perform string operations at the type level
     - Get literal type results for string operations
     - Chain operations with type safety
@@ -1072,7 +1088,7 @@ const alignedEmojiText = alignText(emojiText, {
     align: "center",
     split: "*",
     pad: "-",
-    stringWidthOptions: { emojiWidth: 2 } // Crucial for correct width calculation with emojis
+    stringWidthOptions: { emojiWidth: 2 }, // Crucial for correct width calculation with emojis
 });
 // alignedEmojiText (string output, exact padding depends on calculated widths):
 // "--Line1😊---\nWiderLine😊😊"
@@ -1082,10 +1098,10 @@ const alignedEmojiText = alignText(emojiText, {
 
 The `alignText` function accepts an `options` object of type `AlignTextOptions` with the following properties:
 
--   `align?: "center" | "left" | "right"`: Specifies the alignment direction. Defaults to `"center"`. Note: `left` alignment primarily ensures line splitting if `text` is a single string; it doesn't typically add padding on the left unless the string was not pre-split.
--   `pad?: string`: The character or string to use for padding. Defaults to `" "`.
--   `split?: string`: The character or string used to split the input `text` into multiple lines if it's provided as a single string. Defaults to `"\n"`.
--   `stringWidthOptions?: StringWidthOptions`: Options passed to an internal string width calculation function (similar to `getStringWidth`) for determining the visual width of each line. This is important for accurately handling ANSI escape codes, CJK characters, emojis, etc. Refer to the `getStringWidth` documentation for details on `StringWidthOptions`.
+- `align?: "center" | "left" | "right"`: Specifies the alignment direction. Defaults to `"center"`. Note: `left` alignment primarily ensures line splitting if `text` is a single string; it doesn't typically add padding on the left unless the string was not pre-split.
+- `pad?: string`: The character or string to use for padding. Defaults to `" "`.
+- `split?: string`: The character or string used to split the input `text` into multiple lines if it's provided as a single string. Defaults to `"\n"`.
+- `stringWidthOptions?: StringWidthOptions`: Options passed to an internal string width calculation function (similar to `getStringWidth`) for determining the visual width of each line. This is important for accurately handling ANSI escape codes, CJK characters, emojis, etc. Refer to the `getStringWidth` documentation for details on `StringWidthOptions`.
 
 ## Related
 
@@ -1132,22 +1148,12 @@ The visulima string is open-sourced software licensed under the [MIT][license]
 <!-- badges -->
 
 [license-badge]: https://img.shields.io/npm/l/@visulima/string?style=for-the-badge
-
 [license]: https://github.com/visulima/visulima/blob/main/LICENSE
-
 [npm-downloads-badge]: https://img.shields.io/npm/dm/@visulima/string?style=for-the-badge
-
 [npm-downloads]: https://www.npmjs.com/package/@visulima/string
-
 [prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
-
 [prs-welcome]: https://github.com/visulima/visulima/blob/main/.github/CONTRIBUTING.md
-
 [chat-badge]: https://img.shields.io/discord/932323359193186354.svg?style=for-the-badge
-
 [chat]: https://discord.gg/TtFJY8xkFK
-
 [typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
-
 [typescript-url]: https://www.typescriptlang.org/
-

package/dist/case/camel-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, a as CamelCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, a as CamelCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 declare const camelCase: <T extends string = string>(value?: T, options?: CaseOptions) => CamelCase<T>;

package/dist/case/camel-case.js

@@ -1,10 +1,10 @@
-import { R as RE_FAST_ANSI } from '../packem_shared/constants-CTzC6Gjg.js';
+import { R as RE_FAST_ANSI } from '../packem_shared/constants-CnXdp6qx.js';
 import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
 import lowerFirst from './lower-first.js';
 import { splitByCase } from './split-by-case.js';
 import upperFirst from './upper-first.js';
 import { g as generateCacheKey } from '../packem_shared/generate-cache-key-DdayDfjV.js';
-import joinSegments from '../packem_shared/joinSegments-CuU8RGpP.js';
+import joinSegments from '../packem_shared/joinSegments-B4H6oZ9b.js';
 import { n as normalizeGermanEszett } from '../packem_shared/normalize-german-eszett-DEB8-ZPT.js';
 
 const defaultCacheStore = new LRUCache(1e3);

package/dist/case/capital-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, b as CapitalCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, b as CapitalCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 declare const capitalCase: <T extends string = string>(value?: T, options?: CaseOptions) => CapitalCase<T>;

package/dist/case/capital-case.js

@@ -1,9 +1,9 @@
-import { R as RE_FAST_ANSI } from '../packem_shared/constants-CTzC6Gjg.js';
+import { R as RE_FAST_ANSI } from '../packem_shared/constants-CnXdp6qx.js';
 import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
 import { splitByCase } from './split-by-case.js';
 import upperFirst from './upper-first.js';
 import { g as generateCacheKey } from '../packem_shared/generate-cache-key-DdayDfjV.js';
-import joinSegments from '../packem_shared/joinSegments-CuU8RGpP.js';
+import joinSegments from '../packem_shared/joinSegments-B4H6oZ9b.js';
 import { n as normalizeGermanEszett } from '../packem_shared/normalize-german-eszett-DEB8-ZPT.js';
 
 const defaultCacheStore = new LRUCache(1e3);

package/dist/case/constant-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, c as ConstantCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, c as ConstantCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 declare const constantCase: <T extends string = string>(value?: T, options?: CaseOptions) => ConstantCase<T>;

package/dist/case/dot-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, D as DotCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, D as DotCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 declare const dotCase: <T extends string = string>(value?: T, options?: CaseOptions) => DotCase<T>;

package/dist/case/flat-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, F as FlatCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, F as FlatCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 declare const flatCase: <T extends string = string>(value?: T, options?: CaseOptions) => FlatCase<T>;

package/dist/case/flip-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, d as FlipCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, d as FlipCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 type FlipOptions = Omit<CaseOptions, "handleEmoji">;

package/dist/case/flip-case.js

@@ -20,7 +20,7 @@ const __cjs_getBuiltinModule = (module) => {
 const {
   stripVTControlCharacters
 } = __cjs_getBuiltinModule("node:util");
-import { s as stripEmoji } from '../packem_shared/constants-CTzC6Gjg.js';
+import { s as stripEmoji } from '../packem_shared/constants-CnXdp6qx.js';
 import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
 import { g as generateCacheKey } from '../packem_shared/generate-cache-key-DdayDfjV.js';
 
@@ -64,7 +64,13 @@ const flipCase = (value, options) => {
     }
     const char = processedValue[index];
     const lowerChar = options?.locale ? char.toLocaleLowerCase(options.locale) : char.toLowerCase();
-    result += char === lowerChar ? options?.locale ? char.toLocaleUpperCase(options.locale) : char.toUpperCase() : lowerChar;
+    let flippedChar;
+    if (char === lowerChar) {
+      flippedChar = options?.locale ? char.toLocaleUpperCase(options.locale) : char.toUpperCase();
+    } else {
+      flippedChar = lowerChar;
+    }
+    result += flippedChar;
     index += 1;
   }
   if (shouldCache && cacheKey) {

package/dist/case/identify-case.d.ts

@@ -1,5 +1,5 @@
-import { I as IdentifyCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { I as IdentifyCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 declare const identifyCase: <T extends string = string>(value?: T) => IdentifyCase<T>;

package/dist/case/index.d.ts

@@ -1,4 +1,4 @@
-export { N as NodeLocale } from '../packem_shared/types-Daae0hGf.js';
+export { N as NodeLocale } from '../packem_shared/types-D2ydhHCv.js';
 export { default as camelCase } from './camel-case.js';
 export { default as capitalCase } from './capital-case.js';
 export { default as constantCase } from './constant-case.js';
@@ -17,7 +17,7 @@ export { default as snakeCase } from './snake-case.js';
 export { SplitOptions, splitByCase } from './split-by-case.js';
 export { default as titleCase } from './title-case.js';
 export { default as trainCase } from './train-case.js';
-export { a as CamelCase, b as CapitalCase, C as CaseOptions, c as ConstantCase, D as DotCase, F as FlatCase, d as FlipCase, I as IdentifyCase, K as KebabCase, L as LocaleOptions, e as LowerFirst, N as NoCase, P as PascalCase, f as PascalSnakeCase, g as PathCase, S as SentenceCase, h as SnakeCase, i as SplitByCase, T as TitleCase, j as TrainCase, U as UpperFirst } from '../packem_shared/types-CfPsw9ix.js';
+export { a as CamelCase, b as CapitalCase, C as CaseOptions, c as ConstantCase, D as DotCase, F as FlatCase, d as FlipCase, I as IdentifyCase, K as KebabCase, L as LocaleOptions, e as LowerFirst, N as NoCase, P as PascalCase, f as PascalSnakeCase, g as PathCase, S as SentenceCase, h as SnakeCase, i as SplitByCase, T as TitleCase, j as TrainCase, U as UpperFirst } from '../packem_shared/types-CHpmpy8C.js';
 export { default as upperFirst } from './upper-first.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 

package/dist/case/index.js

@@ -17,4 +17,4 @@ export { splitByCase } from './split-by-case.js';
 export { default as titleCase } from './title-case.js';
 export { default as trainCase } from './train-case.js';
 export { default as upperFirst } from './upper-first.js';
-export { default as joinSegments } from '../packem_shared/joinSegments-CuU8RGpP.js';
+export { default as joinSegments } from '../packem_shared/joinSegments-B4H6oZ9b.js';

package/dist/case/kebab-case.d.ts

@@ -1,5 +1,5 @@
-import { C as CaseOptions, K as KebabCase } from '../packem_shared/types-CfPsw9ix.js';
-import '../packem_shared/types-Daae0hGf.js';
+import { C as CaseOptions, K as KebabCase } from '../packem_shared/types-CHpmpy8C.js';
+import '../packem_shared/types-D2ydhHCv.js';
 import '../packem_shared/lru-cache-B_t27XwI.js';
 
 interface KebabCaseOptions extends CaseOptions {