ghusage 0.0.0-stage → 0.1.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.
Files changed (4) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +209 -2
  3. package/package.json +39 -4
  4. package/src/cli.js +147 -0
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,210 @@
1
- # Temporary Holding Version
1
+ # ghusage
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **Know what you actually did on GitHub.**
4
+
5
+ `ghusage` is a command-line tool and terminal UI that analyzes a developer's
6
+ GitHub activity. It goes beyond contribution graphs and treats a pull request
7
+ as a process: the commits in it, the reviews and their states, inline review
8
+ comments versus conversation comments, review threads, force pushes, and the
9
+ full timeline of what happened, by whom, and when.
10
+
11
+ It keeps your own activity separate from activity by other people and by
12
+ bots, so "comments written" and "comments received" stay apart, a merge you
13
+ performed is not confused with your pull request being merged, and CI
14
+ results are never counted as something you did.
15
+
16
+ ```text
17
+ $ ghusage overview --since 7d
18
+ Overview octocat 2026-11-15 00:00 → 2026-11-21 19:24 (Asia/Tokyo)
19
+ Commits 42 (1 merge)
20
+ PRs created 5
21
+ PRs merged (yours) 4
22
+ Merges you performed 6
23
+ Reviews submitted 11 (approved 7, changes requested 1, commented 3) on 9 PRs
24
+ Comments written 38 (conversation 9, inline 26, review summary 3)
25
+ Review thread replies 12
26
+ Active PRs 17 (with anyone's activity: 21)
27
+ ...
28
+ Coverage: complete (last sync: 2026-11-21 19:20)
29
+ ```
30
+
31
+ (The numbers above are illustrative.)
32
+
33
+ ## Features
34
+
35
+ - **Period reports**: overview, daily, weekly (Monday weeks), monthly
36
+ (calendar months), per repository, pull requests, reviews, comments and
37
+ issues.
38
+ - **Pull request detail**: `ghusage pr <url> --timeline` shows commits,
39
+ reviews, inline and conversation comments, review threads, force pushes,
40
+ review requests, labels, merges and CI results of a single pull request in
41
+ order.
42
+ - **Precise definitions**: every number has a documented definition. Unique
43
+ counts (such as "reviewed PRs") are labeled as such. Current-state values
44
+ (open PRs, review thread resolution) are marked as current state.
45
+ - **Honest about gaps**: every report shows data coverage. Missing or
46
+ partially fetched ranges are reported, and `--require-complete` turns
47
+ incomplete data into a non-zero exit code for scripts.
48
+ - **Local cache**: data is stored in a local SQLite database and synced
49
+ incrementally. Reports can run fully offline with `--offline`.
50
+ - **Machine-readable output**: `--format json` (versioned schema) and
51
+ `--format csv`.
52
+ - **Interactive TUI**: `ghusage tui` browses the same reports with keyboard
53
+ navigation while syncing in the background.
54
+
55
+ ## Install
56
+
57
+ ### npm
58
+
59
+ ```sh
60
+ npm install -g ghusage
61
+ ```
62
+
63
+ You only install `ghusage`. It is a small launcher; npm also installs the
64
+ prebuilt native binary for your OS and CPU (one of the `@ghusage/ghusage-*`
65
+ packages, as an optional dependency) and the launcher runs it. Supported
66
+ platforms: macOS (Apple Silicon, Intel), Linux (x64, arm64; statically
67
+ linked) and Windows (x64, arm64). Node.js 18 or newer is required. If your
68
+ package manager skips optional dependencies (`--omit=optional`) or a minimum
69
+ release age setting holds the binary package back, `ghusage` exits with an
70
+ explanation. `GHUSAGE_BINARY` can point the
71
+ launcher at a binary you built yourself.
72
+
73
+ ### From source
74
+
75
+ With a Rust toolchain (Rust 1.89 or newer):
76
+
77
+ ```sh
78
+ cargo install --git https://github.com/tanahiro2010/ghusage
79
+ ```
80
+
81
+ Or build a local checkout:
82
+
83
+ ```sh
84
+ git clone https://github.com/tanahiro2010/ghusage
85
+ cd ghusage
86
+ cargo build --release
87
+ ./target/release/ghusage --help
88
+ ```
89
+
90
+ ## Authentication
91
+
92
+ `ghusage` reads a GitHub token from the first of these that is available:
93
+
94
+ 1. `--token-file <PATH>` (on Unix the file must not be readable by group or
95
+ others, for example `chmod 600`)
96
+ 2. the `GH_TOKEN` environment variable
97
+ 3. the `GITHUB_TOKEN` environment variable
98
+ 4. the output of `gh auth token` (if the GitHub CLI is installed and logged
99
+ in)
100
+
101
+ Check which credentials are used:
102
+
103
+ ```sh
104
+ ghusage auth status
105
+ ```
106
+
107
+ By default `ghusage` analyzes everything the token can see, including private
108
+ repositories. Use `--public-only` to fetch and show public repositories only.
109
+
110
+ See [Authentication](docs/guide/authentication.md) for token scopes and
111
+ details.
112
+
113
+ ## Quick start
114
+
115
+ ```sh
116
+ # Fetch the last 30 days into the local cache
117
+ ghusage sync
118
+
119
+ # Overview of the last 7 days (the default command)
120
+ ghusage
121
+
122
+ # Activity per day / week / month
123
+ ghusage daily --since 14d
124
+ ghusage weekly
125
+ ghusage monthly --since 2026-01-01
126
+
127
+ # Pull requests you were active in, with activity statistics
128
+ ghusage prs --details
129
+
130
+ # One pull request with its full timeline
131
+ ghusage pr https://github.com/OWNER/REPO/pull/123 --timeline
132
+
133
+ # Use only the cache; never contact GitHub
134
+ ghusage overview --offline
135
+
136
+ # JSON for scripts; fail with exit code 6 if data is incomplete
137
+ ghusage weekly --format json --require-complete
138
+
139
+ # Interactive terminal UI
140
+ ghusage tui
141
+ ```
142
+
143
+ Report commands sync missing ranges automatically before showing results
144
+ (unless `--offline` is given). If GitHub cannot be reached, they warn and
145
+ show the cached data.
146
+
147
+ ## Commands
148
+
149
+ | Command | What it shows |
150
+ |---|---|
151
+ | `overview` | Summary of the period (default command) |
152
+ | `daily`, `weekly`, `monthly` | Activity per day, Monday-based week, or calendar month |
153
+ | `repos` | Activity per repository |
154
+ | `prs` | Pull requests with activity in the period (`--details`, `--sort`, `--state`, `--all-participants`) |
155
+ | `reviews` | Reviews you submitted and reviews you received |
156
+ | `comments` | Comments you wrote and comments on your pull requests |
157
+ | `issues` | Issues you opened, closed or reopened |
158
+ | `pr <URL>` | Detail and timeline of one pull request |
159
+ | `tui` | Interactive terminal UI |
160
+ | `sync` | Fetch data from GitHub into the local cache |
161
+ | `doctor` | Check authentication, cache and connectivity |
162
+ | `auth status` | Show which credentials are used |
163
+ | `cache status`, `cache clear` | Inspect or delete the local cache |
164
+
165
+ Global options such as `--since`, `--until`, `--timezone`, `--repo`,
166
+ `--owner`, `--visibility`, `--ownership`, `--user` and `--format` work with
167
+ every command. See the [CLI reference](docs/reference/cli.md).
168
+
169
+ ## Documentation
170
+
171
+ The full documentation lives in [`docs/`](docs/index.md) and is built as the
172
+ documentation site at <https://tanahiro2010.github.io/ghusage/>.
173
+
174
+ - [Getting started](docs/guide/getting-started.md)
175
+ - [Authentication](docs/guide/authentication.md)
176
+ - [Syncing and the local cache](docs/guide/syncing.md)
177
+ - [Terminal UI](docs/guide/tui.md)
178
+ - [CLI reference](docs/reference/cli.md)
179
+ - [Metric definitions](docs/reference/metrics.md)
180
+ - [Periods and time zones](docs/reference/time.md)
181
+ - [JSON and CSV output](docs/reference/json.md)
182
+ - [Known limitations](docs/reference/limitations.md)
183
+ - [Privacy](docs/reference/privacy.md)
184
+
185
+ ## Privacy
186
+
187
+ - Data fetched from GitHub is stored only in a local SQLite database on your
188
+ machine. Tokens are never written to the cache.
189
+ - `ghusage` sends no telemetry. It only talks to the GitHub API (or the
190
+ endpoint you configure).
191
+ - JSON and CSV output hide the names, titles and URLs of private
192
+ repositories unless you pass `--include-private`. Table output in your
193
+ terminal shows them.
194
+ - `ghusage cache clear` deletes all cached GitHub data.
195
+
196
+ See [Privacy](docs/reference/privacy.md) for details.
197
+
198
+ ## Known limitations
199
+
200
+ GitHub's APIs do not expose everything. For example, commits are found on
201
+ default branches and inside pull requests only (work on other branches
202
+ without a pull request is not counted), push times and the history of review
203
+ thread resolution are not available, and search results are capped at 1000
204
+ per query. `ghusage` reports these gaps instead of guessing. Read
205
+ [Known limitations](docs/reference/limitations.md) before relying on the
206
+ numbers.
207
+
208
+ ## License
209
+
210
+ Licensed under the [Apache License, Version 2.0](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,41 @@
1
1
  {
2
2
  "name": "ghusage",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "description": "Know what you actually did on GitHub: commits, pull requests, reviews and the activity inside pull requests.",
5
+ "keywords": [
6
+ "github",
7
+ "cli",
8
+ "tui",
9
+ "analytics",
10
+ "pull-requests",
11
+ "code-review"
12
+ ],
13
+ "homepage": "https://github.com/tanahiro2010/ghusage",
14
+ "repository": {
15
+ "type": "git",
16
+ "url": "git+https://github.com/tanahiro2010/ghusage.git"
17
+ },
18
+ "bugs": "https://github.com/tanahiro2010/ghusage/issues",
19
+ "license": "Apache-2.0",
20
+ "bin": {
21
+ "ghusage": "./src/cli.js"
22
+ },
23
+ "files": [
24
+ "src/cli.js"
25
+ ],
26
+ "engines": {
27
+ "node": ">=18"
28
+ },
29
+ "type": "module",
30
+ "publishConfig": {
31
+ "access": "public"
32
+ },
33
+ "optionalDependencies": {
34
+ "@ghusage/ghusage-darwin-arm64": "0.1.0",
35
+ "@ghusage/ghusage-darwin-x64": "0.1.0",
36
+ "@ghusage/ghusage-linux-arm64": "0.1.0",
37
+ "@ghusage/ghusage-linux-x64": "0.1.0",
38
+ "@ghusage/ghusage-win32-arm64": "0.1.0",
39
+ "@ghusage/ghusage-win32-x64": "0.1.0"
40
+ }
41
+ }
package/src/cli.js ADDED
@@ -0,0 +1,147 @@
1
+ #!/usr/bin/env node
2
+ // Runs the native ghusage binary from the platform package that npm
3
+ // installed as an optional dependency.
4
+ import { spawn } from "node:child_process";
5
+ import { chmodSync, realpathSync, statSync } from "node:fs";
6
+ import { createRequire } from "node:module";
7
+ import process from "node:process";
8
+ import { fileURLToPath } from "node:url";
9
+
10
+ const require = createRequire(import.meta.url);
11
+ const { version } = require("../package.json");
12
+
13
+ const PACKAGES = {
14
+ "darwin-arm64": "@ghusage/ghusage-darwin-arm64",
15
+ "darwin-x64": "@ghusage/ghusage-darwin-x64",
16
+ "linux-arm64": "@ghusage/ghusage-linux-arm64",
17
+ "linux-x64": "@ghusage/ghusage-linux-x64",
18
+ "win32-arm64": "@ghusage/ghusage-win32-arm64",
19
+ "win32-x64": "@ghusage/ghusage-win32-x64",
20
+ };
21
+
22
+ /** Name of the platform package for this platform, if one exists. */
23
+ export function nativePackageName(platform = process.platform, arch = process.arch) {
24
+ return PACKAGES[`${platform}-${arch}`];
25
+ }
26
+
27
+ /** Path of the binary inside a platform package. */
28
+ export function nativeBinarySubpath(platform = process.platform) {
29
+ return platform === "win32" ? "bin/ghusage.exe" : "bin/ghusage";
30
+ }
31
+
32
+ /**
33
+ * Decides what to run: the native binary, or an error message.
34
+ * `GHUSAGE_BINARY` overrides the binary (e.g. one built from source).
35
+ */
36
+ export function resolveRuntime({
37
+ platform = process.platform,
38
+ arch = process.arch,
39
+ env = process.env,
40
+ resolvePath = (id) => require.resolve(id),
41
+ } = {}) {
42
+ if (env.GHUSAGE_BINARY) {
43
+ return { command: env.GHUSAGE_BINARY };
44
+ }
45
+ const target = `${platform}-${arch}`;
46
+ const pkg = nativePackageName(platform, arch);
47
+ if (pkg == null) {
48
+ return {
49
+ error:
50
+ `ghusage does not provide a native binary for ${target}.\n` +
51
+ "Build it from source: cargo install --git https://github.com/tanahiro2010/ghusage\n",
52
+ };
53
+ }
54
+ try {
55
+ return { command: resolvePath(`${pkg}/${nativeBinarySubpath(platform)}`) };
56
+ } catch {
57
+ return {
58
+ error:
59
+ `Missing optional native package "${pkg}@${version}" for ${target}. ` +
60
+ "It may be absent because of --omit=optional, --no-optional, or a minimum release age " +
61
+ "setting (npm --before / --min-release-age, mise minimum_release_age). " +
62
+ "Reinstall ghusage with optional dependencies enabled.\n",
63
+ };
64
+ }
65
+ }
66
+
67
+ /** Restores the executable bit if a package manager dropped it. */
68
+ export function ensureExecutable(path, platform = process.platform) {
69
+ if (platform === "win32") return undefined;
70
+ try {
71
+ if ((statSync(path).mode & 0o111) === 0) chmodSync(path, 0o755);
72
+ return undefined;
73
+ } catch (error) {
74
+ if (error && error.code === "ENOENT") {
75
+ return `ghusage native binary not found: ${path}\n`;
76
+ }
77
+ return `ghusage native binary is not executable: ${error instanceof Error ? error.message : error}\n`;
78
+ }
79
+ }
80
+
81
+ export function forwardedSignals(platform = process.platform) {
82
+ return platform === "win32" ? ["SIGINT", "SIGBREAK", "SIGHUP"] : ["SIGINT", "SIGTERM", "SIGHUP", "SIGQUIT"];
83
+ }
84
+
85
+ /** Runs the binary, forwarding signals, and resolves with how it ended. */
86
+ export function runNative(command, args) {
87
+ return new Promise((resolve) => {
88
+ const child = spawn(command, args, { stdio: "inherit" });
89
+ const handlers = forwardedSignals().map((signal) => {
90
+ const handler = () => child.kill(signal);
91
+ try {
92
+ process.on(signal, handler);
93
+ } catch {
94
+ // Some signals cannot be listened to on some platforms.
95
+ }
96
+ return [signal, handler];
97
+ });
98
+ const cleanup = () => handlers.forEach(([s, h]) => process.off(s, h));
99
+ child.on("error", (error) => {
100
+ cleanup();
101
+ resolve({ error, status: null, signal: null });
102
+ });
103
+ child.on("exit", (status, signal) => {
104
+ cleanup();
105
+ resolve({ status, signal });
106
+ });
107
+ });
108
+ }
109
+
110
+ export async function main(argv) {
111
+ const runtime = resolveRuntime();
112
+ if ("error" in runtime) {
113
+ process.stderr.write(runtime.error);
114
+ return 1;
115
+ }
116
+ const notExecutable = ensureExecutable(runtime.command);
117
+ if (notExecutable) {
118
+ process.stderr.write(notExecutable);
119
+ return 1;
120
+ }
121
+ const result = await runNative(runtime.command, argv);
122
+ if (result.error) {
123
+ process.stderr.write(`ghusage: failed to start ${runtime.command}: ${result.error.message}\n`);
124
+ return 1;
125
+ }
126
+ if (result.signal) {
127
+ // End the same way the binary did.
128
+ process.kill(process.pid, result.signal);
129
+ return 1;
130
+ }
131
+ return result.status ?? 1;
132
+ }
133
+
134
+ function isMainModule() {
135
+ const entry = process.argv[1];
136
+ if (!entry) return false;
137
+ const self = fileURLToPath(import.meta.url);
138
+ try {
139
+ return realpathSync(self) === realpathSync(entry);
140
+ } catch {
141
+ return self === entry;
142
+ }
143
+ }
144
+
145
+ if (isMainModule()) {
146
+ process.exitCode = await main(process.argv.slice(2));
147
+ }