hale-commenting-system 3.4.3 → 3.4.5

package/README.md

@@ -27,6 +27,8 @@ The automated integration script (`npx hale-commenting-system init`) works best
 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
 
 1. **Install the package:**
@@ -50,6 +52,53 @@ npm install hale-commenting-system
    npm run start:dev
    ```
 
+## Uninstalling
+
+**IMPORTANT:** Before uninstalling the package, you must first remove the integration to avoid breaking your application.
+
+### Clean Uninstall Process
+
+1. **Run the removal script:**
+   ```bash
+   npx hale-commenting-system remove
+   ```
+
+2. **Uninstall the package:**
+   ```bash
+   npm uninstall hale-commenting-system
+   ```
+
+3. **Restart your dev server:**
+   ```bash
+   npm run start:dev
+   ```
+
+### What the Removal Script Does
+
+The removal script will automatically:
+- Remove imports from `src/app/index.tsx`
+- Remove imports from `src/app/AppLayout/AppLayout.tsx`
+- Notify you about webpack middleware (may require manual removal)
+- Keep `.env` and `.env.server` files (you can delete manually if needed)
+
+### Manual Uninstall (If Needed)
+
+If you need to manually remove the integration:
+
+1. **In `src/app/index.tsx`**, remove:
+   ```typescript
+   import { CommentProvider, GitHubAuthProvider } from "hale-commenting-system";
+   ```
+   And remove the `<GitHubAuthProvider>` and `<CommentProvider>` wrappers.
+
+2. **In `src/app/AppLayout/AppLayout.tsx`**, remove:
+   ```typescript
+   import { CommentPanel, CommentOverlay } from "hale-commenting-system";
+   ```
+   And remove the `<CommentPanel>` and `<CommentOverlay />` components.
+
+3. **In `webpack.dev.js`**, remove the middleware configuration added for GitHub OAuth and Jira API proxying.
+
 ## Usage
 
 After running the integration script, the commenting system will be available in your PatternFly React Seed application.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "hale-commenting-system",
-  "version": "3.4.3",
+  "version": "3.4.5",
   "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",
   "main": "src/app/commenting-system/index.ts",
   "types": "src/app/commenting-system/index.ts",
   "bin": {
-    "hale-commenting-system": "scripts/integrate.js"
+    "hale-commenting-system": "scripts/cli.js"
   },
   "files": [
     "src/app/commenting-system/",

package/scripts/cli.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+
+const command = process.argv[2];
+
+const scriptMap = {
+  init: 'integrate.js',
+  remove: 'remove.js',
+  uninstall: 'remove.js',
+};
+
+if (!command || command === 'init') {
+  // Default to init
+  const scriptPath = path.join(__dirname, 'integrate.js');
+  const child = spawn('node', [scriptPath], { stdio: 'inherit' });
+  child.on('exit', (code) => process.exit(code));
+} else if (scriptMap[command]) {
+  const scriptPath = path.join(__dirname, scriptMap[command]);
+  const child = spawn('node', [scriptPath], { stdio: 'inherit' });
+  child.on('exit', (code) => process.exit(code));
+} else {
+  console.log('\n╔════════════════════════════════════════════════════╗');
+  console.log('║          Hale Commenting System - CLI             ║');
+  console.log('╚════════════════════════════════════════════════════╝\n');
+  console.log('Usage:');
+  console.log('  npx hale-commenting-system init       Install and integrate the commenting system');
+  console.log('  npx hale-commenting-system remove     Remove the commenting system');
+  console.log('  npx hale-commenting-system uninstall  Remove the commenting system (alias)\n');
+  process.exit(1);
+}

package/scripts/remove.js

@@ -0,0 +1,134 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const prompt = (questions) => {
+  return new Promise((resolve) => {
+    const answers = {};
+    let currentIndex = 0;
+
+    const askNext = () => {
+      if (currentIndex >= questions.length) {
+        rl.close();
+        resolve(answers);
+        return;
+      }
+
+      const q = questions[currentIndex];
+      rl.question(q.message + ' ', (answer) => {
+        answers[q.name] = answer.trim();
+        currentIndex++;
+        askNext();
+      });
+    };
+
+    askNext();
+  });
+};
+
+console.log('\n╔════════════════════════════════════════════════════╗');
+console.log('║     Hale Commenting System - Uninstall Script      ║');
+console.log('╚════════════════════════════════════════════════════╝\n');
+
+console.log('⚠️  This will remove the Hale Commenting System from your project.\n');
+console.log('The following changes will be reverted:');
+console.log('  • Remove imports from src/app/index.tsx');
+console.log('  • Remove imports from src/app/AppLayout/AppLayout.tsx');
+console.log('  • Remove middleware from webpack.dev.js');
+console.log('  • Keep .env and .env.server files (you can delete manually if needed)\n');
+
+async function main() {
+  const confirm = await prompt([
+    {
+      name: 'proceed',
+      message: 'Do you want to proceed? (yes/no):',
+    },
+  ]);
+
+  if (confirm.proceed.toLowerCase() !== 'yes' && confirm.proceed.toLowerCase() !== 'y') {
+    console.log('\n❌ Uninstall cancelled.\n');
+    rl.close();
+    return;
+  }
+
+  console.log('\n🔧 Removing Hale Commenting System...\n');
+
+  // Find project root
+  const projectRoot = process.cwd();
+  let filesModified = 0;
+
+  // 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
+    content = content.replace(/<GitHubAuthProvider>\s*/g, '');
+    content = content.replace(/<\/GitHubAuthProvider>/g, '');
+    content = content.replace(/<CommentProvider>\s*/g, '');
+    content = content.replace(/<\/CommentProvider>/g, '');
+
+    if (content !== originalContent) {
+      fs.writeFileSync(indexPath, content, 'utf8');
+      console.log('✅ Removed from 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(/<\/CommentPanel>/g, '');
+    content = content.replace(/<CommentOverlay\s*\/>\s*/g, '');
+
+    if (content !== originalContent) {
+      fs.writeFileSync(appLayoutPath, content, 'utf8');
+      console.log('✅ Removed from src/app/AppLayout/AppLayout.tsx');
+      filesModified++;
+    }
+  }
+
+  // 3. Remove middleware from webpack.dev.js (optional - can be complex)
+  const webpackPath = path.join(projectRoot, 'webpack.dev.js');
+  if (fs.existsSync(webpackPath)) {
+    console.log('ℹ️  webpack.dev.js - You may want to manually remove the middleware configuration');
+  }
+
+  console.log('\n╔══════════════════════════════════════════════════════════╗');
+  console.log('║   ✅ Uninstall Complete!                                   ║');
+  console.log('╚══════════════════════════════════════════════════════════╝\n');
+
+  console.log(`Modified ${filesModified} file(s)\n`);
+
+  console.log('Next steps:');
+  console.log('1. Run: npm uninstall hale-commenting-system');
+  console.log('2. Restart your dev server: npm run start:dev');
+  console.log('3. (Optional) Delete .env and .env.server if no longer needed\n');
+
+  rl.close();
+}
+
+main().catch((err) => {
+  console.error('❌ Error during uninstall:', err);
+  rl.close();
+  process.exit(1);
+});