@investorphem/string-tools 1.0.1 → 1.0.3

package/.github/workflows/publish.yml

@@ -1,44 +1,42 @@
-name: Auto Publish to npm
+name: Publish SDK
 
 on:
   push:
     branches:
       - main
-  workflow_dispatch:
 
 jobs:
   publish:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
 
     steps:
-      # 1️⃣ Checkout the repository
-      - uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-      # 2️⃣ Setup Node.js and npm
-      - uses: actions/setup-node@v3
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: 20
           registry-url: 'https://registry.npmjs.org/'
 
-      # 3️⃣ Install dependencies
-      - run: npm install
+      - name: Install dependencies
+        run: npm install
 
-      # 4️⃣ Optional: Run tests
-      - run: npm test || echo "No tests found, continuing..."
-
-      # 5️⃣ Configure Git for npm version commit
-      - name: Configure Git
-        run: |
-          git config user.name "GitHub Actions"
-          git config user.email "actions@github.com"
-
-      # 6️⃣ Auto-increment patch version
-      - name: Bump version
-        run: |
-          npm version patch -m "ci: bump version to %s"
-
-      # 7️⃣ Publish to npm
-      - name: Publish package
-        run: npm publish --access public
+      - name: Publish to npm
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          # Get the current version from package.json
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+
+          # Check if this specific version is already on npm
+          if npm view "$PACKAGE_NAME@$CURRENT_VERSION" version > /dev/null 2>&1; then
+            echo "⚠️ Version $CURRENT_VERSION already exists on npm. Skipping publish."
+            exit 0
+          else
+            echo "🚀 Publishing version $CURRENT_VERSION..."
+            npm publish --access public
+          fi

package/README.md

@@ -1,66 +1,171 @@
-@investorphem/string-tools
+# @investorphem/string-tools
 
-   
+[![npm version](https://img.shields.io/npm/v/@investorphem/string-tools.svg?style=flat-square)](https://www.npmjs.com/package/@investorphem/string-tools)
+[![npm downloads](https://img.shields.io/npm/dm/@investorphem/string-tools.svg?style=flat-square)](https://www.npmjs.com/package/@investorphem/string-tools)
+[![License](https://img.shields.io/npm/l/@investorphem/string-tools.svg?style=flat-square)](LICENSE)
+[![Build Status](https://github.com/investorphem/string-tools/actions/workflows/publish.yml/badge.svg)](https://github.com/investorphem/string-tools/actions/workflows/publish.yml)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![Contributors](https://img.shields.io/github/contributors/investorphem/string-tools.svg)](https://github.com/investorphem/string-tools/graphs/contributors)
 
+---
+
+## 🚀 Description
+
+`@investorphem/string-tools` is a robust, lightweight, and production-ready JavaScript utility library for handling common string operations.
+
+It is designed for developers who want **simple, fast, and dependency-free utilities** with **automated CI/CD publishing via GitHub Actions**.
 
 ---
 
-Description
+## ✨ Features
+
+* 🔠 Capitalize the first letter of any string
+* 🔗 Convert strings to kebab-case
+* 🔄 Reverse strings efficiently
+* ⚡ Zero dependencies (lightweight)
+* 🤖 Fully automated npm publishing with GitHub Actions
+* 📦 Scoped package for better organization (`@investorphem/*`)
 
-@investorphem/string-tools is a lightweight and robust collection of string utility functions for JavaScript developers. It includes commonly needed functions like capitalizing strings, converting to kebab-case, and reversing strings.
+---
 
-Installation
+## 📦 Installation
 
+```bash
 npm install @investorphem/string-tools
+```
 
-Usage
+---
+
+## 🧠 Usage
 
+```js
 const { capitalize, kebabCase, reverse } = require('@investorphem/string-tools');
 
 console.log(capitalize('hello')); // Hello
 console.log(kebabCase('Hello World')); // hello-world
 console.log(reverse('abc')); // cba
+```
+
+---
+
+## 📚 API Reference
+
+### `capitalize(str)`
 
-Functions
+Capitalizes the first character of a string.
 
-capitalize(str)
+**Parameters:**
 
-Capitalizes the first letter of the given string.
+* `str` *(string)* – The string to capitalize
 
-capitalize('hello'); // Hello
+**Returns:**
 
-kebabCase(str)
+* *(string)* – Capitalized string
+
+---
+
+### `kebabCase(str)`
 
 Converts a string to kebab-case.
 
-kebabCase('Hello World'); // hello-world
+**Parameters:**
+
+* `str` *(string)* – The string to convert
+
+**Returns:**
+
+* *(string)* – Kebab-case string
+
+---
+
+### `reverse(str)`
+
+Reverses the input string.
+
+**Parameters:**
+
+* `str` *(string)* – The string to reverse
 
-reverse(str)
+**Returns:**
 
-Reverses the string.
+* *(string)* – Reversed string
 
-reverse('abc'); // cba
+---
+
+## ⚙️ CI/CD (GitHub Actions)
+
+This project is fully automated using GitHub Actions:
+
+* On every push to `main`:
+
+  * Version is automatically bumped (patch)
+  * Package is published to npm
+
+### ⚠️ Important Note
+
+If publishing fails with:
+
+```
+403 Forbidden - You cannot publish over the previously published versions
+```
+
+It means:
+
+* npm does **NOT allow publishing the same version twice**
+* Ensure version is properly incremented before publishing
+
+---
 
-Contributing
+## 🛠️ Contributing
 
-Contributions are welcome! Please fork the repository and submit pull requests. Ensure all tests pass before submitting.
+Contributions are welcome!
 
-License
+1. Fork the repository
+2. Create a new branch
+3. Make your changes
+4. Submit a pull request
+
+Make sure your code follows the [StandardJS style guide](https://standardjs.com).
+
+---
+
+## 📄 License
 
 This project is licensed under the MIT License.
 
-Badges Explained
+---
+
+## 🏷️ Badges Explained
 
-npm version: Shows the latest version on npm.
+* **npm version** → Latest published version
+* **npm downloads** → Monthly downloads count
+* **License** → Project license
+* **Build Status** → GitHub Actions workflow status
+* **Code Style** → StandardJS compliance
+* **Contributors** → Number of contributors
+
+---
+
+## 👨‍💻 Author
+
+**Oluwafemi Olagoke**
+
+---
 
-npm downloads: Shows total downloads from npm.
+## 🔥 Pro Tip
 
-License: Shows the license type.
+Always ensure your version changes before publishing. GitHub Actions handles this automatically, but if you manually publish, run:
 
-Build Status: Shows GitHub Action status for auto-publishing.
+```bash
+npm version patch
+```
 
+before:
 
+```bash
+npm publish
+```
 
 ---
 
-Maintained by Oluwafemi Olagoke
+⭐ If you find this package useful, consider giving the repo a star!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@investorphem/string-tools",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "index.js",
   "description": "Handy string utility functions for developers",
   "scripts": {
@@ -13,4 +13,4 @@
   ],
   "author": "Oluwafemi Olagoke",
   "license": "MIT"
-}
+}