hale-commenting-system 3.4.5 → 3.5.0

package/README.md

@@ -2,6 +2,18 @@
 
 A commenting system for PatternFly React applications that allows designers and developers to add comments directly on design pages, sync with GitHub Issues, and link Jira tickets.
 
+## 🚨 **CRITICAL: Read Before Uninstalling**
+
+**This package modifies your project files during setup.**
+
+**BEFORE uninstalling, you MUST run:**
+```bash
+npx hale-commenting-system remove
+npm uninstall hale-commenting-system
+```
+
+**Failure to run `remove` first will break your app!** See the [Uninstalling](#uninstalling) section below.
+
 ## Features
 
 - **Pin-based commenting** - Click anywhere on a page to add a comment pin
@@ -21,15 +33,9 @@ This package was developed for **PatternFly React Seed** projects, but can be us
 
 The automated integration script (`npx hale-commenting-system init`) works best with PatternFly React Seed or projects with a similar structure.
 
-## Installation
+## Installation and Setup
 
-```bash
-npm install hale-commenting-system
-```
-
-> **⚠️ Important:** This package modifies your project files during installation. Before uninstalling, always run `npx hale-commenting-system remove` to cleanly remove the integration and avoid breaking your application.
-
-## Quick Start
+> **⚠️ Note:** This package modifies your project files during setup. See the [Uninstalling](#uninstalling) section for proper removal instructions.
 
 1. **Install the package:**
    ```bash
@@ -54,21 +60,50 @@ npm install hale-commenting-system
 
 ## Uninstalling
 
-**IMPORTANT:** Before uninstalling the package, you must first remove the integration to avoid breaking your application.
+**⚠️ IMPORTANT: Two-Step Process Required**
+
+You **MUST** run the removal script before uninstalling to avoid breaking your app:
+
+### Step 1: Remove Integration
+
+```bash
+npx hale-commenting-system remove
+```
+
+This removes all integration code from your project files.
+
+### Step 2: Uninstall Package
+
+```bash
+npm uninstall hale-commenting-system
+```
+
+### Step 3: Restart Dev Server
 
-### Clean Uninstall Process
+```bash
+npm run start:dev
+```
+
+### What If I Forgot and Already Uninstalled?
+
+If you uninstalled without running `remove` first and your app is now broken:
+
+1. **Reinstall the package:**
+   ```bash
+   npm install hale-commenting-system
+   ```
 
-1. **Run the removal script:**
+2. **Run the removal script:**
    ```bash
    npx hale-commenting-system remove
    ```
 
-2. **Uninstall the package:**
+3. **Uninstall again:**
    ```bash
    npm uninstall hale-commenting-system
    ```
 
-3. **Restart your dev server:**
+4. **Restart your dev server:**
    ```bash
    npm run start:dev
    ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hale-commenting-system",
-  "version": "3.4.5",
+  "version": "3.5.0",
   "description": "A commenting system for PatternFly React applications that allows designers and developers to add comments directly on design pages, sync with GitHub Issues, and link Jira tickets.",
   "homepage": "https://www.npmjs.com/package/hale-commenting-system",
   "license": "MIT",
@@ -17,6 +17,8 @@
     "GITHUB_OAUTH_ENV_TEMPLATE.md"
   ],
   "scripts": {
+    "postinstall": "node scripts/postinstall.js || true",
+    "preuninstall": "node scripts/auto-remove.js || true",
     "prebuild": "npm run type-check && npm run clean",
     "build": "webpack --config webpack.prod.js",
     "start": "sirv dist --cors --single --host --port 8080",

package/scripts/auto-remove.js

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+
+/**
+ * Automatic cleanup script that runs before npm uninstall
+ * This ensures the user's app doesn't break when they uninstall the package
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+// Determine project root based on where this script is running
+// During preuninstall, CWD could be either:
+// 1. The package directory: /path/to/project/node_modules/hale-commenting-system
+// 2. The project directory: /path/to/project
+let projectRoot;
+
+if (process.cwd().includes('node_modules')) {
+  // Running from inside node_modules/hale-commenting-system
+  projectRoot = path.resolve(process.cwd(), '../..');
+} else {
+  // Running from project root
+  projectRoot = process.cwd();
+}
+
+console.log('\n╔════════════════════════════════════════════════════╗');
+console.log('║   Hale Commenting System - Auto Cleanup           ║');
+console.log('╚════════════════════════════════════════════════════╝\n');
+console.log('🧹 Removing integration before uninstall...\n');
+
+let filesModified = 0;
+
+try {
+  // 1. Remove from src/app/index.tsx
+  const indexPath = path.join(projectRoot, 'src/app/index.tsx');
+  if (fs.existsSync(indexPath)) {
+    let content = fs.readFileSync(indexPath, 'utf8');
+    const originalContent = content;
+
+    // Remove the import
+    content = content.replace(/import\s*{\s*CommentProvider\s*,\s*GitHubAuthProvider\s*}\s*from\s*["']hale-commenting-system["'];?\s*\n?/g, '');
+
+    // Remove the providers from JSX - be more aggressive with whitespace handling
+    content = content.replace(/<GitHubAuthProvider>\s*/g, '');
+    content = content.replace(/\s*<\/GitHubAuthProvider>/g, '');
+    content = content.replace(/<CommentProvider>\s*/g, '');
+    content = content.replace(/\s*<\/CommentProvider>/g, '');
+
+    if (content !== originalContent) {
+      fs.writeFileSync(indexPath, content, 'utf8');
+      console.log('✅ Cleaned up src/app/index.tsx');
+      filesModified++;
+    }
+  }
+
+  // 2. Remove from src/app/AppLayout/AppLayout.tsx
+  const appLayoutPath = path.join(projectRoot, 'src/app/AppLayout/AppLayout.tsx');
+  if (fs.existsSync(appLayoutPath)) {
+    let content = fs.readFileSync(appLayoutPath, 'utf8');
+    const originalContent = content;
+
+    // Remove the import
+    content = content.replace(/import\s*{\s*CommentPanel\s*,\s*CommentOverlay\s*}\s*from\s*["']hale-commenting-system["'];?\s*\n?/g, '');
+
+    // Remove the components from JSX
+    content = content.replace(/<CommentPanel>\s*/g, '');
+    content = content.replace(/\s*<\/CommentPanel>/g, '');
+    content = content.replace(/<CommentOverlay\s*\/>\s*/g, '');
+
+    if (content !== originalContent) {
+      fs.writeFileSync(appLayoutPath, content, 'utf8');
+      console.log('✅ Cleaned up src/app/AppLayout/AppLayout.tsx');
+      filesModified++;
+    }
+  }
+
+  if (filesModified > 0) {
+    console.log(`\n✅ Successfully cleaned up ${filesModified} file(s)`);
+    console.log('   Your app will continue to work after uninstall.\n');
+  } else {
+    console.log('ℹ️  No integration found to clean up.\n');
+  }
+} catch (error) {
+  // Don't block uninstall, but show the error
+  console.error('⚠️  Error during automatic cleanup:');
+  console.error('   ', error.message);
+  console.error('\n   You may need to manually remove imports from your files.');
+  console.error('   See: https://www.npmjs.com/package/hale-commenting-system#manual-uninstall\n');
+}
+
+// Always exit successfully so uninstall can proceed
+process.exit(0);

package/scripts/postinstall.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+console.log('\n╔══════════════════════════════════════════════════════════╗');
+console.log('║                                                          ║');
+console.log('║   📦 Hale Commenting System installed successfully!      ║');
+console.log('║                                                          ║');
+console.log('╚══════════════════════════════════════════════════════════╝\n');
+
+console.log('📝 Next steps:');
+console.log('   1. Run: npx hale-commenting-system init');
+console.log('   2. Start your dev server\n');
+
+console.log('🚨 CRITICAL - BEFORE UNINSTALLING:');
+console.log('   ══════════════════════════════════════════════════════');
+console.log('   This package modifies your project files during setup.');
+console.log('   ');
+console.log('   BEFORE running "npm uninstall hale-commenting-system",');
+console.log('   you MUST run:');
+console.log('   ');
+console.log('   ▶  npx hale-commenting-system remove');
+console.log('   ');
+console.log('   Otherwise your app will break with import errors!');
+console.log('   ══════════════════════════════════════════════════════\n');
+
+console.log('📚 Documentation: https://www.npmjs.com/package/hale-commenting-system\n');