stringzy 2.2.1 → 3.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org/'
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Run tests
+        run: npm test
+      - name: Publish package
+        if: success()
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test-on-pr.yml

@@ -0,0 +1,23 @@
+name: Run Tests on Pull Request
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Run tests
+        run: npm test

package/CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to Stringzy
+Thanks for your interest in contributing to Stringzy! This document provides guidelines and instructions for contributing to the project.
+
+## What We're Looking For
+- **Bug fixes** - Help us solve issues
+- **New string functions** - Add useful string manipulation methods
+- **Documentation** - Improve examples and guides
+- **Tests** - Add test coverage for existing or new features
+
+## Development Guide
+
+### Setup
+1. Fork the repository
+2. Clone your fork:
+    _Remember to replace `YOUR-USERNAME` with your actual GitHub username._
+    ```bash
+    git clone https://github.com/YOUR-USERNAME/stringzy.git
+    ```
+
+3. Navigate to the project directory:
+    ```bash
+    cd stringzy
+    ```
+
+4. Install dependencies:
+    ```bash
+    npm install
+    ```
+
+
+### Making Changes
+- Create a new branch:
+    ```bash
+    git checkout -b feature/amazing-feature
+    ```
+- Make your changes
+- Write tests for new functions
+- Keep functions simple and focused
+- Follow existing code style
+- Update README if adding new functions
+
+### Code Style
+- Use 2 spaces for indentation
+- Add JSDoc comments for new functions
+- Handle edge cases (null, undefined, empty strings)
+- Use descriptive function names
+
+Example:
+```ts
+/**
+ * Converts string to kebab-case
+ * @param str Input string
+ * @returns Kebab-case string
+ */
+function toKebabCase(str: string): string {
+  if (!str) return '';
+  return str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+}
+```
+
+## Submitting Changes
+1. Make sure tests pass: 
+    ```bash
+    npm test
+    ```
+
+2. Commit your changes: 
+    ```bash
+    git commit -m "feat: add some amazing feature"
+    ```
+
+3. Push to the branch
+    ```bash
+    git push origin feature/amazing-feature
+    ```
+
+4. Create a pull request with:
+    - Clear description of changes
+    - Why the change is needed
+    - Any breaking changes
+
+## Questions?
+If you have any questions or need help, feel free to open an issue. We're happy to help!
+
+---
+
+By contributing, you agree to license your work under the same license as this project. 

package/LICENSE

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