docs: revamp README and add CONTRIBUTING.md (v1.2.1)

- Completely revamped README with cleaner structure and API tables
- Added CONTRIBUTING.md for contributor guidelines
- Removed codemagic badge
- Code formatting improvements

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Author: Chinmay-KB

CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.2.1] - 2025
+
+### Documentation
+* Revamped README with cleaner structure and API tables
+* Added CONTRIBUTING.md for contributors
+* Removed codemagic badge
+
+### Code Quality
+* Code formatting improvements across source files
+
 ## [1.2.0] - 2025
 
 ### New Features

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to stringr
+
+Thank you for your interest in contributing to stringr! This document provides guidelines for contributing.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/stringr.git`
+3. Install dependencies: `dart pub get`
+4. Run tests: `dart test`
+
+## Development Workflow
+
+### Making Changes
+
+1. Create a feature branch: `git checkout -b feature/your-feature`
+2. Make your changes
+3. Run tests: `dart test`
+4. Run analysis: `dart analyze`
+5. Commit your changes with a descriptive message
+
+### Code Style
+
+- Follow the [Dart style guide](https://dart.dev/guides/language/effective-dart/style)
+- Run `dart format .` before committing
+- Ensure `dart analyze` passes with no issues
+
+### Testing
+
+- Add tests for new features
+- Ensure all existing tests pass
+- Test with both Latin and non-Latin strings when applicable
+
+### Commit Messages
+
+Use clear, descriptive commit messages:
+- `feat: add new method for X`
+- `fix: handle edge case in Y`
+- `docs: update README examples`
+- `refactor: improve performance of Z`
+
+## Pull Request Process
+
+1. Ensure all tests pass
+2. Update documentation if needed
+3. Update CHANGELOG.md with your changes
+4. Submit a pull request with a clear description
+
+## Reporting Issues
+
+When reporting issues, please include:
+- Dart/Flutter version
+- Minimal code to reproduce the issue
+- Expected vs actual behavior
+
+## Questions?
+
+Feel free to open an issue for questions or discussions.

README.md

@@ -1,88 +1,122 @@
-# stringr 🧵
+# stringr
 
-String manipulation in dart/flutter on steroids! ⚡⚡
-This dart plugin is null safety compliant 😎😎
-
-![codecov](https://codecov.io/gh/Chinmay-KB/stringr/branch/master/graph/badge.svg?token=UIWY4OF2TE)
-![codemagic](https://api.codemagic.io/apps/5fecda726b96ea001cebef4a/flutter-package/status_badge.svg)
+[![pub package](https://img.shields.io/pub/v/stringr.svg)](https://pub.dev/packages/stringr)
+[![codecov](https://codecov.io/gh/Chinmay-KB/stringr/branch/master/graph/badge.svg?token=UIWY4OF2TE)](https://codecov.io/gh/Chinmay-KB/stringr)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
+A comprehensive string manipulation library for Dart and Flutter. Inspired by [VocaJS](https://vocajs.com/), stringr provides powerful string operations that work seamlessly with Latin, non-Latin, and Unicode strings.
 
-This dart plugin is inspired 🧠 by [Voca js](https://vocajs.com/#) library. This plugin includes all the nifty functions required for powerful string manipulations. 
+## Features
 
-How powerful? Glad you asked!!
+- **Case Conversion** - camelCase, snake_case, kebab-case, Title Case, PascalCase
+- **Unicode Support** - Full support for non-Latin scripts, diacritics, and grapheme clusters
+- **Smart Word Detection** - Uses regex patterns instead of simple whitespace splitting
+- **Null Safety** - Fully null-safe and compatible with Dart 3.0+
+- **Zero Dependencies** - Only depends on the `characters` package for grapheme support
 
-This plugin works on both latin and non latin strings, and uses complex regular expressions to extract words from strings on manipulations, rather than just calling `split(" ")` on a string.
-```dart
+## Installation
 
-import 'package:stringr/stringr.dart';
+Add to your `pubspec.yaml`:
 
-void main(){
- print("camel case".camelCase()); // Output - "camelCase"
- print("HTMLview".camelCase(preserveAcronym=true)); // Output - "HTMLView"
- print("/this/is/a/directory".camelCase()); // Output - "thisIsADirectory"
- print("полет птицы".kebabCase()); // Output - "полет_птицы"
- print("La variété la plus fréquente est la blanche".prune(12)); // Output - La variété
-print("2infinity*@#@AND93beyond".words()); // Output - ["2", "infinity", "AND", "93", "beyond"]
- print("gravity".words(pattern: r"\w{1,2}")); // Output - ['gr', 'av', 'it', 'y']
-}
- 
+```yaml
+dependencies:
+  stringr: ^1.2.0
 ```
-Convert a string to its latin counterpart! Can reverse not only pure strings, but strings with grapheme clusters as well😎
 
-```dart
-
-import 'package:stringr/stringr.dart';
-
-void main(){
-print("cafe\u0301".latinize()); // Output - cafe
-print("anglikonų šiurkščios užrašinėti".latinize());// Output - 'anglikonu siurkscios uzrasineti'
-print("𝌆 bar mañana mañana".reverse()); // Output - 'anañam anañam rab 𝌆'
-// Splitting and reversing normally would give this as output
-// anãnam anañam rab ��
-}
- 
-```
-Support for graphemes is also included in this plugin. [characters](https://pub.dev/packages/characters) plugin is used to facilitate some of the functionalities.
+## Quick Start
 
 ```dart
-
 import 'package:stringr/stringr.dart';
 
-void main(){
- print("cafe\u0301".countGrapheme()); // Output - 4
- print("\uD835\uDC00\uD835\uDC01".countGrapheme()); // Output - 2
- print("\uD835\uDC00\uD835\uDC01".graphemeAt(1)); // Output - "\uD835\uDC01"
-print("stellar bomb".codePoints()); // Output - [0x73, 0x74, 0x65, 0x6c, 0x6c, 0x61, 0x72, 0x20, 0x62, 0x6f, 0x6d, 0x62]
- print('man\u0303ana'.graphemes()); // Output - ['m','a', 'n\u0303', 'a', 'n', 'a']
+void main() {
+  // Case conversions
+  print('hello world'.toCamelCase);        // helloWorld
+  print('hello world'.toSnakeCase);        // hello_world
+  print('hello world'.toKebabCase);        // hello-world
+  print('hello world'.toPascalCase);       // HelloWorld
+
+  // Smart word extraction
+  print('XMLHttpRequest'.camelCase());     // xmlHttpRequest
+  print('/path/to/file'.camelCase());      // pathToFile
+  print('2infinity&beyond'.words());       // [2, infinity, beyond]
 }
- 
 ```
-HTML strings can be escaped!
 
-```dart
+## Unicode & Non-Latin Support
 
-import 'package:stringr/stringr.dart';
+stringr shines with complex Unicode strings:
 
-void main(){
-print('<>&"\'`'.escapeHTML()); // Output - '&lt;&gt;&amp;&quot;&#x27;&#x60;'
-print('<p>wonderful world</p>'.escapeHTML());// Output - '&lt;p&gt;wonderful world&lt;/p&gt;'
-}
- 
-```
-You can count on stringr to count the words, latin, non latin, or strings with grapheme clusters!
 ```dart
+// Non-Latin scripts
+print('полет птицы'.kebabCase());          // полет-птицы
+print('La variété française'.prune(12));   // La variété
 
-import 'package:stringr/stringr.dart';
+// Diacritics and latinization
+print('café'.latinize());                  // cafe
+print('anglikonų šiurkščios'.latinize());  // anglikonu siurkscios
 
-void main(){
-print("a year without rain".count()); // Output - 19
-print("foo\uD834\uDF06\u0303\u035C\u035D\u035Ebar".countGrapheme());// Output - 7
-print("to be or not to be".countOccurences("to")); // Output - 2
-print("aBCdeFgH".countWhere((character) => character.isAlphabet())); // Output - 8
-print("NewYork".countWords()); // Output - 2
-}
- 
+// Grapheme-aware operations
+print('café'.countGrapheme());             // 4 (not 5!)
+print('👨‍👩‍👧‍👦'.reverse());                      // 👨‍👩‍👧‍👦 (family emoji stays intact)
 ```
-* Some of the functionalities, like `char()` and `codePoints` are either simple enough to implement or were available in the characters package. But still I decided to add them to make bundle everything under a similar syntax ( i.e- calling the extension functions on string). 
-* For functions like `padLeft()` and `trim()` which already are extension functions and inbuilt in dart, I have not included them in this plugin as the syntax would be similar to that of this plugin.
+
+## API Overview
+
+### Case Manipulation
+| Method | Description | Example |
+|--------|-------------|---------|
+| `camelCase()` | Convert to camelCase | `'foo bar'` → `'fooBar'` |
+| `snakeCase()` | Convert to snake_case | `'foo bar'` → `'foo_bar'` |
+| `kebabCase()` | Convert to kebab-case | `'foo bar'` → `'foo-bar'` |
+| `titleCase()` | Capitalize each word | `'foo bar'` → `'Foo Bar'` |
+| `capitalize()` | Capitalize first char | `'foo'` → `'Foo'` |
+| `swapCase()` | Toggle case | `'FoO'` → `'fOo'` |
+
+### String Chopping
+| Method | Description | Example |
+|--------|-------------|---------|
+| `truncate(n)` | Truncate to n chars | `'hello world'` → `'hello...'` |
+| `prune(n)` | Truncate without breaking words | `'hello world'` → `'hello'` |
+| `first(n)` | Get first n chars | `'hello'` → `'hel'` |
+| `last(n)` | Get last n chars | `'hello'` → `'llo'` |
+| `slice(start, end)` | Extract substring | `'hello'` → `'ell'` |
+
+### Counting
+| Method | Description | Example |
+|--------|-------------|---------|
+| `countGrapheme()` | Count visible characters | `'café'` → `4` |
+| `countOccurrences(s)` | Count substring occurrences | `'banana'.countOccurrences('a')` → `3` |
+| `countWords()` | Count words | `'hello world'` → `2` |
+| `countWhere(fn)` | Count matching chars | Custom predicate |
+
+### Manipulation
+| Method | Description | Example |
+|--------|-------------|---------|
+| `reverse()` | Reverse (grapheme-aware) | `'hello'` → `'olleh'` |
+| `slugify()` | URL-friendly slug | `'Hello World!'` → `'hello-world'` |
+| `latinize()` | Remove diacritics | `'café'` → `'cafe'` |
+| `insert(s, i)` | Insert at position | `'hllo'.insert('e', 1)` → `'hello'` |
+
+### Escaping
+| Method | Description |
+|--------|-------------|
+| `escapeHtml()` | Escape HTML entities |
+| `unescapeHtml()` | Unescape HTML entities |
+| `escapeRegExp()` | Escape regex special chars |
+
+## Why stringr?
+
+Most string libraries fail with complex Unicode. stringr handles:
+
+- **Grapheme clusters**: `'café'` is 4 characters, not 5
+- **Surrogate pairs**: Emoji and special symbols work correctly
+- **Non-Latin scripts**: Cyrillic, Greek, accented Latin, and more
+- **Smart word detection**: `'XMLHttpRequest'` → `['XML', 'Http', 'Request']`
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

lib/src/case/case.dart

@@ -33,7 +33,8 @@ extension Case on String {
   ///
   /// If [decapitalizeAll] is set to `true`, the whole string is converted to
   /// lowercase. It is set to `false` by default
-  String decapitalize({bool decapitalizeAll = false}) => switch (decapitalizeAll) {
+  String decapitalize({bool decapitalizeAll = false}) =>
+      switch (decapitalizeAll) {
         true => toLowerCase(),
         false => isEmpty ? '' : this[0].toLowerCase() + substring(1),
       };

lib/src/chop/chop.dart

@@ -62,6 +62,5 @@ extension Chop on String {
   String truncate(int truncateLength, {String endString = "..."}) =>
       truncateLength >= length
           ? this
-          : slice(0,truncateLength - endString.length) +
-              endString;
+          : slice(0, truncateLength - endString.length) + endString;
 }

lib/src/escape/escape.dart

@@ -49,8 +49,7 @@ extension Escape on String {
   /// Return the unescaped version of a regex-escaped string
   ///
   /// Removes escape sequences: `\\x` becomes `x`
-  String unescapeRegExp() =>
-      replaceAll(r'\\', r'\').replaceAll(r'\', '');
+  String unescapeRegExp() => replaceAll(r'\\', r'\').replaceAll(r'\', '');
 
   /// Return the un-escaped version of a regex
   @Deprecated('Use unescapeRegExp instead (corrected implementation)')

lib/src/manipulate/manipulate.dart

@@ -18,8 +18,7 @@ extension Manipulate on String {
   String latinize() => String.fromCharCodes(replaceCodeUnits(codeUnits));
 
   /// Reverses a string. Works with strings containing graphemes
-  String reverse() =>
-      characters.split(''.characters).toList().reversed.join();
+  String reverse() => characters.split(''.characters).toList().reversed.join();
 
   /// Slugifies the string and replaces diacritics with corresponding latin
   /// characters
@@ -66,13 +65,12 @@ extension Manipulate on String {
     return translated;
   }
 
-  // / Wraps a string to a given number of characters using a string break 
+  // / Wraps a string to a given number of characters using a string break
   // / character
-  // / 
-  // / [width] is the number of characters to wrap at. [newLine] is the string 
+  // /
+  // / [width] is the number of characters to wrap at. [newLine] is the string
   // / added at the end of a line. [indent] is the string used to indent the line.
-  // / When [cut] is `false`(default), it does not split the word even if the 
-  // / word length is bigger than `width`. When `true`, words having bigger 
+  // / When [cut] is `false`(default), it does not split the word even if the
+  // / word length is bigger than `width`. When `true`, words having bigger
   // / length than `width` are broken.
-  
-}
+}

lib/src/util/object/extended_iterable.dart

@@ -11,4 +11,4 @@ extension ExtendedIterable<E> on Iterable<E> {
     var i = 0;
     forEach((e) => f(e, i++));
   }
-}
+}

lib/src/util/regex/const_regex.dart

@@ -18,7 +18,8 @@ const upperCaseLetter =
     '\x41-\x5a\xc0-\xd6\xd8-\xde\u0100\u0102\u0104\u0106\u0108\u010a\u010c\u010e\u0110\u0112\u0114\u0116\u0118\u011a\u011c\u011e\u0120\u0122\u0124\u0126\u0128\u012a\u012c\u012e\u0130\u0132\u0134\u0136\u0139\u013b\u013d\u013f\u0141\u0143\u0145\u0147\u014a\u014c\u014e\u0150\u0152\u0154\u0156\u0158\u015a\u015c\u015e\u0160\u0162\u0164\u0166\u0168\u016a\u016c\u016e\u0170\u0172\u0174\u0176\u0178\u0179\u017b\u017d\u0181\u0182\u0184\u0186\u0187\u0189-\u018b\u018e-\u0191\u0193\u0194\u0196-\u0198\u019c\u019d\u019f\u01a0\u01a2\u01a4\u01a6\u01a7\u01a9\u01ac\u01ae\u01af\u01b1-\u01b3\u01b5\u01b7\u01b8\u01bc\u01c4\u01c5\u01c7\u01c8\u01ca\u01cb\u01cd\u01cf\u01d1\u01d3\u01d5\u01d7\u01d9\u01db\u01de\u01e0\u01e2\u01e4\u01e6\u01e8\u01ea\u01ec\u01ee\u01f1\u01f2\u01f4\u01f6-\u01f8\u01fa\u01fc\u01fe\u0200\u0202\u0204\u0206\u0208\u020a\u020c\u020e\u0210\u0212\u0214\u0216\u0218\u021a\u021c\u021e\u0220\u0222\u0224\u0226\u0228\u022a\u022c\u022e\u0230\u0232\u023a\u023b\u023d\u023e\u0241\u0243-\u0246\u0248\u024a\u024c\u024e';
 
 /// Regular expression to match Unicode words
-const regexpWord = '(?:[$upperCaseLetter][$diacriticalMark]*)?(?:[$lowerCaseLetter][$diacriticalMark]*)+|(?:[$upperCaseLetter][$diacriticalMark]*)+(?![$lowerCaseLetter])|[$digit]+|[$dingbatBlock]|[^$nonCharacter$generalPunctuationBlock$whitespace]+';
+const regexpWord =
+    '(?:[$upperCaseLetter][$diacriticalMark]*)?(?:[$lowerCaseLetter][$diacriticalMark]*)+|(?:[$upperCaseLetter][$diacriticalMark]*)+(?![$lowerCaseLetter])|[$digit]+|[$dingbatBlock]|[^$nonCharacter$generalPunctuationBlock$whitespace]+';
 
 /// Regular expression to match words from Basic Latin and Latin-1 Supplement blocks
 const regexpLatinWord =
@@ -27,12 +28,14 @@ const regexpLatinWord =
 /// Regular expression to match alpha characters
 ///
 /// @see http://stackoverflow.com/a/22075070/1894471
-final regexpAlpha = RegExp('^(?:[$lowerCaseLetter$upperCaseLetter][$diacriticalMark]*)+\$');
+final regexpAlpha =
+    RegExp('^(?:[$lowerCaseLetter$upperCaseLetter][$diacriticalMark]*)+\$');
 
 /// Regular expression to match alpha and digit characters
 ///
 /// @see http://stackoverflow.com/a/22075070/1894471
-final regexpAlphaDigit = RegExp('^((?:[$lowerCaseLetter$upperCaseLetter][$diacriticalMark]*)|[$digit])+\$');
+final regexpAlphaDigit = RegExp(
+    '^((?:[$lowerCaseLetter$upperCaseLetter][$diacriticalMark]*)|[$digit])+\$');
 
 /// Regular expression to match Extended ASCII characters, i.e. the first 255
-const regexpExtendedAscii = r'^[\x01-\xFF]*$';
+const regexpExtendedAscii = r'^[\x01-\xFF]*$';

pubspec.yaml

@@ -1,6 +1,6 @@
 name: stringr
 description: Comprehensive string manipulation plugin for dart. Handles operations on latin, non latin and grapheme clusters alike! Features inspured from VocaJs
-version: 1.2.0
+version: 1.2.1
 homepage: https://github.com/Chinmay-KB/stringr
 
 environment: