mongodb-models-visualizer 0.1.1 → 0.1.3

package/.github/workflows/publish.yml

@@ -2,10 +2,14 @@ name: Publish to npm & GitHub Packages
 
 on:
   push:
-    branches:
-      - main
+    tags:
+      - 'v*'
   workflow_dispatch:
 
+permissions:
+  contents: read
+  id-token: write # Required for npm provenance
+
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -15,21 +19,30 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build
 
-      # Publish to npm
       - name: Publish to npm
-        run: |
-          npm config set registry https://registry.npmjs.org/
-          npm publish
+        run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      # Publish to GitHub Packages
+      - name: Configure for GitHub Packages
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@hibbanur-rahman'
+
       - name: Publish to GitHub Packages
         run: |
           npm pkg set name="@hibbanur-rahman/mongodb-models-visualizer"
-          npm config set registry https://npm.pkg.github.com
-          npm publish
+          npm publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.HUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -1,3 +1,11 @@
+
+![npm](https://img.shields.io/npm/v/mongodb-models-visualizer)
+![npm downloads](https://img.shields.io/npm/dw/mongodb-models-visualizer)
+![license](https://img.shields.io/npm/l/mongodb-models-visualizer)
+![node](https://img.shields.io/node/v/mongodb-models-visualizer)
+![typescript](https://img.shields.io/badge/TypeScript-Ready-blue)
+![GitHub stars](https://img.shields.io/github/stars/hibbanur-rahman/mongodb-visualizer?style=social)
+
 # mongodb-visualizer
 
 🚀 **Swagger-like Analyzer for MongoDB (Mongoose) Models**

package/contributing.md

@@ -0,0 +1,115 @@
+# Contributing to mongodb-models-visualizer
+
+First of all, thank you for considering contributing 🙌  
+Contributions of all kinds are welcome — code, docs, ideas, or bug reports.
+
+---
+
+## 🧠 Project Philosophy
+
+- Simple developer experience
+- Zero-config integration
+- Clear and readable code
+- Framework-agnostic core
+
+---
+
+## 🛠️ Tech Stack
+
+- TypeScript
+- Node.js
+- Express
+- Mongoose
+- tsup (build tool)
+
+---
+
+## 🚀 Getting Started
+
+### 1️⃣ Fork the Repository
+Click the **Fork** button on GitHub.
+
+### 2️⃣ Clone Your Fork
+```bash
+git clone https://github.com/<your-username>/mongodb-visualizer.git
+cd mongodb-visualizer
+```
+
+### 3️⃣ Install Dependencies
+```bash
+npm install
+```
+
+### 4️⃣ Build the Package
+```bash
+npm run build
+```
+
+---
+
+## 📂 Project Structure
+```
+src/
+├── core/        # Model scanning & analysis logic
+├── express/     # Express middleware
+├── ui/          # Swagger-like UI (future)
+└── index.ts     # Public API
+```
+
+---
+
+## 🧪 Testing Locally
+
+You can test the package using npm link:
+
+```bash
+npm link
+```
+
+In your test Express app:
+
+```bash
+npm link mongodb-models-visualizer
+```
+
+---
+
+## 🧾 Coding Guidelines
+
+- Use TypeScript
+- Prefer pure functions in `core/`
+- Avoid breaking changes without discussion
+- Add comments for non-obvious logic
+- Follow existing code style
+
+---
+
+## 🐛 Reporting Bugs
+
+When opening an issue, please include:
+
+- Node.js version
+- Mongoose version
+- Minimal reproducible example
+- Expected vs actual behavior
+
+---
+
+## ✨ Feature Requests
+
+Feature ideas are welcome!  
+Please open an issue and describe:
+
+- Use case
+- Expected output
+- Why it's useful
+
+---
+
+## 🔀 Pull Request Process
+
+1. Create a feature branch
+2. Make your changes
+3. Run `npm run build`
+4. Open a PR with a clear description
+5. Reference related issues if any

package/license

@@ -0,0 +1,27 @@
+
+---
+
+# 📄 `LICENSE` (MIT License)
+
+```md
+MIT License
+
+Copyright (c) 2026 mongodb-models-analyzer
+
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-models-visualizer",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "MongoDB Database Visualizer and models relationships between collections",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -16,7 +16,7 @@
     "mongoose": ">=6"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "echo \"Warning: No tests specified\"",
     "build": "tsup",
     "prepublishOnly": "npm run build"
   },