@sabahattinkalkan/gpulse 1.0.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/.github/ISSUE_TEMPLATE/bug_report.md +22 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- package/.github/workflows/ci.yml +15 -0
- package/CONTRIBUTING.md +33 -0
- package/LICENSE +21 -0
- package/README.md +107 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +702 -0
- package/package.json +55 -0
- package/src/commands/changelog.ts +167 -0
- package/src/commands/digest.ts +119 -0
- package/src/commands/health.ts +113 -0
- package/src/commands/review.ts +97 -0
- package/src/commands/standup.ts +121 -0
- package/src/commands/stats.ts +102 -0
- package/src/index.ts +25 -0
- package/src/lib/config.ts +24 -0
- package/src/lib/format.ts +54 -0
- package/src/lib/github.ts +54 -0
- package/src/utils/helpers.ts +44 -0
- package/tests/standup.test.ts +57 -0
- package/tsconfig.json +15 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug Report
|
|
3
|
+
about: Report a bug to help us improve
|
|
4
|
+
title: '[BUG] '
|
|
5
|
+
labels: bug
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
**Describe the bug**
|
|
9
|
+
A clear description of what the bug is.
|
|
10
|
+
|
|
11
|
+
**To Reproduce**
|
|
12
|
+
Steps to reproduce:
|
|
13
|
+
1. Run `gpulse ...`
|
|
14
|
+
2. See error
|
|
15
|
+
|
|
16
|
+
**Expected behavior**
|
|
17
|
+
What you expected to happen.
|
|
18
|
+
|
|
19
|
+
**Environment**
|
|
20
|
+
- OS: [e.g. macOS 14, Ubuntu 24]
|
|
21
|
+
- Node.js: [e.g. 20.10]
|
|
22
|
+
- git-pulse version: [e.g. 1.0.0]
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature Request
|
|
3
|
+
about: Suggest a new feature or command
|
|
4
|
+
title: '[FEAT] '
|
|
5
|
+
labels: enhancement
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
**Is your feature related to a problem?**
|
|
9
|
+
A clear description of the problem. E.g. "I'm always frustrated when..."
|
|
10
|
+
|
|
11
|
+
**Describe the solution you'd like**
|
|
12
|
+
What you want to happen.
|
|
13
|
+
|
|
14
|
+
**Command example**
|
|
15
|
+
```bash
|
|
16
|
+
gpulse your-command --flag
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**Additional context**
|
|
20
|
+
Any other context or screenshots.
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Contributing to git-pulse
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing! Here's how to get started.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
git clone https://github.com/scuton-technology/ghx.git
|
|
9
|
+
cd ghx
|
|
10
|
+
npm install
|
|
11
|
+
npm run dev
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Development
|
|
15
|
+
|
|
16
|
+
- `npm run dev` — watch mode
|
|
17
|
+
- `npm run build` — production build
|
|
18
|
+
- `npm test` — run tests
|
|
19
|
+
- `npm run lint` — lint source
|
|
20
|
+
|
|
21
|
+
## Pull Requests
|
|
22
|
+
|
|
23
|
+
1. Fork the repo and create your branch from `main`
|
|
24
|
+
2. Write tests for new functionality
|
|
25
|
+
3. Ensure all tests pass
|
|
26
|
+
4. Use conventional commit messages (`feat:`, `fix:`, `docs:`, etc.)
|
|
27
|
+
5. Submit a PR with a clear description
|
|
28
|
+
|
|
29
|
+
## Code Style
|
|
30
|
+
|
|
31
|
+
- TypeScript strict mode
|
|
32
|
+
- ESM modules
|
|
33
|
+
- Use existing patterns in `src/commands/` for new commands
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Scuton Technology
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<pre align="center">
|
|
3
|
+
_
|
|
4
|
+
__ _ _ __ _ _| |___ ___
|
|
5
|
+
/ _` | '_ \| | | | / __|/ _ \
|
|
6
|
+
| (_| | |_) | |_| | \__ \ __/
|
|
7
|
+
\__, | .__/ \__,_|_|___/\___|
|
|
8
|
+
__/ | |
|
|
9
|
+
|___/|_| The Missing GitHub CLI Toolkit
|
|
10
|
+
</pre>
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
<p align="center">
|
|
14
|
+
<a href="https://www.npmjs.com/package/git-pulse"><img src="https://img.shields.io/npm/v/git-pulse.svg" alt="npm version"></a>
|
|
15
|
+
<a href="https://github.com/scuton-technology/ghx/actions"><img src="https://github.com/scuton-technology/ghx/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
|
16
|
+
<a href="https://github.com/scuton-technology/ghx/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/git-pulse.svg" alt="license"></a>
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
**gpulse** gives you the GitHub insights you actually need — right in your terminal. Standup reports, repo stats, changelogs, health checks, PR reviews, and digests. No browser required.
|
|
22
|
+
|
|
23
|
+
## Install
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install -g git-pulse
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Setup
|
|
30
|
+
|
|
31
|
+
Set your GitHub token (create one at [github.com/settings/tokens](https://github.com/settings/tokens)):
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
export GITHUB_TOKEN=ghp_your_token_here
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Commands
|
|
38
|
+
|
|
39
|
+
### `gpulse standup`
|
|
40
|
+
|
|
41
|
+
What did you do since yesterday? Shows commits, PRs, reviews, and issues.
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
gpulse standup # last 24 hours
|
|
45
|
+
gpulse standup -d 3 # last 3 days
|
|
46
|
+
gpulse standup -u octocat # specific user
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### `gpulse stats <owner/repo>`
|
|
50
|
+
|
|
51
|
+
Repository statistics — stars, forks, languages, top contributors.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
gpulse stats facebook/react
|
|
55
|
+
gpulse stats # current repo
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### `gpulse changelog`
|
|
59
|
+
|
|
60
|
+
Auto-generate changelog from commits between tags.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
gpulse changelog # last 2 tags
|
|
64
|
+
gpulse changelog --from v1.0 --to v2.0
|
|
65
|
+
gpulse changelog -o CHANGELOG.md # write to file
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### `gpulse health [owner/repo]`
|
|
69
|
+
|
|
70
|
+
Repository health score (A-F). Checks README, LICENSE, CI, activity, and more.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
gpulse health
|
|
74
|
+
gpulse health vercel/next.js
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `gpulse review`
|
|
78
|
+
|
|
79
|
+
Your PR dashboard — review requests, assigned PRs, and your open PRs.
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
gpulse review
|
|
83
|
+
gpulse review -r owner/repo # specific repo
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### `gpulse digest <owner/repo>`
|
|
87
|
+
|
|
88
|
+
Weekly/daily repository digest — commits, issues, PRs, releases.
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
gpulse digest # current repo, last 7 days
|
|
92
|
+
gpulse digest -d 1 # daily digest
|
|
93
|
+
gpulse digest rust-lang/rust # specific repo
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Requirements
|
|
97
|
+
|
|
98
|
+
- Node.js >= 18
|
|
99
|
+
- GitHub personal access token (`GITHUB_TOKEN` or `GH_TOKEN`)
|
|
100
|
+
|
|
101
|
+
## Contributing
|
|
102
|
+
|
|
103
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
104
|
+
|
|
105
|
+
## License
|
|
106
|
+
|
|
107
|
+
MIT - [Scuton Technology](https://scuton.com)
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|