@edcalderon/versioning 1.1.2 → 1.3.0

package/README.md

@@ -11,7 +11,9 @@ A comprehensive versioning and changelog management tool designed for monorepos
 - 📦 NPM publishable
 - 🏷️ Git tagging and committing
 - ✅ Validation of version sync
-- 🔌 **Extensible plugin system** for custom business logic
+- 🔌 **Extensible plugin system** for subdirectory-based extensions
+- 🔒 **Security Checks** with automatic Husky integration
+- 🧹 **Repository Cleanup** to keep root directory organized
 
 ## Installation
 
@@ -33,7 +35,7 @@ The versioning tool supports a **composable extension system** that allows you t
 - Implement custom versioning strategies
 
 Extensions are loaded automatically from:
-- Built-in extensions in the `src/extensions/` directory
+- Built-in extensions in subdirectories of `src/extensions/` (e.g. `src/extensions/reentry-status/index.ts`)
 - External packages listed in `versioning.config.json`
 
 ### Creating Extensions
@@ -113,7 +115,7 @@ Features:
 - Local registry support
 - Dry-run mode
 
-#### Re-entry Status + Roadmap Extension
+### Re-entry Status + Roadmap Extension
 
 Maintains a fast **re-entry** layer (current state + next micro-step) and a slow **roadmap/backlog** layer (long-term plan).
 
@@ -129,39 +131,103 @@ Multi-project (scoped by `--project <name>`):
 - `.versioning/projects/<project>/REENTRY.md`
 - `.versioning/projects/<project>/ROADMAP.md`
 
-Notes:
-- `--project` must match an existing workspace app/package (it can be a slug like `trader`, a scoped package name like `@ed/trader`, or a path like `apps/trader`).
-- The canonical project key is the last path segment (e.g. `@ed/trader` → `trader`).
+**Smart Features:**
+- **Auto-Update:** `versioning reentry update` infers the project phase and next step from your last git commit.
+  - `feat: ...` → **Phase: development**
+  - `fix: ...` → **Phase: maintenance**
+- **Git Context:** Automatically links status to the latest branch, commit, and author.
 
 Commands:
 
 ```bash
 # Fast layer
 versioning reentry init
+versioning reentry update        # Auto-update status from git commit
+versioning reentry show          # Show current status summary
 versioning reentry sync
 
 # Fast layer (scoped)
 versioning reentry init --project trader
-versioning reentry sync --project trader
+versioning reentry update --project trader
+versioning reentry show --project trader
 
 # Slow layer
 versioning roadmap init --title "My Project"
 versioning roadmap list
 versioning roadmap set-milestone --id "now-01" --title "Ship X"
-versioning roadmap add --section Now --id "now-02" --item "Add observability"
+```
+
+#### Cleanup Repo Extension
+
+Keeps your repository root clean by organizing stray files into appropriate directories (docs, scripts, config, archive).
+
+Features:
+- **Smart Scanning:** Identifies files that don't belong in the root.
+- **Configurable Routes:** Map extensions to folders (e.g. `.sh` → `scripts/`).
+- **Safety:** Allowlist for root files and Denylist for forced moves.
+- **Husky Integration:** Auto-scan or auto-move on commit.
+
+Commands:
+
+```bash
+versioning cleanup scan          # Dry-run scan of root
+versioning cleanup move          # Move files to configured destinations
+versioning cleanup restore       # Restore a moved file
+versioning cleanup config        # View/manage configuration
+versioning cleanup husky         # Setup git hook (scan-only by default)
+```
 
-# Slow layer (scoped)
-versioning roadmap init --project trader --title "Trader"
-versioning roadmap list --project trader
-versioning roadmap add --project trader --section Now --item "Wire user-data ORDER_* events"
+Configuration (`versioning.config.json`):
 
-# Detect stale/mismatched scoped roadmaps
-versioning roadmap validate
+```json
+{
+  "extensionConfig": {
+    "cleanup-repo": {
+      "enabled": true,
+      "defaultDestination": "docs",
+      "allowlist": ["CHANGELOG.md"],
+      "routes": {
+        ".sh": "scripts",
+        ".json": "config"
+      }
+    }
+  }
+}
 ```
 
-Backward compatibility:
-- v1.0 status files load safely.
-- Schema migrates to v1.1 only when you actually modify status, or explicitly via `versioning reentry sync --migrate`.
+#### Secrets Check Extension
+
+Prevents sensitive data (private keys, tokens, mnemonics) from being committed to the repository.
+
+Features:
+- **Pre-defined Patterns:** Detects AWS, GitHub, NPM tokens, private keys, and EVM mnemonics.
+- **Allowlist:** Ignore false positives or specific test keys.
+- **Husky Integration:** Easy CLI setup to block commits containing secrets.
+
+Commands:
+
+```bash
+versioning check-secrets         # Scan staged files for secrets
+versioning check-secrets husky   # Add blocking secrets check to pre-commit hook
+```
+
+Configuration (`versioning.config.json`):
+
+```json
+{
+  "extensionConfig": {
+    "secrets-check": {
+      "enabled": true,
+      "patterns": [
+        "CUSTOM_API_KEY=[0-9a-f]{32}"
+      ],
+      "allowlist": [
+        "ETHERSCAN_API_KEY=YOUR_KEY"
+      ]
+    }
+  }
+}
+```
 
 ### External Extensions
 

package/dist/extensions/cleanup-repo/index.d.ts

@@ -0,0 +1,49 @@
+import { VersioningExtension } from '../../extensions';
+/**
+ * The canonical cleanup configuration schema.
+ * Everything the plugin needs lives here.
+ */
+export interface CleanupRepoConfig {
+    /** Master switch. Default: true */
+    enabled: boolean;
+    /** Default destination for files without a specific route. Default: "docs" */
+    defaultDestination: string;
+    /**
+     * Files explicitly allowed to stay in root (on top of built-in essentials).
+     * Supports exact filenames and glob-like patterns (e.g. "*.config.js").
+     */
+    allowlist: string[];
+    /**
+     * Files that should ALWAYS be moved, even if they match the allowlist.
+     * Useful for forcing cleanup of specific known offenders.
+     */
+    denylist: string[];
+    /**
+     * File extensions to consider for cleanup (with leading dot).
+     * Default: [".md", ".sh", ".json", ".yaml", ".yml", ".txt", ".log"]
+     */
+    extensions: string[];
+    /**
+     * Mapping of file extension → destination directory.
+     * Overrides defaultDestination per extension.
+     */
+    routes: Record<string, string>;
+    /**
+     * Husky integration settings.
+     */
+    husky: {
+        enabled: boolean;
+        /** Which husky hook to attach to. Default: "pre-commit" */
+        hook: string;
+        /** "scan" = warning only, "enforce" = auto-move + git add. Default: "scan" */
+        mode: 'scan' | 'enforce';
+    };
+}
+declare const BUILTIN_ALLOWLIST: Set<string>;
+declare const DEFAULT_EXTENSIONS: string[];
+declare const DEFAULT_ROUTES: Record<string, string>;
+declare function loadCleanupConfig(rootConfig: any): CleanupRepoConfig;
+declare const extension: VersioningExtension;
+export { loadCleanupConfig, BUILTIN_ALLOWLIST, DEFAULT_EXTENSIONS, DEFAULT_ROUTES };
+export default extension;
+//# sourceMappingURL=index.d.ts.map