gstatx 0.1.4 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -307,6 +307,7 @@ interface ClientOptions {
307
307
  ```bash
308
308
  # Install dependencies
309
309
  bun install
310
+ # Git hooks are automatically configured via postinstall script
310
311
 
311
312
  # Build the project
312
313
  bun run build
@@ -315,6 +316,25 @@ bun run build
315
316
  bun run src/index.ts contributors ./my-repo
316
317
  ```
317
318
 
319
+ **Note:** Git hooks are automatically set up when you run `bun install` (or `npm install`). The hooks configure `npm version` to use commit messages in the format `chore(version): bump v{VERSION}` and create tags named `v{VERSION}`. If you need to manually set up hooks, run:
320
+
321
+ ```bash
322
+ npm run setup:hooks
323
+ ```
324
+
325
+ ### Version Management
326
+
327
+ The project uses `npm version` to bump versions. When you run `npm version patch|minor|major`:
328
+
329
+ - The version in `package.json` is updated
330
+ - A commit is created with message: `chore(version): bump v{VERSION}`
331
+ - A git tag is created: `v{VERSION}`
332
+
333
+ **If you get an error that a tag already exists:**
334
+ - The version bump likely already succeeded. Check with `git tag -l` and `git log --oneline -5`
335
+ - If you need to re-run, delete the tag first: `git tag -d v{VERSION}`
336
+ - Or use `--force` flag: `npm version patch --force` (use with caution)
337
+
318
338
  ### Scripts
319
339
 
320
340
  - `bun run build` - Build the project
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gstatx",
3
- "version": "0.1.4",
3
+ "version": "0.2.0",
4
4
  "description": "Export stats of a repo or list of repos",
5
5
  "type": "module",
6
6
  "engines": {
@@ -24,6 +24,8 @@
24
24
  "scripts": {
25
25
  "build": "bun build src/index.ts --outdir dist --target node --minify && bun build src/lib.ts --outdir dist --target node --minify && tsc -p tsconfig.build.json",
26
26
  "prepack": "bun run build",
27
+ "postinstall": "./scripts/setup-git-hooks.sh",
28
+ "setup:hooks": "./scripts/setup-git-hooks.sh",
27
29
  "start": "bun run src/index.ts",
28
30
  "lint": "biome lint .",
29
31
  "format": "biome format --write .",
@@ -1,8 +0,0 @@
1
- export interface RepoContributor {
2
- name: string;
3
- email: string;
4
- commits: number;
5
- }
6
- export declare function getContributors(repoPath: string): Promise<RepoContributor[]>;
7
- export declare function showHelp(): void;
8
- export declare function listContributors(repoPaths: string[], showCommits?: boolean, configPath?: string): Promise<void>;