@thunderkiller/video-clipper 1.3.1 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [1.5.0](https://github.com/AmreetKumarkhuntia/video-clipper/compare/v1.4.0...v1.5.0) (2026-03-20)
+
+### Features
+
+- **release:** publish to GitHub Packages alongside npm ([dee2e57](https://github.com/AmreetKumarkhuntia/video-clipper/commit/dee2e574eceb83a43be47155ad87060d74658713))
+
+# [1.4.0](https://github.com/AmreetKumarkhuntia/video-clipper/compare/v1.3.1...v1.4.0) (2026-03-20)
+
+### Features
+
+- **commitlint:** enforce conventional commit message format ([9d99882](https://github.com/AmreetKumarkhuntia/video-clipper/commit/9d998828617be72a81fbe4e72caa15eb28e88b82))
+
 ## [1.3.1](https://github.com/AmreetKumarkhuntia/video-clipper/compare/v1.3.0...v1.3.1) (2026-03-20)
 
 ### Bug Fixes

package/CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing
+
+## Getting Started
+
+```bash
+pnpm install
+```
+
+This will install all dependencies and set up git hooks via Husky.
+
+## Commit Message Format
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/) enforced by [commitlint](https://commitlint.js.org/).
+
+### Format
+
+```
+<type>(<scope>): <short description>
+
+- <detail 1>
+- <detail 2>
+```
+
+### Types
+
+| Type       | Description                                             | Version Bump           |
+| ---------- | ------------------------------------------------------- | ---------------------- |
+| `feat`     | New feature                                             | minor (1.0.0 -> 1.1.0) |
+| `fix`      | Bug fix                                                 | patch (1.0.0 -> 1.0.1) |
+| `docs`     | Documentation only                                      | none                   |
+| `refactor` | Code change that neither fixes a bug nor adds a feature | none                   |
+| `test`     | Adding or updating tests                                | none                   |
+| `chore`    | Maintenance tasks (deps, config, etc.)                  | none                   |
+| `style`    | Formatting, missing semicolons, etc. (no code change)   | none                   |
+| `perf`     | Performance improvement                                 | none                   |
+| `ci`       | CI/CD configuration changes                             | none                   |
+| `build`    | Build system or external dependency changes             | none                   |
+| `revert`   | Reverts a previous commit                               | none                   |
+
+### Rules
+
+- **type** (required): one from the table above
+- **scope** (recommended): kebab-case name of the feature area, e.g. `release`, `transcript-fetcher`, `llm-analyzer`
+- **short description** (required): lowercase, imperative mood, max 100 chars, no period at end
+- **body** (optional): pointwise with `-`, max 500 chars total
+
+### Examples
+
+```
+feat(clip-refiner): add overlap detection for adjacent segments
+
+- detect when refined segments overlap by more than 2s
+- merge overlapping segments and keep the higher-scored one
+```
+
+```
+fix(release): add @semantic-release/npm to update package.json version
+
+- add @semantic-release/npm with npmPublish: false
+- npm publish remains a separate workflow step
+```
+
+```
+docs(readme): add advanced examples section
+```
+
+### Breaking Changes
+
+Add `BREAKING CHANGE:` in the commit body or `!` after the type to trigger a major version bump:
+
+```
+feat(config)!: rename ENV_VAR to NEW_ENV_VAR
+
+BREAKING CHANGE: ENV_VAR is no longer supported, use NEW_ENV_VAR instead
+```
+
+## Git Hooks
+
+The following hooks run automatically on every commit:
+
+| Hook         | What it runs                                                  |
+| ------------ | ------------------------------------------------------------- |
+| `pre-commit` | `lint-staged` (Prettier), `type-check` (tsc), `test` (vitest) |
+| `commit-msg` | `commitlint` (validates commit message format)                |
+
+If your commit is rejected, check the error output — it will tell you exactly which rule was violated.
+
+## Code Style
+
+- TypeScript only — no plain `.js` files
+- Prettier handles formatting automatically via `lint-staged`
+- Run `pnpm format` to format all files manually
+- Run `pnpm type-check` to check for type errors
+
+## Testing
+
+- Write unit tests for pure functions
+- Test files live in `tests/` at the project root
+- Run `pnpm test` to run all tests
+- Run `pnpm test:watch` for watch mode

package/commitlint.config.js

@@ -0,0 +1,25 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',
+        'fix',
+        'docs',
+        'refactor',
+        'test',
+        'chore',
+        'style',
+        'perf',
+        'ci',
+        'build',
+        'revert',
+      ],
+    ],
+    'scope-case': [2, 'always', 'kebab-case'],
+    'subject-max-length': [2, 'always', 100],
+    'body-max-line-length': [2, 'always', 500],
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thunderkiller/video-clipper",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "CLI that analyzes YouTube transcripts with an LLM to find interesting moments and cut clips",
   "license": "ISC",
   "author": "",
@@ -11,6 +11,10 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AmreetKumarkhuntia/video-clipper.git"
+  },
   "scripts": {
     "start": "tsx src/index.ts",
     "build": "tsc",
@@ -49,6 +53,8 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
+    "@commitlint/cli": "^20.5.0",
+    "@commitlint/config-conventional": "^20.5.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^12.0.6",