@synstack/str 1.2.1 → 1.2.2

package/README.md

@@ -1,142 +1,103 @@
-# @synstack/str
-
-> Advanced chainable string manipulation utilities for TypeScript
-
-This package provides a strongly-typed, chainable API for string manipulation with support for multiple case conversions and advanced text formatting operations.
-
-> [!WARNING]
-> This package is included in the [@synstack/synscript](https://github.com/pAIrprogio/synscript) package. It is not recommended to install both packages at the same time.
-
-## What is it for?
-
-Working with strings should be simple and type-safe. This package turns verbose string operations into chainable, strongly-typed commands:
-
-```typescript
-import { str } from '@synstack/str'
-
-// Basic chaining
-const result = str('  Hello World  ')
-  .trim()
-  .split(' ')
-  .at(0)
-  .$
-
-// Case conversion
-const camelCase = str('hello-world').camelCase().$
-console.log(camelCase) // 'helloWorld'
-
-// Advanced manipulation
-const formatted = str('    some\n  indented\n      text')
-  .trimEmptyLines()
-  .dedent()
-  .$
-
-// Line manipulation
-const lines = str('line1\n\n\n\nline2')
-  .chopRepeatNewlines(1)
-  .split('\n')
-console.log(lines) // ['line1', 'line2']
-```
-
-## Installation
-
-```bash
-npm install @synstack/str
-# or
-yarn add @synstack/str
-# or
-pnpm add @synstack/str
-```
-
-## Features
-
-- 🔗 Chainable API for fluent string manipulation
-- 📝 Rich set of string utilities (trim, chop, indent, etc.)
-- 🔄 Case conversion utilities (camel, pascal, snake, etc.)
-- 🎯 TypeScript-first with full type safety
-- ⚡ Zero dependencies (except change-case)
-
-## API Reference
-
-### Str Class
-
-The main class providing chainable string operations. Extends `Pipeable` from `@synstack/pipe`.
-
-#### Chaining Methods
-
-- `_((str) => result)`: Chain operations on the Str instance
-- `_$((value) => result)`: Chain operations on the string value
-- `$`: Get the underlying string value
-
-#### String Operations
-
-##### Trimming
-- `trim()`: Remove leading and trailing whitespace
-- `trimStart()`: Remove leading whitespace
-- `trimEnd()`: Remove trailing whitespace
-- `trimEmptyLines()`: Remove whitespace from empty lines
-- `trimLinesTrailingSpaces()`: Remove trailing spaces from all lines
-
-##### Line Manipulation
-- `chopEmptyLinesStart()`: Remove empty lines at start
-- `chopEmptyLinesEnd()`: Remove empty lines at end
-- `chopRepeatNewlines(max: number)`: Limit consecutive newlines
-- `addLineNumbers(separator?: string)`: Add line numbers to each line
-
-##### Indentation
-- `indent(size: number, char?: string)`: Indent all lines
-- `dedent(size?: number)`: Remove indentation
-- `indentation()`: Get the minimum indentation level
-- `leadingSpacesCount()`: Count leading spaces
-
-##### String Extraction
-- `split(separator: string | RegExp)`: Split string into array
-- `takeStart(count: number)`: Take first n characters
-- `takeEnd(count: number)`: Take last n characters
-- `firstLine()`: Get the first line
-- `lastLine()`: Get the last line
-
-##### Case Conversion
-- `camelCase()`: Convert to camelCase
-- `capitalCase()`: Convert to Capital Case
-- `constantCase()`: Convert to CONSTANT_CASE
-- `dotCase()`: Convert to dot.case
-- `kebabCase()`: Convert to kebab-case
-- `noCase()`: Convert to no case
-- `pascalCase()`: Convert to PascalCase
-- `pascalSnakeCase()`: Convert to Pascal_Snake_Case
-- `pathCase()`: Convert to path/case
-- `sentenceCase()`: Convert to Sentence case
-- `snakeCase()`: Convert to snake_case
-- `trainCase()`: Convert to Train-Case
-
-### Utility Functions
-
-All methods from the Str class are also available as standalone functions:
-
-```typescript
-import { trim, dedent, chopEmptyLinesStart } from '@synstack/str'
-
-const result = trim('  hello  ') // 'hello'
-```
-
-## TypeScript Support
-
-Full TypeScript support with generics and type inference. The library is written in TypeScript and provides type definitions out of the box.
-
-```typescript
-import { str } from '@synstack/str'
-
-// Type inference works automatically
-const result = str('hello')
-  .trim()
-  .split('')
-  .at(0)
-  .$
-
-// result is inferred as string
-```
-
-## License
-
-Apache-2.0
+# @synstack/str
+
+Advanced chainable string manipulation utilities
+
+> [!WARNING]
+> This package is included in the [@synstack/synscript](../synscript/README.md) package. It is not recommended to install both packages at the same time.
+
+## What is it for?
+
+When working with strings in TypeScript, you often need to chain multiple operations like trimming, splitting, case conversion, and indentation management. This package provides a fluent, chainable API for string manipulation with full type safety:
+
+```typescript
+import { str } from "@synstack/str";
+
+// Basic chaining
+const result = str("  Hello World  ").trim().split(" ").at(0).$;
+
+// Case conversion
+const camelCase = str("hello-world").camelCase().$;
+console.log(camelCase); // 'helloWorld'
+
+// Advanced manipulation
+const formatted = str("    some\n  indented\n      text")
+  .trimEmptyLines()
+  .dedent().$;
+
+// Line manipulation
+const lines = str("line1\n\n\n\nline2").chopRepeatNewlines(1).split("\n");
+console.log(lines); // ['line1', 'line2']
+```
+
+## Installation
+
+```bash
+npm install @synstack/str
+# or
+yarn add @synstack/str
+# or
+pnpm add @synstack/str
+```
+
+## Features
+
+### Chainable Operations
+
+All string operations are chainable and maintain type safety:
+
+```typescript
+const result = str("  Hello  World  ").trim().split(" ").at(0).camelCase().$;
+```
+
+### Line Manipulation
+
+Handle multi-line strings with precision:
+
+```typescript
+// Remove empty lines
+str("Hello\n\n\nWorld").chopRepeatNewlines(1).$; // "Hello\nWorld"
+
+// Add line numbers
+str("A\nB\nC").addLineNumbers().$; // "0:A\n1:B\n2:C"
+
+// Trim empty lines and spaces
+str("  \n  Hello  \n  ").trimEmptyLines().$; // "\nHello\n"
+```
+
+### Indentation Control
+
+Manage text indentation with ease:
+
+```typescript
+// Add indentation
+str("Hello\nWorld").indent(2).$; // "  Hello\n  World"
+
+// Remove indentation
+str("  Hello\n    World").dedent().$; // "Hello\n  World"
+
+// Get indentation level
+str("  Hello\n    World").indentation(); // 2
+```
+
+### Case Conversion
+
+Convert between different case styles:
+
+```typescript
+str("hello-world").camelCase().$; // "helloWorld"
+str("hello-world").pascalCase().$; // "HelloWorld"
+str("hello-world").snakeCase().$; // "hello_world"
+str("hello-world").constantCase().$; // "HELLO_WORLD"
+str("hello-world").dotCase().$; // "hello.world"
+str("hello-world").pathCase().$; // "hello/world"
+```
+
+### Utility Functions
+
+All methods from the Str class are also available as standalone functions:
+
+```typescript
+import { trim, dedent, chopEmptyLinesStart } from "@synstack/str";
+
+const result = trim("  hello  "); // 'hello'
+```

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Advanced chainable string manipulation",
   "keywords": [
     "string",
@@ -46,7 +46,7 @@
     }
   },
   "dependencies": {
-    "@synstack/pipe": "1.1.4",
+    "@synstack/pipe": "1.1.5",
     "change-case": "^5.4.4"
   },
   "devDependencies": {
@@ -59,5 +59,5 @@
     "!src/**/*.test.ts",
     "dist/**/*"
   ],
-  "gitHead": "348d1987aba7aee8fbc5469d071e3c71663fc775"
+  "gitHead": "2868de5f8935b959b5b5faa6606a2fa9fcad27ab"
 }