@nyaomaru/divider 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 @nyaomaru
+
+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

@@ -0,0 +1,64 @@
+# Divider
+
+A simple utility to divide a `string` or `string[]` based on given indexes or delimiters.
+
+## 🚀 Installation
+
+```sh
+pnpm install divider
+```
+
+## 📖 Usage
+
+```ts
+import divider from 'divider';
+
+// Divide a string by index positions
+const helloArray = divider('hello', 1, 3);
+// ['h', 'el', 'lo']
+
+const [hello1, hello2, ...restHello] = divider('hello', 1, 3, 4);
+// hello1 = 'h'
+// hello2 = 'el'
+// restHello = ['l', 'o']
+
+// Divide a string using a character separator
+const divideWithString = divider('hello', 'e');
+// ['h', 'llo']
+
+const divideWithMultipleString = divider('hello', 'l');
+// ['he', 'o']
+
+// Divide an array of strings
+const words = ['hello', 'world'];
+const dividedWords = divider(words, 2);
+// [['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
+
+## 🛠 Contributing
+
+Welcome your contributions! If you want to add features or fix issues, feel free to submit a PR!
+
+### Setup
+
+```sh
+pnpm install
+```
+
+### Test
+
+```sh
+pnpm test
+```
+
+### Contribution Guidelines
+
+- If you add new functions, please add corresponding tests in the `tests` directory.
+- No strict rules—just keep it clean and readable!
+- Thank you for your contribution. 😺

package/dist/cjs/index.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.divider = divider;
+function divider(input, ...args) {
+    // extract the options from the input
+    const lastArg = args[args.length - 1];
+    const options = typeof lastArg === 'object' ? args.pop() : {};
+    const separators = args;
+    if (typeof input === 'string') {
+        return divideString(input, separators);
+    }
+    const result = input.map((item) => divideString(item, separators));
+    return options.flatten ? result.flat() : result;
+}
+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);
+        }
+    }
+    // Divide by string delimiters
+    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;
+        }
+        finalParts.push(part.slice(prevIndex));
+    }
+    return finalParts;
+}

package/dist/esm/index.js

@@ -0,0 +1,56 @@
+export function divider(input, ...args) {
+    // extract the options from the input
+    const lastArg = args[args.length - 1];
+    const options = typeof lastArg === 'object' ? args.pop() : {};
+    const separators = args;
+    if (typeof input === 'string') {
+        return divideString(input, separators);
+    }
+    const result = input.map((item) => divideString(item, separators));
+    return options.flatten ? result.flat() : result;
+}
+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);
+        }
+    }
+    // Divide by string delimiters
+    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;
+        }
+        finalParts.push(part.slice(prevIndex));
+    }
+    return finalParts;
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export declare function divider(input: string | string[], ...args: (number | string | {
+    flatten?: boolean;
+})[]): string[] | string[][];

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@nyaomaru/divider",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "To divide string or string[] with a given separator",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "keywords": [
+    "divider",
+    "divide",
+    "split",
+    "string",
+    "array"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "package.json",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nyaomaru/divider.git"
+  },
+  "homepage": "https://github.com/nyaomaru/divider.git",
+  "author": "nyaomaru",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.4",
+    "eslint": "^9.20.1",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint .",
+    "build": "tsc --module ESNext --outDir dist/esm && tsc --module CommonJS --outDir dist/cjs"
+  }
+}