@parseme/cli 0.0.5 → 0.0.6

package/README.md

@@ -173,7 +173,8 @@ const config = {
   maxDepth: 10,
 
   // Git integration
-  includeGitInfo: true,
+  includeGitInfo: true, // Include git repository information in context
+  useGitForFiles: true, // Use git to discover files (respects .gitignore)
 
   // Size limits
   limits: {
@@ -272,7 +273,8 @@ Configuration values are resolved in the following order (highest to lowest prio
 
 #### Git Integration
 
-- `includeGitInfo` - Include git repository information (default: `true`)
+- `includeGitInfo` - Include git repository information in context files (default: `true`)
+- `useGitForFiles` - Use git to discover files, respecting .gitignore (default: `true`)
 
 #### Content Sections
 
@@ -338,7 +340,16 @@ npm run parseme
 # Runs automatically after each commit
 
 # Override config with CLI flags
-npx parseme generate --output custom.md --context-dir docs/context --root ./src --no-git
+npx parseme generate --output custom.md --context-dir docs/context --root ./src
+
+# Disable git info generation (keeps git for file discovery)
+npx parseme generate --no-git-info
+
+# Disable git for file discovery (keeps git info generation)
+npx parseme generate --no-git-files
+
+# Disable both git info and git file discovery
+npx parseme generate --no-git-info --no-git-files
 
 # Specify file types and exclude patterns
 npx parseme generate --file-types ts js --exclude "**/*.test.ts"
@@ -354,7 +365,8 @@ npx parseme generate --file-types ts js --exclude "**/*.test.ts"
 - `--context-dir <path>` - Context directory path (default: parseme-context)
 - `--file-types <types...>` - File types to analyze (e.g., ts tsx js jsx)
 - `--exclude <patterns...>` - Additional exclude patterns (glob, in git repositories on top of git-tracked files)
-- `--no-git` - Disable git information
+- `--no-git-info` - Disable git info generation (keeps git for file discovery)
+- `--no-git-files` - Disable git for file discovery (uses filesystem crawling instead)
 - `--max-depth <number>` - Maximum directory depth
 
 #### Init Command (`parseme init` or `parseme i`)
@@ -413,16 +425,48 @@ await generator.generateToFile('./output/PARSEME.md');
 
 ## Git Hook Integration
 
-Keep your AI context automatically updated by adding parseme as a post-commit hook:
+Keep your AI context automatically updated by integrating parseme with git hooks. The recommended setup uses three hooks to ensure context files always have git info locally but stay clean on remote:
 
-### Manual Setup
+### Recommended Hook Setup
+
+#### Manual Setup
 
 ```bash
-# Create and make executable
-echo '#!/bin/sh\npx parseme generate' > .git/hooks/post-commit
-chmod +x .git/hooks/post-commit
+# 1. Post-commit: Generate context with git info after each commit
+cat > .git/hooks/post-commit << 'EOF'
+#!/bin/sh
+
+npx parseme generate
+EOF
+
+# 2. Pre-push: Regenerate without git info and amend before pushing
+cat > .git/hooks/pre-push << 'EOF'
+#!/bin/sh
+
+# Regenerate without git info for clean remote state
+npx parseme generate --no-git-info
+
+# Stage parseme files (parseme-context/ may be different if configured)
+git add parseme-context/ PARSEME.md
+
+# Amend the commit with updated parseme files
+git commit --amend --no-edit --no-verify
+EOF
+
+# 3. Post-push: Restore git info locally after push completes
+cat > .git/hooks/post-push << 'EOF'
+#!/bin/sh
+
+# Regenerate with git info for local development
+npx parseme generate
+EOF
+
+# Make hooks executable
+chmod +x .git/hooks/post-commit .git/hooks/pre-push .git/hooks/post-push
 ```
 
+**Note:** If you've configured a custom `contextDir` (either in your config file or via the `--context-dir` CLI flag), update the `git add` path in the pre-push hook accordingly (e.g., `git add docs/context/ PARSEME.md`).
+
 ### Using Husky
 
 ```json
@@ -430,13 +474,25 @@ chmod +x .git/hooks/post-commit
 {
   "husky": {
     "hooks": {
-      "post-commit": "npx parseme generate"
+      "post-commit": "npx parseme generate",
+      "pre-push": "npx parseme generate --no-git-info && git add parseme-context/ PARSEME.md && git commit --amend --no-edit --no-verify",
+      "post-push": "npx parseme generate"
     }
   }
 }
 ```
 
-This automatically regenerates your AI context files after every commit, ensuring they're always up-to-date!
+**Note:** If using a custom `contextDir`, update the `git add` path to match your configuration.
+
+### How It Works
+
+1. **post-commit**: After you commit, parseme generates context files with git info (current branch, recent commits, git diff) for local development
+2. **pre-push**: Before pushing, parseme regenerates without git info (`--no-git-info` flag) and amends the commit to keep remote clean
+3. **post-push**: After push completes, parseme regenerates with git info again so your local working copy maintains full context
+
+The `--no-verify` flag in pre-push prevents an infinite loop by skipping hook execution on the amend.
+
+This automatically keeps your AI context files synchronized with your code while maintaining clean context on remote and detailed context locally!
 
 ## Requirements
 

package/dist/cli/cli.js

@@ -20,7 +20,8 @@ program
     .option('--context-dir <path>', 'Context directory path (default: parseme-context)')
     .option('--file-types <types...>', 'File types to analyze (e.g., ts tsx js jsx)')
     .option('--exclude <patterns...>', 'Exclude patterns (glob)')
-    .option('--no-git', 'Disable git integration (info and file discovery)')
+    .option('--no-git-files', 'Disable git for file discovery')
+    .option('--no-git-info', 'Disable git info generation')
     .option('--max-depth <number>', 'Maximum directory depth', parseInt)
     .action(async (options) => {
     try {
@@ -31,7 +32,8 @@ program
             ...(options.contextDir && { contextDir: options.contextDir }),
             ...(options.fileTypes && { analyzeFileTypes: options.fileTypes }),
             ...(options.exclude && { excludePatterns: options.exclude }),
-            ...(options.git === false && { includeGitInfo: false, useGitForFiles: false }),
+            ...(options.gitFiles === false && { useGitForFiles: false }),
+            ...(options.gitInfo === false && { includeGitInfo: false }),
             ...(options.maxDepth && { maxDepth: options.maxDepth }),
         };
         const configFromFile = await ParsemeConfig.fromFile(options.config, {
@@ -116,8 +118,8 @@ program
         if (options.format === 'ts') {
             console.log('For TypeScript configs, ensure tsx or ts-node is available to load .ts files');
         }
-        console.log('Tip: Add "parseme": "parseme" to your package.json scripts for easier manual execution or hook integration');
-        console.log('Tip: Add parseme as a git hook to keep context auto-updated! See README for setup instructions.');
+        console.log('Tip: Add "parseme": "parseme generate" to your package.json scripts for easier manual execution or hook integration');
+        console.log('Tip: Add parseme as git hooks to keep context auto-updated! See README for recommended hook setup (post-commit, pre-push, post-push).');
         console.log('');
         console.log('Tip: Add this section to your README.md to help AI agents find the context:');
         console.log('');

package/dist/core/generator.js

@@ -1,4 +1,4 @@
-import { mkdir, writeFile } from 'fs/promises';
+import { mkdir, writeFile, rm } from 'fs/promises';
 import { join } from 'path';
 import { ASTAnalyzer } from './analyzers/ast-analyzer.js';
 import { FrameworkDetector } from './analyzers/framework-detector.js';
@@ -72,6 +72,8 @@ export class ParsemeGenerator {
         const parsemeDir = finalContextDir.startsWith('/')
             ? finalContextDir // Absolute path
             : join(baseDir, finalContextDir); // Relative path
+        // Clear the directory if it exists, then recreate it
+        await rm(parsemeDir, { recursive: true, force: true });
         await mkdir(parsemeDir, { recursive: true });
         await writeFile(finalOutputPath, context.parseme);
         if (context.context) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parseme/cli",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Adds a PARSEME.md file—a README.md for AI agents—to your project, providing context and structure for automated tools.",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,13 +24,11 @@
     "format:check": "prettier . --ignore-unknown --check",
     "lint": "eslint --config ./eslint.config.js --fix",
     "lint:check": "eslint --config ./eslint.config.js --no-fix --max-warnings 0",
-    "test": "node --test --experimental-test-coverage 'tests/**/*.test.ts'",
-    "pretest:unit": "npm run build",
+    "test": "node --test 'tests/**/*.test.ts'",
+    "pretest": "npm run build",
     "test:unit": "node --test 'tests/unit/**/*.test.ts'",
-    "pretest:integration": "npm run build",
     "test:integration": "node --test 'tests/integration/**/*.test.ts'",
     "test:watch": "node --test --watch 'tests/**/*.test.ts'",
-    "pretest:coverage": "npm run build",
     "test:coverage": "node --test --experimental-test-coverage 'tests/unit/**/*.test.ts' 'tests/integration/**/*.test.ts'",
     "test:setup:e2e": "npm run -C ../e2e setup",
     "test:e2e": "npm run -C ../e2e test",