@programinglive/commiter 1.2.17 → 1.2.18

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.2.18](https://github.com/programinglive/commiter/compare/v1.2.17...v1.2.18) (2026-01-01)
+
+
+### 📝 Documentation
+
+* **release-notes:** add 1.2.17 entry ([0a79779](https://github.com/programinglive/commiter/commit/0a7977964e9231a53d7d006cec5e847daeee2033))
+* **web:** refresh homepage content for v1.2.17 ([2fc6666](https://github.com/programinglive/commiter/commit/2fc6666369e18a0dbda9488d9ed0ac6a09298f95))
+
+
+### ✨ Features
+
+* add usage warning and MCP dev-workflow tip ([df7bc00](https://github.com/programinglive/commiter/commit/df7bc0078f75780f3daaeb703b6fe2b248910446))
+
+
+### ✅ Tests
+
+* add automated tests for usage warnings ([af6283e](https://github.com/programinglive/commiter/commit/af6283edfa4e1e677fc20bfc5e6b243db192867f))
+
 ### [1.2.17](https://github.com/programinglive/commiter/compare/v1.2.16...v1.2.17) (2025-12-26)
 
 

package/commitlint.config.cjs

@@ -1,4 +1,4 @@
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   ignores: [(message) => message.startsWith('chore(release):')]
-};
+}

package/docs/PRD.md

@@ -1,96 +1,18 @@
-# Commiter Product Requirements Document (PRD)
+# PRD: Usage Clarification and Automated Testing
 
-## 1. Overview
-Commiter is a CLI utility that bootstraps and automates conventional release workflows for JavaScript/TypeScript projects. It enforces commit conventions, orchestrates semantic version bumps, keeps release tooling configured, and surfaces feedback during release execution so teams can ship confidently.
+## Overview
+Prevent users and AI assistants from misusing `@programinglive/commiter` as a generic git commit tool. Guide AI assistants toward the correct tool (@programinglive/dev-workflow-mcp-server) and ensure these safeguards are verified by automated tests.
 
-## 2. Problem Statement
-Growing teams often struggle to keep release processes consistent: commit messages drift from convention, changelogs become stale, and release scripts accumulate manual steps. Commiter removes this friction by installing opinionated tooling, providing curated scripts, and running guard rails (tests, linters) before invoking `standard-version` to publish a release.
+## Problem
+AI assistants sometimes assume `@programinglive/commiter` is for committing files (e.g., `commiter "message"`). This fails because the tool is meant for setup and release orchestration. Automated verification of these safeguards was initially missing.
 
-## 3. Goals & Success Metrics
-- **Consistent releases**: Every release run through Commiter formats commits, updates changelogs, tags, and version bumps without manual editing.
-- **Low ceremony onboarding**: A single `npx commiter` command prepares repositories (Husky, commitlint, release scripts).
-- **Signal-rich automation**: Release logs clearly show which steps ran, including any warnings (e.g., tests skipped). Zero noisy deprecation warnings.
-- **Reliability**: New releases do not regress existing behavior; the automated test suite passes (`node --test`).
-- **Adoption Metric**: Track installations (npm downloads) and successful release script exits.
+## Requirements
+- Display a warning banner if arguments are passed to `node index.js`.
+- Suggest standard `git commit` commands.
+- Provide a tip to use the MCP dev-workflow for AI assistants.
+- Update release script error messages to include the same tip.
+- **[NEW]** Implement automated tests to verify the above behavior across `index.js` and `scripts/release.cjs`.
 
-## 4. Personas
-1. **Solo Maintainer** – wants painless semantic releases without memorizing commands.
-2. **Team Lead** – enforces commit standards across contributors and ensures releases produce accurate changelogs.
-3. **DevOps/CI Engineer** – integrates Commiter’s release command into CI pipelines and expects deterministic, machine-readable output.
-
-## 5. Key Features
-- **Setup CLI (`index.js`)**
-  - Installs dev dependencies (`standard-version`, `commitlint`, `husky`).
-  - Configures package scripts (`npm run release`, `release:major/minor/patch`, `release:first`).
-  - Creates Husky hooks and commitlint configuration.
-  - Generates release helper script and ensures executable permissions (POSIX-friendly).
-- **Release Helper (`scripts/release.js`)**
-  - Detects release type from CLI args or npm context.
-  - Runs project tests via detected package manager before releasing.
-  - Invokes `standard-version`, passing the preload script via `NODE_OPTIONS`.
-  - Supports first release mode that sets version to 0.0.1 for new projects.
-  - Stays focused on repository assets only (website updates are intentionally manual to avoid cross-project impacts).
-- **Preload Patching (`scripts/preload/fs-f-ok.cjs`)**
-  - Hooks Node’s module loader to transparently replace deprecated `fs.F_OK` usages in `standard-version` without altering `node_modules`.
-- **Website & Documentation**
-  - Professional landing page in `web/` directory.
-  - Automated GitHub Releases generation.
-  - Open Graph social media preview support.
-- **Testing**
-  - Suite executed via `node --test` covers setup utilities, release argument parsing, and the preload patch.
-
-## 6. Functional Requirements
-1. Running `npx @programinglive/commiter` inside a Node project should configure release tooling without manual edits.
-2. `npm run release` must:
-   - Run the project’s tests (if defined) with the correct package manager.
-   - Execute `standard-version`, passing the preload script via `NODE_OPTIONS`.
-   - Exit with non-zero status if tests or standard-version commands fail.
-3. CLI should provide friendly console output (status icons, instructions).
-4. The preload script must eliminate `[DEP0176] fs.F_OK` warnings on supported Node versions.
-5. Documentation (README, PRD, release notes) remains shipped with the package. Each project integrating Commiter must keep a `docs/PRD.md` file present in the repository. The release helper enforces this by warning when the PRD is missing so maintainers remember to author or update the document before tagging releases.
-
-## 7. Non-Functional Requirements
-- **Compatibility**: Supports Node.js 18+ (aligning with dependencies); tested on Windows/macOS/Linux.
-- **Maintainability**: Avoid direct edits to dependencies; wrap behavior in Commiter-controlled modules.
-- **Performance**: Release command overhead minimal (<1s additional startup time) beyond running tests and standard-version.
-- **Security**: No network requests during CLI execution beyond npm installs triggered by the user.
-
-## 8. User Journeys
-1. **Initial Setup**
-   - Run `npx @programinglive/commiter`.
-   - Tool installs dependencies, updates `package.json`, and scaffolds Husky hooks.
-   - Maintainer confirms success message and new scripts.
-2. **First Release**
-   - Developer runs `npm run release:first` for new projects.
-   - Commiter sets version to 0.0.1, runs tests, creates initial changelog and git tag.
-   - Project foundation established with proper semantic versioning.
-3. **Standard Release**
-   - Developer runs `npm run release minor` or `npm run release` (defaults to patch).
-   - Commiter runs tests, ensures preload patch prevents deprecation warnings, executes `standard-version`.
-   - Release completes with updated changelog and git tag.
-4. **CI Pipeline**
-   - CI job executes `npm run release -- --prerelease beta`.
-   - Logs show tests executed, no deprecation warnings, and release artifacts generated.
-
-## 9. Milestones & Roadmap
-- **v1.1.x** (current)
-  - Deprecation warning mitigation, enhanced tests, PRD + release documentation.
-- **Future Considerations**
-  - Support for monorepo detection (Lerna/Nx) to run scoped releases.
-  - Optional lint/test command customization via config file.
-  - Telemetry opt-in for release statistics (downloads, success rates).
-
-## 10. Risks & Mitigations
-- **Dependency API Changes**: Upstream packages may alter file paths. Mitigate with targeted module resolution and tests.
-- **User Customization Conflicts**: Custom scripts might skip tests. Provide documentation for overriding behavior.
-- **Platform Differences**: Windows path quoting; addressed via `buildPreloadFlag` helper.
-
-## 11. Release & QA Checklist
-- [x] `npm test` (alias for `node --test`) passes.
-- [x] Manual run of `node scripts/release.js --help` shows no `[DEP0176]` warning.
-- [ ] Update `CHANGELOG.md` (handled by standard-version during actual release).
-- [ ] Verify README reflects latest setup instructions before shipping.
-
-## 12. Appendices
-- **Release Notes**: See `docs/release-notes/` for per-change summaries.
-- **Testing Artifacts**: `test/` directory contains Node test runner suites.
+## Verification
+- Automated tests in `test/usage-warning.test.js`.
+- Manual verification of CLI output.

package/docs/release-notes/RELEASE_NOTES.md

@@ -4,6 +4,7 @@ This document summarizes every published version of `@programinglive/commiter`.
 
 | Version | Date | Highlights |
 |---------|------|------------|
+| 1.2.18 | 2026-01-01 | **release-notes:** add 1.2.17 entry (0a79779) |
 | 1.2.17 | 2025-12-26 | **web:** update homepage for v1.2.16 release (c4ba36e) |
 | 1.2.16 | 2025-12-13 | upgrade to node 20 and update npm for OIDC (5f7d9a0) |
 | 1.2.15 | 2025-12-13 | remove registry-url to fix OIDC auth conflict (c49b6e8) |
@@ -75,6 +76,16 @@ This document summarizes every published version of `@programinglive/commiter`.
 
 
 
+
+
+## 1.2.18 – 📝 Documentation
+
+Released on **2026-01-01**.
+
+- **release-notes:** add 1.2.17 entry (0a79779)
+- **web:** refresh homepage content for v1.2.17 (2fc6666)
+- add usage warning and MCP dev-workflow tip (df7bc00)
+- add automated tests for usage warnings (af6283e)
 
 ## 1.2.17 – 📝 Documentation
 

package/index.js

@@ -37,6 +37,19 @@ function copyRecursiveSync(src, dest) {
 }
 
 function setupCommiter() {
+  const args = process.argv.slice(2);
+
+  // If arguments are passed, it's likely someone is trying to use this as a commit tool
+  if (args.length > 0) {
+    console.error('\n⚠️  WARNING: @programinglive/commiter is a SETUP and RELEASE tool, NOT a commit tool.');
+    console.error('👉 To commit your changes, please use standard git commands:');
+    console.error('   git add .');
+    console.error('   git commit -m "your message"\n');
+    console.error('💡 TIP for AI: Use the `@programinglive/dev-workflow-mcp-server` to handle commits and releases properly.');
+    console.error('❌ If you meant to setup this project, run without arguments.\n');
+    process.exit(1);
+  }
+
   console.log('🚀 Setting up Commiter...\n');
 
   // Check if package.json exists

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@programinglive/commiter",
-  "version": "1.2.17",
+  "version": "1.2.18",
   "description": "Commiter keeps repositories release-ready by enforcing conventional commits, generating icon-rich changelog entries, and orchestrating semantic version bumps without manual toil. It bootstraps Husky hooks, commitlint rules, and release scripts that inspect history, detect framework-specific test commands, run them automatically, tag git releases, coordinate npm publishing, surface release metrics, enforce project-specific checks, and give maintainers observability across distributed teams. Plus!",
   "main": "index.js",
   "bin": {
@@ -88,8 +88,8 @@
     ]
   },
   "devDependencies": {
-    "@commitlint/cli": "^20.1.0",
-    "@commitlint/config-conventional": "^20.0.0",
+    "@commitlint/cli": "^20.2.0",
+    "@commitlint/config-conventional": "^20.2.0",
     "husky": "^9.1.7",
     "standard-version": "^9.5.0"
   }

package/scripts/release.cjs

@@ -63,7 +63,7 @@ function getNpmRunArgument(env = process.env) {
 
 function buildStandardVersionArgs({ releaseType, extraArgs }) {
   const args = [];
-  
+
   // Handle --first-release flag
   const isFirstRelease = Array.isArray(extraArgs) && extraArgs.includes('--first-release');
   if (isFirstRelease) {
@@ -75,6 +75,11 @@ function buildStandardVersionArgs({ releaseType, extraArgs }) {
     const isValid = VALID_RELEASE_TYPES.has(normalized) || SEMVER_REGEX.test(normalized);
     if (!isValid) {
       const allowed = Array.from(VALID_RELEASE_TYPES).join(', ');
+      console.error('\n⚠️  WARNING: Unknown release type or command detected.');
+      console.error('👉 If you are trying to commit changes, please use standard git commands:');
+      console.error('   git add .');
+      console.error('   git commit -m "your message"\n');
+      console.error('💡 TIP for AI: Use the `@programinglive/dev-workflow-mcp-server` to handle commits and releases properly.');
       throw new Error(`Unknown release type "${normalized}". Use one of ${allowed} or a valid semver version.`);
     }
     args.push('--release-as', normalized);

package/web/index.html

@@ -66,7 +66,7 @@
             <div class="hero-content">
                 <div class="hero-badge">
                     <span class="badge-dot"></span>
-                    <span>v1.2.16 - Latest Release</span>
+                    <span>v1.2.17 - Latest Release</span>
                 </div>
                 <h1 class="hero-title">
                     Ship Releases with <span class="gradient-text">Confidence</span>
@@ -90,7 +90,7 @@
                 </div>
                 <div class="hero-stats">
                     <div class="stat-item">
-                        <div class="stat-value">1.2.16</div>
+                        <div class="stat-value">1.2.17</div>
                         <div class="stat-label">Latest Version</div>
                     </div>
                     <div class="stat-item">
@@ -388,6 +388,12 @@
                 <!-- RELEASES_TIMELINE:START -->
                 <div class="release-item">
                     <div class="release-badge">Latest</div>
+                    <div class="release-version">v1.2.17</div>
+                    <div class="release-date">December 26, 2025</div>
+                    <div class="release-type">📝 Documentation</div>
+                    <p class="release-description">web: update homepage for the v1.2.16 release spotlight</p>
+                </div>
+                <div class="release-item">
                     <div class="release-version">v1.2.16</div>
                     <div class="release-date">December 13, 2025</div>
                     <div class="release-type">👷 Continuous Integration</div>
@@ -417,6 +423,12 @@
                     <div class="release-type">🧹 Chores</div>
                     <p class="release-description">cleanup and add deployment scripts</p>
                 </div>
+                <div class="release-item">
+                    <div class="release-version">v1.2.11</div>
+                    <div class="release-date">December 11, 2025</div>
+                    <div class="release-type">🧹 Chores</div>
+                    <p class="release-description">cleanup and add deployment scripts</p>
+                </div>
                 <!-- RELEASES_TIMELINE:END -->
             </div>
             <div class="releases-cta">