@nyaomaru/divider 1.0.0 → 1.0.2

package/README.md

@@ -1,17 +1,38 @@
 # Divider
 
+<p align="center">
+    <img src="logo.svg" width="200px" align="center" alt="Divider logo" />
+</p>
+
+<p align="center">
+    <a href="https://www.npmjs.com/package/@nyaomaru/divider">
+        <img src="https://img.shields.io/npm/v/@nyaomaru/divider.svg?sanitize=true" alt="npm version">
+    </a>
+    <a href="https://github.com/nyaomaru/divider/blob/main/LICENSE">
+        <img src="https://img.shields.io/npm/l/@nyaomaru/divider.svg?sanitize=true" alt="License">
+    </a>
+    <a href="https://www.npmjs.com/package/@nyaomaru/divider">
+        <img src="https://img.shields.io/npm/dt/@nyaomaru/divider.svg" alt="npm downloads">
+    </a>
+    <a href="https://github.com/nyaomaru/divider/actions">
+        <img src="https://github.com/nyaomaru/divider/actions/workflows/release.yml/badge.svg" alt="Build Status">
+    </a>
+</p>
+
 A simple utility to divide a `string` or `string[]` based on given indexes or delimiters.
 
 ## 🚀 Installation
 
 ```sh
-pnpm install divider
+pnpm install @nyaomaru/divider
 ```
 
 ## 📖 Usage
 
+### Basic Examples
+
 ```ts
-import divider from 'divider';
+import { divider } from '@nyaomaru/divider';
 
 // Divide a string by index positions
 const helloArray = divider('hello', 1, 3);
@@ -33,13 +54,47 @@ const divideWithMultipleString = divider('hello', 'l');
 const words = ['hello', 'world'];
 const dividedWords = divider(words, 2);
 // [['he', 'llo'], ['wo', 'rld']]
+const dividedWordsWithFlattenOption = divider(words, 2, { flatten: true });
+// ['he', 'llo', 'wo', 'rld']
+```
+
+### Advanced Examples
+
+```ts
+// Mixed usage of indexes and characters
+const complexDivide = divider('hello world', 3, 'o');
+// ['hel', 'l', ' w', 'rld']
+
+// Nested array handling
+const nestedArray = divider(['hello', 'new world'], ' ', 2);
+// [['he', 'llo'], ['ne', 'w wor', 'ld']]
+
+// Flatten option to get a single array
+const flatArray = divider(['hello', 'new world'], ' ', 2, { flatten: true });
+// ['he', 'llo', 'ne', 'w', 'wor', 'ld']
+```
+
+## 🎯 Options
+
+### `flatten` (default: `false`)
+
+If `true`, the resulting nested arrays are flattened into a single array.
+
+```ts
+const words = ['hello', 'world'];
+const result1 = divider(words, 2);
+// [['he', 'llo'], ['wo', 'rld']]
+
+const result2 = divider(words, 2, { flatten: true });
+// ['he', 'llo', 'wo', 'rld']
 ```
 
 ## 💡 Features
 
 - Supports both `index-based` and `string-based` division
 - Works with both `strings` and `arrays of strings`
-- Optional `flattening` for array results
+- Supports `multiple separators` (mixing indexes and characters).
+- Provides an `optional flattening` feature for array results.
 
 ## 🛠 Contributing
 

package/dist/cjs/index.js

@@ -16,44 +16,35 @@ function divideString(input, separators) {
     if (separators.length === 0) {
         return [input];
     }
-    let numSeparators = [];
-    let strSeparators = [];
-    for (const separator of separators) {
-        if (typeof separator === 'number') {
-            numSeparators.push(separator);
-        }
-        else if (typeof separator === 'string') {
-            strSeparators.push(separator);
-        }
-    }
+    const { numSeparators, strSeparators } = separators.reduce((acc, separator) => {
+        typeof separator === 'number'
+            ? acc.numSeparators.push(separator)
+            : acc.strSeparators.push(separator);
+        return acc;
+    }, { numSeparators: [], strSeparators: [] });
+    // Divide by number delimiters
+    let parts = sliceByIndexes(input, numSeparators);
     // Divide by string delimiters
+    if (strSeparators.length) {
+        const regex = new RegExp(`[${strSeparators.join('')}]`, 'g');
+        parts = parts
+            .flatMap((part) => part.split(regex))
+            .filter((part) => part !== '');
+    }
+    return parts;
+}
+function sliceByIndexes(input, indexes) {
+    if (!indexes.length)
+        return [input];
+    indexes.sort((a, b) => a - b);
     let parts = [];
-    let startIndices = [];
-    let currentIndex = 0;
-    input
-        .split(new RegExp(`[${strSeparators.join('')}]`, 'g'))
-        .forEach((part) => {
-        if (part) {
-            parts.push(part);
-            startIndices.push(currentIndex);
-        }
-        currentIndex += part.length + 1;
-    });
-    // Divide by number delimiters
-    const sortedNumSeparators = [...new Set(numSeparators)].sort((a, b) => a - b);
-    let finalParts = [];
-    for (let i = 0; i < parts.length; i++) {
-        const part = parts[i];
-        const partStart = startIndices[i];
-        let prevIndex = 0;
-        const localSeparators = sortedNumSeparators
-            .filter((num) => num > partStart && num < partStart + part.length)
-            .map((num) => num - partStart);
-        for (const index of localSeparators) {
-            finalParts.push(part.slice(prevIndex, index));
-            prevIndex = index;
+    let start = 0;
+    for (const index of indexes) {
+        if (index > start && index < input.length) {
+            parts.push(input.slice(start, index));
+            start = index;
         }
-        finalParts.push(part.slice(prevIndex));
     }
-    return finalParts;
+    parts.push(input.slice(start));
+    return parts.filter((part) => part !== '');
 }

package/dist/esm/index.js

@@ -13,44 +13,35 @@ function divideString(input, separators) {
     if (separators.length === 0) {
         return [input];
     }
-    let numSeparators = [];
-    let strSeparators = [];
-    for (const separator of separators) {
-        if (typeof separator === 'number') {
-            numSeparators.push(separator);
-        }
-        else if (typeof separator === 'string') {
-            strSeparators.push(separator);
-        }
-    }
+    const { numSeparators, strSeparators } = separators.reduce((acc, separator) => {
+        typeof separator === 'number'
+            ? acc.numSeparators.push(separator)
+            : acc.strSeparators.push(separator);
+        return acc;
+    }, { numSeparators: [], strSeparators: [] });
+    // Divide by number delimiters
+    let parts = sliceByIndexes(input, numSeparators);
     // Divide by string delimiters
+    if (strSeparators.length) {
+        const regex = new RegExp(`[${strSeparators.join('')}]`, 'g');
+        parts = parts
+            .flatMap((part) => part.split(regex))
+            .filter((part) => part !== '');
+    }
+    return parts;
+}
+function sliceByIndexes(input, indexes) {
+    if (!indexes.length)
+        return [input];
+    indexes.sort((a, b) => a - b);
     let parts = [];
-    let startIndices = [];
-    let currentIndex = 0;
-    input
-        .split(new RegExp(`[${strSeparators.join('')}]`, 'g'))
-        .forEach((part) => {
-        if (part) {
-            parts.push(part);
-            startIndices.push(currentIndex);
-        }
-        currentIndex += part.length + 1;
-    });
-    // Divide by number delimiters
-    const sortedNumSeparators = [...new Set(numSeparators)].sort((a, b) => a - b);
-    let finalParts = [];
-    for (let i = 0; i < parts.length; i++) {
-        const part = parts[i];
-        const partStart = startIndices[i];
-        let prevIndex = 0;
-        const localSeparators = sortedNumSeparators
-            .filter((num) => num > partStart && num < partStart + part.length)
-            .map((num) => num - partStart);
-        for (const index of localSeparators) {
-            finalParts.push(part.slice(prevIndex, index));
-            prevIndex = index;
+    let start = 0;
+    for (const index of indexes) {
+        if (index > start && index < input.length) {
+            parts.push(input.slice(start, index));
+            start = index;
         }
-        finalParts.push(part.slice(prevIndex));
     }
-    return finalParts;
+    parts.push(input.slice(start));
+    return parts.filter((part) => part !== '');
 }

package/logo.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><svg id="_レイヤー_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 202.68 226.44"><defs><style>.cls-1{fill:#8ff476;}.cls-2{fill:#fff;}</style></defs><path class="cls-2" d="M5.99,196.51h12.52c9.24,0,14.75,4.83,14.75,12.48,0,10.56-7.57,17.45-18.64,17.45H0l5.99-29.93ZM14.84,220.76c7.18,0,11.42-4.88,11.42-11.38,0-4.44-2.87-7.18-8.51-7.18h-5.95l-3.72,18.56h6.76Z"/><path class="cls-2" d="M42.62,196.51h6.97l-5.99,29.93h-6.97l5.99-29.93Z"/><path class="cls-2" d="M88.39,196.51l-18.94,29.93h-6.8l-6.97-29.93h7.14l4.83,21.34,13.55-21.34h7.18Z"/><path class="cls-2" d="M94.73,196.51h6.97l-5.99,29.93h-6.97l5.99-29.93Z"/><path class="cls-2" d="M110.9,196.51h12.52c9.24,0,14.75,4.83,14.75,12.48,0,10.56-7.57,17.45-18.64,17.45h-14.62l5.99-29.93ZM119.74,220.76c7.18,0,11.42-4.88,11.42-11.38,0-4.44-2.87-7.18-8.51-7.18h-5.95l-3.72,18.56h6.76Z"/><path class="cls-2" d="M153.71,202.07l-1.28,6.5h13.9l-1.06,5.39h-13.94l-1.37,6.93h16.33l-1.15,5.56h-23.17l5.99-29.93h22.62l-1.16,5.56h-15.69Z"/><path class="cls-2" d="M194.13,217.2l5.21,9.24h-7.31l-4.7-8.38h-5.9l-1.67,8.38h-6.97l5.99-29.93h12.18c7.44,0,11.72,3.42,11.72,9.28s-3.21,9.75-8.55,11.41ZM195.67,206.43c0-2.91-2.05-4.27-5.6-4.27h-5.47l-2.09,10.39h5.9c4.57,0,7.27-2.14,7.27-6.12Z"/><polygon class="cls-1" points="186.42 3.89 135.99 168.36 106.58 168.36 106.58 168.46 54.61 168.46 54.61 161.35 87 161.35 160.49 0 170.69 11.22 186.42 3.89"/></svg>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nyaomaru/divider",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "To divide string or string[] with a given separator",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -22,7 +22,8 @@
     "dist",
     "README.md",
     "package.json",
-    "LICENSE"
+    "LICENSE",
+    "logo.svg"
   ],
   "repository": {
     "type": "git",