@programinglive/commiter 1.0.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +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.

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +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.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +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.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +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)

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+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.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

@@ -0,0 +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).

package/LICENSE

@@ -0,0 +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.

package/PUBLISH.md

@@ -0,0 +1,116 @@
+# Publishing to NPM
+
+This guide explains how to publish the `@programinglive/commiter` package to npm.
+
+## Prerequisites
+
+1. **NPM Account**: Create an account at [npmjs.com](https://www.npmjs.com/)
+2. **Login to NPM**: Run `npm login` in your terminal
+3. **Organization Access**: Ensure you have access to the `@programinglive` organization on npm
+
+## Publishing Steps
+
+### 1. Login to NPM
+
+```bash
+npm login
+```
+
+Enter your npm credentials when prompted.
+
+### 2. Verify Package Configuration
+
+Check that `package.json` is correctly configured:
+
+```bash
+npm pack --dry-run
+```
+
+This shows what files will be included in the package.
+
+### 3. Publish the Package
+
+For the first publish:
+
+```bash
+npm publish --access public
+```
+
+**Note**: The `--access public` flag is required for scoped packages (@programinglive/commiter) to be publicly accessible.
+
+### 4. Verify Publication
+
+Check your package on npm:
+```
+https://www.npmjs.com/package/@programinglive/commiter
+```
+
+## Releasing New Versions
+
+After the initial publish, use the built-in release commands:
+
+### Patch Release (1.0.0 → 1.0.1)
+```bash
+npm run release:patch
+git push --follow-tags origin main
+npm publish
+```
+
+### Minor Release (1.0.0 → 1.1.0)
+```bash
+npm run release:minor
+git push --follow-tags origin main
+npm publish
+```
+
+### Major Release (1.0.0 → 2.0.0)
+```bash
+npm run release:major
+git push --follow-tags origin main
+npm publish
+```
+
+## Automated Release Workflow
+
+1. Make changes and commit using conventional commits
+2. Run the appropriate release command
+3. Push to GitHub with tags
+4. Publish to npm
+
+Example:
+```bash
+# Make changes
+git add .
+git commit -m "feat(cli): add interactive setup wizard"
+
+# Create release
+npm run release:minor
+
+# Push to GitHub
+git push --follow-tags origin main
+
+# Publish to npm
+npm publish
+```
+
+## Unpublishing (Emergency Only)
+
+If you need to unpublish a version within 72 hours:
+
+```bash
+npm unpublish @programinglive/commiter@1.0.0
+```
+
+**Warning**: Unpublishing is permanent and should only be used in emergencies.
+
+## Package Visibility
+
+- **Public**: Anyone can install and use the package
+- **Open Source**: MIT licensed - users can modify and distribute
+- **Free**: No cost to install or use
+
+## Support
+
+For issues or questions:
+- GitHub Issues: https://github.com/programinglive/commiter/issues
+- NPM Package: https://www.npmjs.com/package/@programinglive/commiter

package/README.md

@@ -0,0 +1,177 @@
+# Commiter 🚀
+
+A standardized commit convention and release management tool for your repository using `standard-version`.
+
+## Features
+
+- ✅ **Enforced Commit Conventions** - Uses Conventional Commits format
+- 🎯 **Automated Versioning** - Semantic versioning (major, minor, patch)
+- 📝 **Changelog Generation** - Automatic CHANGELOG.md with icons
+- 🔒 **Git Hooks** - Pre-commit and commit-msg validation via Husky
+- 🎨 **Icon Support** - Each commit type has a dedicated icon in releases
+
+## Installation
+
+Install the package globally or as a dev dependency in your project:
+
+```bash
+# Install globally
+npm install -g @programinglive/commiter
+
+# Or install as dev dependency
+npm install --save-dev @programinglive/commiter
+
+# Or use npx (no installation required)
+npx @programinglive/commiter
+```
+
+After installation in your project, the Husky hooks will be automatically set up for commit message validation.
+
+## Commit Message Format
+
+All commits must follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+<footer>
+```
+
+### Commit Types with Icons
+
+| Type | Icon | Description | Changelog Section |
+|------|------|-------------|-------------------|
+| `feat` | ✨ | New feature | ✨ Features |
+| `fix` | 🐛 | Bug fix | 🐛 Bug Fixes |
+| `perf` | ⚡ | Performance improvement | ⚡ Performance |
+| `refactor` | ♻️ | Code refactoring | ♻️ Refactors |
+| `docs` | 📝 | Documentation changes | 📝 Documentation |
+| `style` | 💄 | Code style changes | 💄 Styles |
+| `test` | ✅ | Test additions/changes | ✅ Tests |
+| `build` | 🏗️ | Build system changes | 🏗️ Build System |
+| `ci` | 👷 | CI/CD changes | 👷 Continuous Integration |
+| `chore` | 🧹 | Maintenance tasks | 🧹 Chores |
+| `revert` | ⏪ | Revert previous commit | ⏪ Reverts |
+
+### Examples
+
+```bash
+# Feature
+git commit -m "feat(auth): add JWT authentication"
+
+# Bug fix
+git commit -m "fix(api): resolve null pointer exception"
+
+# Breaking change
+git commit -m "feat(api)!: redesign user endpoint
+
+BREAKING CHANGE: The user endpoint now returns different data structure"
+
+# With scope and body
+git commit -m "perf(database): optimize query performance
+
+Reduced query time by 50% using indexed columns"
+```
+
+## Release Commands
+
+### Patch Release (1.0.0 → 1.0.1)
+
+For bug fixes and minor changes:
+
+```bash
+npm run release:patch
+```
+
+### Minor Release (1.0.0 → 1.1.0)
+
+For new features (backwards compatible):
+
+```bash
+npm run release:minor
+```
+
+### Major Release (1.0.0 → 2.0.0)
+
+For breaking changes:
+
+```bash
+npm run release:major
+```
+
+### Automatic Release
+
+Let `standard-version` determine the version bump based on commits:
+
+```bash
+npm run release
+```
+
+## What Happens During Release?
+
+1. 📊 Analyzes commits since last release
+2. 🔢 Bumps version in `package.json`
+3. 📝 Updates `CHANGELOG.md` with icons
+4. 🏷️ Creates a git tag
+5. 💾 Commits changes with format: `chore(release): v1.2.3 🚀`
+
+## Push Your Release
+
+After running a release command, push to remote:
+
+```bash
+git push --follow-tags origin main
+```
+
+## Pre-commit Hooks
+
+The following hooks are automatically enforced:
+
+- **commit-msg**: Validates commit message format using commitlint
+- **pre-commit**: Runs tests before allowing commits
+
+## Configuration Files
+
+- `package.json` - Contains `standard-version` configuration
+- `commitlint.config.js` - Commitlint rules
+- `.husky/commit-msg` - Commit message validation hook
+- `.husky/pre-commit` - Pre-commit test hook
+
+## Troubleshooting
+
+### Commit message validation fails
+
+Ensure your commit message follows the format:
+```
+type(scope): subject
+```
+
+Valid types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
+
+### First release
+
+If this is your first release and you don't have a version tag yet:
+
+```bash
+npm run release -- --first-release
+```
+
+### Dry run
+
+To see what would happen without making changes:
+
+```bash
+npm run release -- --dry-run
+```
+
+## Contributing
+
+Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+## License
+
+MIT License - see the [LICENSE](LICENSE) file for details.
+
+This project is open source and free to use, modify, and distribute at your own risk.

package/SECURITY.md

@@ -0,0 +1,30 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in `@programinglive/commiter`, please report it responsibly.
+
+Send your report to: [security@programinglive.com](mailto:security@programinglive.com).
+
+Please include:
+- A detailed description of the vulnerability
+- Steps to reproduce the issue
+- Any potential impact
+- Optional: Suggested mitigation or patch
+
+We aim to respond within **48 hours** and will keep you informed of our progress.
+
+## Supported Versions
+
+We support the latest released version of the package. Please ensure you are running the most recent version before reporting issues.
+
+## Disclosure Policy
+
+We follow a coordinated disclosure process:
+1. Acknowledge receipt of your report within 48 hours
+2. Assess the vulnerability and determine severity
+3. Fix the issue and prepare a release
+4. Credit the reporter (if desired)
+5. Publish a security advisory detailing the fix
+
+Thank you for helping keep our project secure!

package/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

package/index.js

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+
+/**
+ * Commiter - Commit convention tooling for standard-version releases
+ * 
+ * This package helps enforce conventional commits and automate releases
+ * with beautiful changelogs featuring icons for each commit type.
+ */
+
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+function setupCommiter() {
+  console.log('🚀 Setting up Commiter...\n');
+
+  // Check if package.json exists
+  if (!fs.existsSync('package.json')) {
+    console.error('❌ Error: package.json not found. Please run this in a Node.js project directory.');
+    process.exit(1);
+  }
+
+  try {
+    // Install dependencies
+    console.log('📦 Installing dependencies...');
+    execSync('npm install --save-dev standard-version @commitlint/cli @commitlint/config-conventional husky', {
+      stdio: 'inherit'
+    });
+
+    // Read package.json
+    const packageJsonPath = path.join(process.cwd(), 'package.json');
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+    // Add scripts
+    packageJson.scripts = packageJson.scripts || {};
+    packageJson.scripts.prepare = 'husky';
+    packageJson.scripts.release = 'standard-version';
+    packageJson.scripts['release:major'] = 'npm run release -- --release-as major';
+    packageJson.scripts['release:minor'] = 'npm run release -- --release-as minor';
+    packageJson.scripts['release:patch'] = 'npm run release -- --release-as patch';
+
+    // Add standard-version config
+    packageJson['standard-version'] = {
+      releaseCommitMessageFormat: 'chore(release): {{currentTag}} 🚀',
+      types: [
+        { type: 'feat', section: '✨ Features' },
+        { type: 'fix', section: '🐛 Bug Fixes' },
+        { type: 'perf', section: '⚡ Performance' },
+        { type: 'refactor', section: '♻️ Refactors' },
+        { type: 'docs', section: '📝 Documentation' },
+        { type: 'style', section: '💄 Styles' },
+        { type: 'test', section: '✅ Tests' },
+        { type: 'build', section: '🏗️ Build System' },
+        { type: 'ci', section: '👷 Continuous Integration' },
+        { type: 'chore', section: '🧹 Chores' },
+        { type: 'revert', section: '⏪ Reverts' }
+      ]
+    };
+
+    // Write updated package.json
+    fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+
+    // Create commitlint config
+    console.log('⚙️  Creating commitlint config...');
+    const commitlintConfig = `module.exports = { extends: ['@commitlint/config-conventional'] };\n`;
+    fs.writeFileSync('commitlint.config.js', commitlintConfig);
+
+    // Initialize Husky
+    console.log('🐶 Setting up Husky...');
+    execSync('npx husky init', { stdio: 'inherit' });
+
+    // Create commit-msg hook
+    const huskyDir = path.join(process.cwd(), '.husky');
+    if (!fs.existsSync(huskyDir)) {
+      fs.mkdirSync(huskyDir, { recursive: true });
+    }
+
+    const commitMsgHook = `#!/usr/bin/env sh
+
+npx --no -- commitlint --edit "$1"
+`;
+    fs.writeFileSync(path.join(huskyDir, 'commit-msg'), commitMsgHook);
+    fs.chmodSync(path.join(huskyDir, 'commit-msg'), 0o755);
+
+    console.log('\n✅ Commiter setup complete!\n');
+    console.log('📚 Available commands:');
+    console.log('  npm run release:major  - Create a major release (1.0.0 → 2.0.0)');
+    console.log('  npm run release:minor  - Create a minor release (1.0.0 → 1.1.0)');
+    console.log('  npm run release:patch  - Create a patch release (1.0.0 → 1.0.1)');
+    console.log('  npm run release        - Auto-detect version bump\n');
+    console.log('🎯 Commit format: type(scope): subject');
+    console.log('   Example: feat(auth): add user login\n');
+
+  } catch (error) {
+    console.error('❌ Error during setup:', error.message);
+    process.exit(1);
+  }
+}
+
+// Run setup if called directly
+if (require.main === module) {
+  setupCommiter();
+}
+
+module.exports = { setupCommiter };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@programinglive/commiter",
+  "version": "1.0.0",
+  "description": "Commit convention tooling for standard-version releases with beautiful changelogs",
+  "main": "index.js",
+  "bin": {
+    "commiter": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"No tests specified\"",
+    "prepare": "husky",
+    "release": "standard-version",
+    "release:major": "npm run release -- --release-as major",
+    "release:minor": "npm run release -- --release-as minor",
+    "release:patch": "npm run release -- --release-as patch"
+  },
+  "keywords": [
+    "commit",
+    "conventional-commits",
+    "standard-version",
+    "changelog",
+    "versioning",
+    "semantic-release",
+    "git-hooks",
+    "husky",
+    "commitlint"
+  ],
+  "author": "Programming Live",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/programinglive/commiter.git"
+  },
+  "bugs": {
+    "url": "https://github.com/programinglive/commiter/issues"
+  },
+  "homepage": "https://github.com/programinglive/commiter#readme",
+  "type": "commonjs",
+  "standard-version": {
+    "releaseCommitMessageFormat": "chore(release): {{currentTag}} 🚀",
+    "types": [
+      { "type": "feat", "section": "✨ Features" },
+      { "type": "fix", "section": "🐛 Bug Fixes" },
+      { "type": "perf", "section": "⚡ Performance" },
+      { "type": "refactor", "section": "♻️ Refactors" },
+      { "type": "docs", "section": "📝 Documentation" },
+      { "type": "style", "section": "💄 Styles" },
+      { "type": "test", "section": "✅ Tests" },
+      { "type": "build", "section": "🏗️ Build System" },
+      { "type": "ci", "section": "👷 Continuous Integration" },
+      { "type": "chore", "section": "🧹 Chores" },
+      { "type": "revert", "section": "⏪ Reverts" }
+    ]
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "husky": "^9.1.7",
+    "standard-version": "^9.5.0"
+  }
+}