@programinglive/commiter 1.1.0 → 1.1.3

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +1,28 @@
----
-name: Bug report
-about: Create a report to help us improve
-labels: bug
----
-
-## Describe the bug
-A clear and concise description of what the bug is.
-
-## To Reproduce
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '...'
-3. See error
-
-## Expected behavior
-A clear and concise description of what you expected to happen.
-
-## Screenshots or logs
-If applicable, add screenshots, logs, or stack traces to help explain your problem.
-
-## Environment
-- Package version:
-- Node.js version:
-- OS:
-
-## Additional context
-Add any other context about the problem here.
+---
+name: Bug report
+about: Create a report to help us improve
+labels: bug
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '...'
+3. See error
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots or logs
+If applicable, add screenshots, logs, or stack traces to help explain your problem.
+
+## Environment
+- Package version:
+- Node.js version:
+- OS:
+
+## Additional context
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Security Report
-    url: https://github.com/programinglive/commiter/security/policy
-    about: Please read our security policy before reporting vulnerabilities.
+blank_issues_enabled: false
+contact_links:
+  - name: Security Report
+    url: https://github.com/programinglive/commiter/security/policy
+    about: Please read our security policy before reporting vulnerabilities.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,20 @@
----
-name: Feature request
-about: Suggest an idea for this project
-labels: enhancement
----
-
-## Summary
-Describe the feature you would like to see.
-
-## Problem or Use Case
-What problem does this feature solve? Why is it needed?
-
-## Proposed Solution
-Describe your proposed solution or implementation ideas.
-
-## Alternatives
-List any alternative solutions or features you've considered.
-
-## Additional context
-Add any other context, mockups, or screenshots about the feature request here.
+---
+name: Feature request
+about: Suggest an idea for this project
+labels: enhancement
+---
+
+## Summary
+Describe the feature you would like to see.
+
+## Problem or Use Case
+What problem does this feature solve? Why is it needed?
+
+## Proposed Solution
+Describe your proposed solution or implementation ideas.
+
+## Alternatives
+List any alternative solutions or features you've considered.
+
+## Additional context
+Add any other context, mockups, or screenshots about the feature request here.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,24 +1,24 @@
-# Pull Request Checklist
-
-## Summary
-
-Describe the changes in this pull request.
-
-## Related Issues
-
-Link related issues (e.g. closes #123).
-
-## Testing
-
-- [ ] `npm install`
-- [ ] `npm test`
-- [ ] `npm run release -- --dry-run` (if release-related)
-
-## Checklist
-
-- [ ] I've read the [Code of Conduct](../CODE_OF_CONDUCT.md)
-- [ ] I've read the [Contributing Guidelines](../CONTRIBUTING.md)
-- [ ] My commits follow the Conventional Commits format (`type(scope): subject`)
-- [ ] Documentation has been updated if needed
-- [ ] New dependencies are justified and added to `package.json`
-- [ ] No `any` types were introduced (TypeScript rule)
+# Pull Request Checklist
+
+## Summary
+
+Describe the changes in this pull request.
+
+## Related Issues
+
+Link related issues (e.g. closes #123).
+
+## Testing
+
+- [ ] `npm install`
+- [ ] `npm test`
+- [ ] `npm run release -- --dry-run` (if release-related)
+
+## Checklist
+
+- [ ] I've read the [Code of Conduct](../CODE_OF_CONDUCT.md)
+- [ ] I've read the [Contributing Guidelines](../CONTRIBUTING.md)
+- [ ] My commits follow the Conventional Commits format (`type(scope): subject`)
+- [ ] Documentation has been updated if needed
+- [ ] New dependencies are justified and added to `package.json`
+- [ ] No `any` types were introduced (TypeScript rule)

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 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.1.3](https://github.com/programinglive/commiter/compare/v1.1.2...v1.1.3) (2025-11-05)
+
+### [1.1.2](https://github.com/programinglive/commiter/compare/v1.1.1...v1.1.2) (2025-11-05)
+
+
+### 🧹 Chores
+
+* auto-update release notes during release ([99d1043](https://github.com/programinglive/commiter/commit/99d104374794a6a46dc34e8a91fa8b30ae9b297b))
+
+### [1.1.1](https://github.com/programinglive/commiter/compare/v1.1.0...v1.1.1) (2025-11-05)
+
+
+### 🐛 Bug Fixes
+
+* remove fs.F_OK deprecation warning ([1b0652b](https://github.com/programinglive/commiter/commit/1b0652b88d1b095e1045994948f75ce8194f9d3a))
+
 ## [1.1.0](https://github.com/programinglive/commiter/compare/v1.0.12...v1.1.0) (2025-10-29)
 
 
@@ -46,46 +62,46 @@ All notable changes to this project will be documented in this file. See [standa
 
 * add release helper script and tests ([93f4235](https://github.com/programinglive/commiter/commit/93f4235c3cf2e34b77b78ba51c0337cf89e564df))
 
-### [1.0.6](https://github.com/programinglive/commiter/compare/v1.0.5...v1.0.6) (2025-10-19)
-
-### [1.0.5](https://github.com/programinglive/commiter/compare/v1.0.4...v1.0.5) (2025-10-19)
-
-
-### 🐛 Bug Fixes
-
-* allow release commits with emoji ([26c4afa](https://github.com/programinglive/commiter/commit/26c4afa26fc7c11c91ac576dcba197cba5d3d98a))
-
-### [1.0.4](https://github.com/programinglive/commiter/compare/v1.0.3...v1.0.4) (2025-10-19)
-
-
-### 🐛 Bug Fixes
-
-* ensure safe test default for initial release ([27d2ee3](https://github.com/programinglive/commiter/commit/27d2ee35d1e558ef459a61e41627305997621392))
-
-### [1.0.3](https://github.com/programinglive/commiter/compare/v1.0.2...v1.0.3) (2025-10-19)
-
-### [1.0.2](https://github.com/programinglive/commiter/compare/v1.0.1...v1.0.2) (2025-10-19)
-
-### [1.0.1](https://github.com/programinglive/commiter/compare/v1.0.0...v1.0.1) (2025-10-18)
-
-
-### 🐛 Bug Fixes
-
-* align commitlint config with project module type ([d051eac](https://github.com/programinglive/commiter/commit/d051eace5471d0c54fd8de6a3bede6a0df020dad))
-
-## 1.0.0 (2025-10-17)
-
-
-### ✨ Features
-
-* initial project setup with standard-version and conventional commits ([0accf6d](https://github.com/programinglive/commiter/commit/0accf6dba678c1946629aa3f1b691bea7e20cd95))
-
-
-### 📝 Documentation
-
-* add community health files and apply package tooling ([0fa802b](https://github.com/programinglive/commiter/commit/0fa802b6129053d3f32030cec561e5926dd09c42))
-
-
-### 🧹 Chores
-
-* update package metadata ([7c112f3](https://github.com/programinglive/commiter/commit/7c112f3d82e2c92ed31fa3e60fafd5ca0429184d))
+### [1.0.6](https://github.com/programinglive/commiter/compare/v1.0.5...v1.0.6) (2025-10-19)
+
+### [1.0.5](https://github.com/programinglive/commiter/compare/v1.0.4...v1.0.5) (2025-10-19)
+
+
+### 🐛 Bug Fixes
+
+* allow release commits with emoji ([26c4afa](https://github.com/programinglive/commiter/commit/26c4afa26fc7c11c91ac576dcba197cba5d3d98a))
+
+### [1.0.4](https://github.com/programinglive/commiter/compare/v1.0.3...v1.0.4) (2025-10-19)
+
+
+### 🐛 Bug Fixes
+
+* ensure safe test default for initial release ([27d2ee3](https://github.com/programinglive/commiter/commit/27d2ee35d1e558ef459a61e41627305997621392))
+
+### [1.0.3](https://github.com/programinglive/commiter/compare/v1.0.2...v1.0.3) (2025-10-19)
+
+### [1.0.2](https://github.com/programinglive/commiter/compare/v1.0.1...v1.0.2) (2025-10-19)
+
+### [1.0.1](https://github.com/programinglive/commiter/compare/v1.0.0...v1.0.1) (2025-10-18)
+
+
+### 🐛 Bug Fixes
+
+* align commitlint config with project module type ([d051eac](https://github.com/programinglive/commiter/commit/d051eace5471d0c54fd8de6a3bede6a0df020dad))
+
+## 1.0.0 (2025-10-17)
+
+
+### ✨ Features
+
+* initial project setup with standard-version and conventional commits ([0accf6d](https://github.com/programinglive/commiter/commit/0accf6dba678c1946629aa3f1b691bea7e20cd95))
+
+
+### 📝 Documentation
+
+* add community health files and apply package tooling ([0fa802b](https://github.com/programinglive/commiter/commit/0fa802b6129053d3f32030cec561e5926dd09c42))
+
+
+### 🧹 Chores
+
+* update package metadata ([7c112f3](https://github.com/programinglive/commiter/commit/7c112f3d82e2c92ed31fa3e60fafd5ca0429184d))

package/CODE_OF_CONDUCT.md

@@ -1,36 +1,36 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-We pledge to make participation in `@programinglive/commiter` open, welcoming, and harassment-free for everyone, regardless of age, body size, disability, ethnicity, gender identity or expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-**Positive behaviours**
-- Showing empathy and kindness toward other people
-- Respecting differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing when mistakes occur
-
-**Unacceptable behaviours**
-- Use of sexualized language or imagery, or unwelcome sexual attention
-- Trolling, insulting or derogatory comments, and personal attacks
-- Public or private harassment
-- Publishing others' private information without permission
-- Other conduct which would reasonably be considered inappropriate in a professional setting
-
-## Enforcement Responsibilities
-Project maintainers are responsible for clarifying standards of acceptable behaviour and will take appropriate corrective action in response to unacceptable behaviour. Maintainers have the right to remove, edit, or reject contributions that do not align with this Code of Conduct.
-
-## Scope
-This Code of Conduct applies within all project spaces and when an individual is officially representing the project in public spaces.
-
-## Enforcement
-Report incidents to `security@programinglive.com`. All complaints will be reviewed promptly and treated confidentially.
-
-## Enforcement Guidelines
-1. **Correction** – Private warning for minor violations and clarification of expectations.
-2. **Warning** – Consequence for a single serious violation or repeated minor violations.
-3. **Temporary Ban** – Temporary exclusion from community interactions when behaviour is unacceptable.
-4. **Permanent Ban** – Permanent removal from the community for sustained inappropriate behaviour or harassment.
-
-## Attribution
-Adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We pledge to make participation in `@programinglive/commiter` open, welcoming, and harassment-free for everyone, regardless of age, body size, disability, ethnicity, gender identity or expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+**Positive behaviours**
+- Showing empathy and kindness toward other people
+- Respecting differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing when mistakes occur
+
+**Unacceptable behaviours**
+- Use of sexualized language or imagery, or unwelcome sexual attention
+- Trolling, insulting or derogatory comments, and personal attacks
+- Public or private harassment
+- Publishing others' private information without permission
+- Other conduct which would reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+Project maintainers are responsible for clarifying standards of acceptable behaviour and will take appropriate corrective action in response to unacceptable behaviour. Maintainers have the right to remove, edit, or reject contributions that do not align with this Code of Conduct.
+
+## Scope
+This Code of Conduct applies within all project spaces and when an individual is officially representing the project in public spaces.
+
+## Enforcement
+Report incidents to `security@programinglive.com`. All complaints will be reviewed promptly and treated confidentially.
+
+## Enforcement Guidelines
+1. **Correction** – Private warning for minor violations and clarification of expectations.
+2. **Warning** – Consequence for a single serious violation or repeated minor violations.
+3. **Temporary Ban** – Temporary exclusion from community interactions when behaviour is unacceptable.
+4. **Permanent Ban** – Permanent removal from the community for sustained inappropriate behaviour or harassment.
+
+## Attribution
+Adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Programming Live
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Programming Live
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/PRD.md

@@ -0,0 +1,86 @@
+# Commiter Product Requirements Document (PRD)
+
+## 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.
+
+## 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.
+
+## 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.
+
+## 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`).
+  - 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` with additional flags (e.g., preload patch for deprecated APIs).
+- **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`.
+- **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.
+
+## 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. **Standard Release**
+   - Developer runs `npm run release minor`.
+   - Commiter runs tests, ensures preload patch prevents deprecation warnings, executes `standard-version`.
+   - Release completes with updated changelog and git tag.
+3. **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.