licenseguard-cli 1.0.0 → 1.2.0

package/README.md

@@ -153,7 +153,7 @@ This configuration is used by the git hooks to display license information.
 LicenseGuard installs two informational git hooks:
 
 ### Post-Checkout Hook
-Displays a notification after `git clone` or `git checkout`:
+Displays a notification after `git checkout` or branch switches:
 ```
 📜 This project uses MIT License by Your Name
 ```
@@ -169,6 +169,40 @@ Displays a reminder before each commit:
 - Hooks always exit with code 0 (success)
 - If `.licenseguardrc` is missing, hooks silently exit
 
+### Auto-Setup on Clone (npm projects)
+
+Git hooks live in `.git/hooks/` which is **not tracked by git**. This means hooks are not copied when someone clones your repository.
+
+For npm projects, you can use the `prepare` script to automatically set up hooks when developers run `npm install`:
+
+**Add to your package.json:**
+```json
+{
+  "devDependencies": {
+    "licenseguard-cli": "^1.1.0"
+  },
+  "scripts": {
+    "prepare": "licenseguard --setup || true"
+  }
+}
+```
+
+**What happens when someone clones your project:**
+```bash
+git clone <your-repo>       # Gets code + .licenseguardrc
+npm install                 # AUTOMATICALLY:
+                           # 📜 "This project uses MIT License by Your Name"
+                           # ✓ Git hooks installed
+git checkout feature        # Notification appears (hooks active)
+git commit                  # Reminder appears (hooks active)
+```
+
+The `--setup` command:
+- Reads `.licenseguardrc` and displays license notification
+- Installs git hooks automatically
+- Always exits 0 (never breaks `npm install`)
+- Safe to run multiple times (idempotent)
+
 ### Existing Hooks
 
 If you already have git hooks, LicenseGuard will NOT overwrite them. Instead, it creates variants:
@@ -182,6 +216,7 @@ You can manually merge these with your existing hooks if desired.
 If your project is not a git repository:
 - Interactive mode (`--init`) will offer to run `git init`
 - Fast mode (`--init-fast`) will skip hooks and warn you
+- `--setup` command will skip hooks with a warning
 - LICENSE file is always created regardless of git status
 
 ## FAQ

package/bin/licenseguard.js

@@ -4,9 +4,10 @@ const { program } = require('commander')
 const { runList } = require('../lib/commands/list')
 const { runInit } = require('../lib/commands/init')
 const { runInitFast } = require('../lib/commands/init-fast')
+const { setupCommand } = require('../lib/commands/setup')
 
 program
-  .version('1.0.0')
+  .version('1.1.0')
   .description('License setup & compliance helper for developers')
 
 program
@@ -17,6 +18,10 @@ program
   .option('--year <year>', 'Copyright year (for --init-fast)')
   .option('--url <url>', 'Project URL (for --init-fast)')
   .option('--ls', 'List available license templates')
+  .option(
+    '--setup',
+    'Setup license notification and install git hooks (for npm prepare script)'
+  )
   .parse(process.argv)
 
 const options = program.opts()
@@ -36,6 +41,11 @@ if (options.init) {
     console.error('Error:', err.message)
     process.exit(1)
   })
+} else if (options.setup) {
+  setupCommand().catch((err) => {
+    // Even on error, don't exit 1 - npm prepare compatibility
+    console.error('Setup warning:', err.message)
+  })
 } else {
   program.help()
 }

package/lib/commands/setup.js

@@ -0,0 +1,56 @@
+const fs = require('fs')
+const chalk = require('chalk')
+const { isGitRepo, installHooks } = require('../utils/git-helpers')
+
+/**
+ * Setup command - Install git hooks and show license notification
+ * Used in npm prepare script for auto-setup on clone
+ *
+ * This command is designed for use in package.json prepare scripts:
+ * {
+ *   "scripts": {
+ *     "prepare": "licenseguard --setup || true"
+ *   }
+ * }
+ *
+ * @returns {Promise<void>}
+ */
+async function setupCommand() {
+  try {
+    // Check for .licenseguardrc
+    if (!fs.existsSync('.licenseguardrc')) {
+      console.log(
+        chalk.yellow(
+          'No .licenseguardrc found. Run \'licenseguard --init\' first.'
+        )
+      )
+      return // Exit 0 implicitly
+    }
+
+    // Read config
+    const configContent = fs.readFileSync('.licenseguardrc', 'utf-8')
+    const config = JSON.parse(configContent)
+
+    // Display license notification (MAIN PURPOSE)
+    // This is what developers see when they run npm install
+    console.log(
+      chalk.blue(
+        `📜 This project uses ${config.license.toUpperCase()} License by ${config.owner}`
+      )
+    )
+
+    // Install hooks if git repo
+    if (isGitRepo()) {
+      installHooks()
+      // Note: installHooks() already prints success/warning messages
+    } else {
+      console.log(chalk.yellow('⚠️ Skipping git hooks (not a git repo)'))
+    }
+  } catch (error) {
+    // Always exit 0 - never break npm install
+    // This is CRITICAL for npm prepare script compatibility
+    console.log(chalk.yellow(`⚠️ Setup warning: ${error.message}`))
+  }
+}
+
+module.exports = { setupCommand }

package/lib/postinstall.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const path = require('path')
+const os = require('os')
+const { execSync } = require('child_process')
+
+/**
+ * Setup global git hooks for automatic license notifications
+ * Runs automatically after npm install -g licenseguard-cli
+ */
+
+const homeDir = os.homedir()
+const templateDir = path.join(homeDir, '.git-templates')
+const hooksDir = path.join(templateDir, 'hooks')
+
+// Self-contained hook scripts (only needs Node.js, not licenseguard)
+const postCheckoutHook = `#!/usr/bin/env node
+const fs = require('fs')
+const path = require('path')
+
+try {
+  const configPath = path.join(process.cwd(), '.licenseguardrc')
+  if (!fs.existsSync(configPath)) process.exit(0)
+
+  const config = JSON.parse(fs.readFileSync(configPath, 'utf8'))
+  const blue = '\\x1b[34m'
+  const reset = '\\x1b[0m'
+
+  console.log(\`\${blue}📜 This project uses \${config.license.toUpperCase()} License by \${config.owner}\${reset}\`)
+} catch (e) {
+  // Silent fail - never block git
+}
+process.exit(0)
+`
+
+const preCommitHook = `#!/usr/bin/env node
+const fs = require('fs')
+const path = require('path')
+
+try {
+  const configPath = path.join(process.cwd(), '.licenseguardrc')
+  if (!fs.existsSync(configPath)) process.exit(0)
+
+  const config = JSON.parse(fs.readFileSync(configPath, 'utf8'))
+  const blue = '\\x1b[34m'
+  const reset = '\\x1b[0m'
+
+  console.log(\`\${blue}ℹ️  Reminder: This project is licensed under \${config.license.toUpperCase()}\${reset}\`)
+} catch (e) {
+  // Silent fail - never block git
+}
+process.exit(0)
+`
+
+function setupGlobalHooks() {
+  try {
+    // Only setup global hooks when installed globally
+    // Check if we're in a global npm directory
+    const isGlobalInstall =
+      process.env.npm_config_global === 'true' ||
+      __dirname.includes('npm-global') ||
+      __dirname.includes('/usr/lib/node_modules') ||
+      __dirname.includes('/usr/local/lib/node_modules')
+
+    if (!isGlobalInstall) {
+      // Local install, skip global hooks setup
+      return
+    }
+
+    // Create template directories
+    if (!fs.existsSync(hooksDir)) {
+      fs.mkdirSync(hooksDir, { recursive: true })
+    }
+
+    // Write hook files
+    const hooks = [
+      { name: 'post-checkout', script: postCheckoutHook },
+      { name: 'pre-commit', script: preCommitHook },
+    ]
+
+    for (const hook of hooks) {
+      const hookPath = path.join(hooksDir, hook.name)
+
+      // Check for existing hooks
+      if (fs.existsSync(hookPath)) {
+        const existing = fs.readFileSync(hookPath, 'utf8')
+        if (!existing.includes('.licenseguardrc')) {
+          // Not our hook, create variant
+          const variantPath = path.join(hooksDir, `licenseguard-${hook.name}`)
+          fs.writeFileSync(variantPath, hook.script, 'utf8')
+          fs.chmodSync(variantPath, 0o755)
+          console.log(`⚠️  Existing ${hook.name} found, created licenseguard-${hook.name}`)
+        }
+        // Our hook already exists, skip
+      } else {
+        fs.writeFileSync(hookPath, hook.script, 'utf8')
+        fs.chmodSync(hookPath, 0o755)
+      }
+    }
+
+    // Configure git to use template directory
+    execSync(`git config --global init.templateDir "${templateDir}"`, {
+      stdio: 'pipe',
+    })
+
+    console.log('✓ LicenseGuard global hooks installed')
+    console.log(`  Template directory: ${templateDir}`)
+    console.log('  Now every git clone/init will check for .licenseguardrc')
+  } catch (error) {
+    // Don't fail installation if hooks setup fails
+    console.log('⚠️  Could not setup global hooks:', error.message)
+    console.log('  LicenseGuard still works, run licenseguard --setup manually')
+  }
+}
+
+setupGlobalHooks()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "licenseguard-cli",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "License setup & compliance helper for developers",
   "bin": {
     "licenseguard": "./bin/licenseguard.js"
@@ -9,11 +9,7 @@
     "doc": "docs"
   },
   "scripts": {
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "lint": "eslint .",
-    "format": "prettier --write ."
+    "postinstall": "node lib/postinstall.js"
   },
   "keywords": [
     "license",
@@ -29,11 +25,5 @@
     "chalk": "^4.1.2",
     "commander": "^11.1.0",
     "inquirer": "^8.2.5"
-  },
-  "devDependencies": {
-    "eslint": "^8.54.0",
-    "jest": "^29.7.0",
-    "mock-fs": "^5.2.0",
-    "prettier": "^3.1.0"
   }
 }