@guanghechen/string 1.0.1 → 2.0.2

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log
+
+## 2.0.2
+
+### Patch Changes
+
+- chore: vitest config auto-load aliases and coverage thresholds; style/doc formatting updates
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 2.0.1 (2025-02-07)
+
+### Improvements
+
+- Enhance type safety and test coverage
+
+### Documentation
+
+- Update README.md
+
+### Miscellaneous
+
+- Add LICENSE file
+- Migrate from lerna to changesets
+
+## 2.0.0 (2025-01-15)
+
+### Features
+
+- Initial stable release: String utilities extracted from @guanghechen/std
+
+### Improvements
+
+- Switch to recommended ESLint stack

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+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.

package/README.md

@@ -1,6 +1,6 @@
 <header>
   <h1 align="center">
-    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/string@1.0.1/packages/string#readme">@guanghechen/string</a>
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/string@2.0.0/packages/string#readme">@guanghechen/string</a>
   </h1>
   <div align="center">
     <a href="https://www.npmjs.com/package/@guanghechen/string">
@@ -21,6 +21,12 @@
         src="https://img.shields.io/npm/l/@guanghechen/string.svg"
       />
     </a>
+    <a href="#install">
+      <img
+        alt="Module Formats: cjs, esm"
+        src="https://img.shields.io/badge/module_formats-cjs%2C%20esm-green.svg"
+      />
+    </a>
     <a href="https://github.com/nodejs/node">
       <img
         alt="Node.js Version"
@@ -43,58 +49,114 @@
 </header>
 <br/>
 
-Utilities for processing strings or stringify other type data.
+String utilities including case transformers, bytes parsers, and number/interval collectors.
 
 ## Install
 
-* npm
+- npm
 
   ```bash
-  npm install --save-dev @guanghechen/string
+  npm install --save @guanghechen/string
   ```
 
-* yarn
+- yarn
 
   ```bash
-  yarn add --dev @guanghechen/string
+  yarn add @guanghechen/string
   ```
 
 ## Usage
 
-* `transformer` utilities
-
-  Name                  | Description
-  :--------------------:|:---------------------------------------
-  `toCamelCase`         | `'test string' => 'testString'`
-  `toCapitalCase`       | `'test string' => 'Test String'`
-  `toConstantCase`      | `'test string' => 'TEST_STRING'`
-  `toDotCase`           | `'test string' => 'test.string'`
-  `toKebabCase`         | `'test string' => 'test-string'`
-  `toLowerCase`         | `'TEST STRING' => 'test string'`
-  `toPascalCase`        | `'test string' => 'TestString'`
-  `toPathCase`          | `'test string' => 'test/string'`
-  `toSentenceCase`      | `'testString' => 'Test string'`
-  `toSnakeCase`         | `'test string' => 'test_string'`
-  `toTitleCase`         | `'a simple test' => 'A Simple Test'`
-  `toUpperCase`         | `'test string' => 'TEST STRING'`
-
-  - `composeTextTransformers`: Compose multiple ITextTransformer into one.
-
-    ```typescript
-    import {
-      composeTextTransformers,
-      toKebabCase,
-      toTrim,
-    } from '@guanghechen/string'
-
-    // function composeTextTransformers (
-    //   ...transformers: ReadonlyArray<ITextTransformer>
-    // ): ITextTransformer
-
-    const transform = composeTextTransformers(toTrim, toKebabCase)
-    const text: string = transform(' TeSt_StrinG ')
-    // => 'test-string'
-    ```
-
-
-[homepage]: https://github.com/guanghechen/sora/tree/@guanghechen/string@1.0.1/packages/string#readme
+### Case Transformers
+
+```typescript
+import {
+  toCamelCase,
+  toKebabCase,
+  toSnakeCase,
+  toPascalCase,
+  toConstantCase,
+  toCapitalCase,
+  toSentenceCase,
+  toTitleCase,
+  toDotCase,
+  toPathCase,
+  composeTextTransformers,
+  toTrim,
+} from '@guanghechen/string'
+
+toCamelCase('test string')     // 'testString'
+toKebabCase('test string')     // 'test-string'
+toSnakeCase('test string')     // 'test_string'
+toPascalCase('test string')    // 'TestString'
+toConstantCase('test string')  // 'TEST_STRING'
+toCapitalCase('test string')   // 'Test String'
+toSentenceCase('testString')   // 'Test string'
+toTitleCase('a simple test')   // 'A Simple Test'
+toDotCase('test string')       // 'test.string'
+toPathCase('test string')      // 'test/string'
+
+// Compose multiple transformers
+const transform = composeTextTransformers(toTrim, toKebabCase)
+transform(' TeSt_StrinG ')     // 'test-string'
+```
+
+### Bytes Parser
+
+```typescript
+import { parseBytesString } from '@guanghechen/string'
+
+parseBytesString('1K')    // 1024
+parseBytesString('1KB')   // 1024
+parseBytesString('1M')    // 1048576
+parseBytesString('1MB')   // 1048576
+parseBytesString('1.5G')  // 1610612736
+parseBytesString('100')   // 100
+parseBytesString('2T')    // 2199023255552
+```
+
+### Number/Interval Collectors
+
+Parse comma/space-separated number ranges:
+
+```typescript
+import { collectNumbers, collectIntervals } from '@guanghechen/string'
+
+// Collect individual numbers from ranges
+collectNumbers('1-3')           // [1, 2, 3]
+collectNumbers('3,1-2,2,2')     // [1, 2, 3]
+collectNumbers('2-4,1-3,5-9')   // [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+// Collect merged intervals
+collectIntervals('1-3')         // [[1, 3]]
+collectIntervals('3,7-5,2,2')   // [[2, 3], [5, 7]]
+collectIntervals('2-4,1-3,6-9') // [[1, 4], [6, 9]]
+
+// Custom separator
+collectNumbers('1;2;3-5', /;/)  // [1, 2, 3, 4, 5]
+```
+
+### Transformer Reference
+
+| Transformer       | Input           | Output          |
+| :---------------: | :-------------: | :-------------: |
+| `toCamelCase`     | 'test string'   | 'testString'    |
+| `toCapitalCase`   | 'test string'   | 'Test String'   |
+| `toConstantCase`  | 'test string'   | 'TEST_STRING'   |
+| `toDotCase`       | 'test string'   | 'test.string'   |
+| `toKebabCase`     | 'test string'   | 'test-string'   |
+| `toLowerCase`     | 'TEST STRING'   | 'test string'   |
+| `toPascalCase`    | 'test string'   | 'TestString'    |
+| `toPathCase`      | 'test string'   | 'test/string'   |
+| `toSentenceCase`  | 'testString'    | 'Test string'   |
+| `toSnakeCase`     | 'test string'   | 'test_string'   |
+| `toTitleCase`     | 'a simple test' | 'A Simple Test' |
+| `toUpperCase`     | 'test string'   | 'TEST STRING'   |
+| `toTrim`          | ' test '        | 'test'          |
+
+## Reference
+
+- [homepage][homepage]
+
+[homepage]:
+  https://github.com/guanghechen/sora/tree/@guanghechen/string@2.0.0/packages/string#readme

package/lib/cjs/index.cjs

@@ -1,5 +1,73 @@
 'use strict';
 
+const bytesUnit = {
+    K: 1024,
+    M: 1024 ** 2,
+    G: 1024 ** 3,
+    T: 1024 ** 4,
+    P: 1024 ** 5,
+};
+const unitKeys = Object.keys(bytesUnit).join('');
+const bytesRegex = new RegExp(`^\\s*(\\d+(?:\\.\\d+)?)([${unitKeys}]B?)?\\s*$`);
+function parseBytesString(text) {
+    const match = bytesRegex.exec(text);
+    if (match) {
+        const [, num, unit] = match;
+        const bytes = Number(num) * (bytesUnit[unit] ?? 1);
+        return Math.max(0, Math.floor(bytes));
+    }
+    return 0;
+}
+
+const intervalRegex = /^(\d+)(?:-(\d+))?$/;
+const defaultSeparator = /[,\s]+/;
+function collectNumbers(text, separator = defaultSeparator) {
+    const intervals = collectIntervals(text, separator);
+    const result = [];
+    for (const interval of intervals) {
+        const [x, y] = interval;
+        for (let i = x; i <= y; ++i)
+            result.push(i);
+    }
+    return result;
+}
+function collectIntervals(text, separator = defaultSeparator) {
+    const intervals = [];
+    const tokens = text.split(new RegExp(separator, 'g'));
+    for (const token of tokens) {
+        const match = intervalRegex.exec(token);
+        if (!match)
+            continue;
+        const [, lft, rht] = match;
+        const x = Number(lft);
+        if (typeof rht !== 'string') {
+            const x = Number(lft);
+            intervals.push([x, x]);
+            continue;
+        }
+        const y = Number(rht);
+        intervals.push(x < y ? [x, y] : [y, x]);
+    }
+    intervals.sort((x, y) => {
+        const d = x[0] - y[0];
+        return d === 0 ? x[1] - y[1] : d;
+    });
+    if (intervals.length <= 1)
+        return intervals;
+    const result = [intervals[0]];
+    for (let i = 1; i < intervals.length; ++i) {
+        const interval = intervals[i];
+        const top = result[result.length - 1];
+        if (top[1] + 1 >= interval[0]) {
+            if (top[1] < interval[1])
+                top[1] = interval[1];
+            continue;
+        }
+        result.push(interval);
+    }
+    return result;
+}
+
 const SPLIT_LOWER_UPPER_RE = /([\p{Ll}\d])(\p{Lu})/gu;
 const SPLIT_UPPER_UPPER_RE = /(\p{Lu})([\p{Lu}][\p{Ll}])/gu;
 const SPLIT_NUMBER_LOWER_RE = /(\d)(\p{Ll})/gu;
@@ -185,7 +253,10 @@ const toTitleCase = text => titleCase(text);
 const toTrim = text => text.trim();
 const toUpperCase = text => text.toLocaleUpperCase();
 
+exports.collectIntervals = collectIntervals;
+exports.collectNumbers = collectNumbers;
 exports.composeTextTransformers = composeTextTransformers;
+exports.parseBytesString = parseBytesString;
 exports.toCamelCase = toCamelCase;
 exports.toCapitalCase = toCapitalCase;
 exports.toConstantCase = toConstantCase;
@@ -199,4 +270,3 @@ exports.toSnakeCase = toSnakeCase;
 exports.toTitleCase = toTitleCase;
 exports.toTrim = toTrim;
 exports.toUpperCase = toUpperCase;
-//# sourceMappingURL=index.cjs.map

package/lib/esm/index.mjs

@@ -1,3 +1,71 @@
+const bytesUnit = {
+    K: 1024,
+    M: 1024 ** 2,
+    G: 1024 ** 3,
+    T: 1024 ** 4,
+    P: 1024 ** 5,
+};
+const unitKeys = Object.keys(bytesUnit).join('');
+const bytesRegex = new RegExp(`^\\s*(\\d+(?:\\.\\d+)?)([${unitKeys}]B?)?\\s*$`);
+function parseBytesString(text) {
+    const match = bytesRegex.exec(text);
+    if (match) {
+        const [, num, unit] = match;
+        const bytes = Number(num) * (bytesUnit[unit] ?? 1);
+        return Math.max(0, Math.floor(bytes));
+    }
+    return 0;
+}
+
+const intervalRegex = /^(\d+)(?:-(\d+))?$/;
+const defaultSeparator = /[,\s]+/;
+function collectNumbers(text, separator = defaultSeparator) {
+    const intervals = collectIntervals(text, separator);
+    const result = [];
+    for (const interval of intervals) {
+        const [x, y] = interval;
+        for (let i = x; i <= y; ++i)
+            result.push(i);
+    }
+    return result;
+}
+function collectIntervals(text, separator = defaultSeparator) {
+    const intervals = [];
+    const tokens = text.split(new RegExp(separator, 'g'));
+    for (const token of tokens) {
+        const match = intervalRegex.exec(token);
+        if (!match)
+            continue;
+        const [, lft, rht] = match;
+        const x = Number(lft);
+        if (typeof rht !== 'string') {
+            const x = Number(lft);
+            intervals.push([x, x]);
+            continue;
+        }
+        const y = Number(rht);
+        intervals.push(x < y ? [x, y] : [y, x]);
+    }
+    intervals.sort((x, y) => {
+        const d = x[0] - y[0];
+        return d === 0 ? x[1] - y[1] : d;
+    });
+    if (intervals.length <= 1)
+        return intervals;
+    const result = [intervals[0]];
+    for (let i = 1; i < intervals.length; ++i) {
+        const interval = intervals[i];
+        const top = result[result.length - 1];
+        if (top[1] + 1 >= interval[0]) {
+            if (top[1] < interval[1])
+                top[1] = interval[1];
+            continue;
+        }
+        result.push(interval);
+    }
+    return result;
+}
+
 const SPLIT_LOWER_UPPER_RE = /([\p{Ll}\d])(\p{Lu})/gu;
 const SPLIT_UPPER_UPPER_RE = /(\p{Lu})([\p{Lu}][\p{Ll}])/gu;
 const SPLIT_NUMBER_LOWER_RE = /(\d)(\p{Ll})/gu;
@@ -183,5 +251,4 @@ const toTitleCase = text => titleCase(text);
 const toTrim = text => text.trim();
 const toUpperCase = text => text.toLocaleUpperCase();
 
-export { composeTextTransformers, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toLowerCase, toPascalCase, toPathCase, toSentenceCase, toSnakeCase, toTitleCase, toTrim, toUpperCase };
-//# sourceMappingURL=index.mjs.map
+export { collectIntervals, collectNumbers, composeTextTransformers, parseBytesString, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toLowerCase, toPascalCase, toPathCase, toSentenceCase, toSnakeCase, toTitleCase, toTrim, toUpperCase };

package/lib/types/index.d.ts

@@ -1,3 +1,40 @@
+/**
+ * Parse texts like 1M, 1Mb, 1G to the number of bytes.
+ *
+ * @param text
+ */
+declare function parseBytesString(text: string): number;
+
+/**
+ * - ''             => []
+ * - '1'            => [1]
+ * - '1-3'          => [1, 2, 3]
+ * - '3,1-2,2,2'    => [1, 2, 3]
+ * - '3,7-5,2,2'    => [2, 3, 5, 6, 7]
+ * - '2,1-3'        => [1, 2, 3]
+ * - '4,1-3'        => [1, 2, 3, 4]
+ * - '2-4,1-3,5-9'  => [1, 2, 3, 4, 5, 6, 7, 8, 9]
+ * - '2-4,1-3,6-9'  => [1, 2, 3, 4, 6, 7, 8, 9]
+ *
+ * @param text
+ */
+declare function collectNumbers(text: string, separator?: RegExp): number[];
+/**
+ * - ''             => []
+ * - '1'            => [[1, 1]]
+ * - '1-3'          => [[1, 3]]
+ * - '3,1-2,2,2'    => [[1, 3]]
+ * - '3,7-5,2,2'    => [[2, 3], [5, 7]]
+ * - '2,1-3'        => [[1, 3]]
+ * - '4,1-3'        => [[1, 4]]
+ * - '2-4,1-3,5-9'  => [[1, 9]]
+ * - '2-4,1-3,6-9'  => [[1, 4], [6, 9]]
+ *
+ * @param text
+ * @returns
+ */
+declare function collectIntervals(text: string, separator?: RegExp): Array<[number, number]>;
+
 /**
  * Text transformer.
  */
@@ -128,5 +165,5 @@ declare const toTrim: ITextTransformer;
  */
 declare const toUpperCase: ITextTransformer;
 
-export { type ITextTransformer, composeTextTransformers, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toLowerCase, toPascalCase, toPathCase, toSentenceCase, toSnakeCase, toTitleCase, toTrim, toUpperCase };
-//# sourceMappingURL=index.d.ts.map
+export { collectIntervals, collectNumbers, composeTextTransformers, parseBytesString, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toLowerCase, toPascalCase, toPathCase, toSentenceCase, toSnakeCase, toTitleCase, toTrim, toUpperCase };
+export type { ITextTransformer };

package/package.json

@@ -1,29 +1,32 @@
 {
   "name": "@guanghechen/string",
-  "version": "1.0.1",
-  "description": "Utilities for processing strings or stringify other type data.",
+  "version": "2.0.2",
+  "description": "String utilities including case transformers and parsers.",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/string@1.0.0",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/string@2.0.0",
     "directory": "packages/string"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/string@1.0.0/packages/string#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/string@2.0.0/packages/string#readme",
   "keywords": [
     "string",
-    "string transformer",
-    "string utils"
+    "case",
+    "camel-case",
+    "kebab-case",
+    "snake-case",
+    "pascal-case"
   ],
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -31,9 +34,6 @@
   "module": "./lib/esm/index.mjs",
   "types": "./lib/types/index.d.ts",
   "license": "MIT",
-  "engines": {
-    "node": ">= 18.0.0"
-  },
   "files": [
     "lib/",
     "!lib/**/*.map",
@@ -42,5 +42,11 @@
     "LICENSE",
     "README.md"
   ],
-  "gitHead": "2723aaa31e8ac85afed5b25760875db429d88563"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}