@ffflorian/gh-open 3.6.5 → 3.7.0

package/README.md

@@ -9,7 +9,7 @@ Open a GitHub repository in your browser.
 
 ## Installation
 
-ℹ️ This is a hybrid [CommonJS](https://nodejs.org/docs/latest/api/modules.html#modules-commonjs-modules) / [ESM](https://nodejs.org/api/esm.html#introduction) module.
+ℹ️ This is a pure [ESM](https://nodejs.org/api/esm.html#introduction) module.
 
 Run `yarn global add @ffflorian/gh-open` or `npm install -g @ffflorian/gh-open`.
 

package/dist/{cjs/RepositoryService.js → RepositoryService.js}

@@ -1,5 +1,5 @@
-import { promises as fsAsync } from 'fs';
-import path from 'path';
+import { promises as fsAsync } from 'node:fs';
+import path from 'node:path';
 import logdown from 'logdown';
 import { GitHubClient } from './GitHubClient.js';
 export class RepositoryService {

package/dist/{cjs/cli.js → cli.js}

@@ -1,12 +1,15 @@
 #!/usr/bin/env node
-import path from 'path';
+import path from 'node:path';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
 import { program as commander } from 'commander';
 import { findUp } from 'find-up';
 import open from 'open';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
 import { RepositoryService } from './RepositoryService.js';
-const { description, name, version } = require('../package.json');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJsonPath = path.join(__dirname, '../package.json');
+const { description, name, version } = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
 commander
     .name(name.replace(/^@[^/]+\//, ''))
     .description(description)

package/package.json

@@ -1,8 +1,8 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
-  "bin": "dist/cjs/cli.js",
+  "bin": "dist/cli.js",
   "dependencies": {
-    "axios": "1.7.2",
+    "axios": "1.7.3",
     "commander": "12.1.0",
     "find-up": "7.0.0",
     "logdown": "3.3.1",
@@ -12,19 +12,14 @@
   "devDependencies": {
     "http-status-codes": "2.3.0",
     "nock": "13.5.4",
-    "rimraf": "5.0.7",
-    "typescript": "5.5.2",
-    "vitest": "1.6.0"
+    "rimraf": "6.0.1",
+    "typescript": "5.5.4",
+    "vitest": "2.0.5"
   },
   "engines": {
     "node": ">= 18.0"
   },
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    }
-  },
+  "exports": "./dist/index.js",
   "files": [
     "dist"
   ],
@@ -36,21 +31,17 @@
     "typescript"
   ],
   "license": "GPL-3.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "module": "dist/index.js",
   "name": "@ffflorian/gh-open",
   "repository": "https://github.com/ffflorian/node-packages/tree/main/packages/gh-open",
   "scripts": {
-    "build": "yarn build:cjs && yarn build:esm && yarn generate:packagejson",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "generate:packagejson": "../../bin/generate-hybrid-package-json.sh",
     "start": "node --loader ts-node/esm src/cli.ts -d",
     "test": "vitest run"
   },
   "type": "module",
-  "version": "3.6.5",
-  "gitHead": "f7a6a79286e4eb85392b5f2d33942ab166142109"
+  "version": "3.7.0",
+  "gitHead": "f1a74d8ec9721d5b52a00e41b2ec73278e048290"
 }

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/esm/GitHubClient.d.ts

@@ -1,19 +0,0 @@
-export interface PullRequest {
-    _links: {
-        html: {
-            href: string;
-        };
-    };
-    head: {
-        ref: string;
-    };
-}
-export declare class GitHubClient {
-    private readonly apiClient;
-    constructor(timeout?: number);
-    getPullRequestByBranch(user: string, repository: string, branch: string): Promise<PullRequest | undefined>;
-    /**
-     * @see https://developer.github.com/v3/pulls/#list-pull-requests
-     */
-    getPullRequests(user: string, repository: string): Promise<PullRequest[]>;
-}

package/dist/esm/GitHubClient.js

@@ -1,23 +0,0 @@
-import axios from 'axios';
-const TWO_SECONDS_IN_MILLIS = 2000;
-export class GitHubClient {
-    constructor(timeout = TWO_SECONDS_IN_MILLIS) {
-        this.apiClient = axios.create({ baseURL: 'https://api.github.com', timeout });
-    }
-    async getPullRequestByBranch(user, repository, branch) {
-        const pullRequests = await this.getPullRequests(user, repository);
-        return pullRequests.find(pr => !!pr.head && pr.head.ref === branch);
-    }
-    /**
-     * @see https://developer.github.com/v3/pulls/#list-pull-requests
-     */
-    async getPullRequests(user, repository) {
-        const resourceUrl = `repos/${user}/${repository}/pulls`;
-        const response = await this.apiClient.get(resourceUrl, {
-            params: {
-                state: 'open',
-            },
-        });
-        return response.data;
-    }
-}

package/dist/esm/GitHubClient.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/GitHubClient.test.js

@@ -1,51 +0,0 @@
-import { assert, expect, describe, test } from 'vitest';
-import nock from 'nock';
-import { StatusCodes as HTTP_STATUS } from 'http-status-codes';
-import { GitHubClient } from './GitHubClient.js';
-const TEN_SECONDS_IN_MILLIS = 10000;
-const HALF_SECOND_IN_MILLIS = 500;
-describe('GitHubClient', () => {
-    describe('getPullRequests', () => {
-        test('cancels the request after a given time', async () => {
-            nock('https://api.github.com')
-                .get(/repos\/.*\/.*\/pulls/)
-                .query(true)
-                .delay(TEN_SECONDS_IN_MILLIS)
-                .reply(HTTP_STATUS.OK);
-            const gitHubClient = new GitHubClient(HALF_SECOND_IN_MILLIS);
-            try {
-                await gitHubClient.getPullRequests('user', 'repository');
-                assert.fail('Should not have resolved');
-            }
-            catch (error) {
-                expect(error.message).toBe('timeout of 500ms exceeded');
-            }
-            finally {
-                nock.cleanAll();
-            }
-        });
-    });
-    describe('getPullRequestsByBranch', () => {
-        test('correctly parses pull requests', async () => {
-            const exampleData = [
-                {
-                    _links: {
-                        html: {
-                            href: 'https://github.com/user/repo/pull/1234',
-                        },
-                    },
-                    head: {
-                        ref: 'branch-name',
-                    },
-                },
-            ];
-            nock('https://api.github.com')
-                .get(/repos\/.*\/.*\/pulls/)
-                .query(true)
-                .reply(HTTP_STATUS.OK, exampleData);
-            const gitHubClient = new GitHubClient();
-            const result = await gitHubClient.getPullRequestByBranch('user', 'repository', 'branch-name');
-            expect(result).toEqual(exampleData[0]);
-        });
-    });
-});

package/dist/esm/RepositoryService.d.ts

@@ -1,15 +0,0 @@
-export interface Options {
-    debug?: boolean;
-    timeout?: number;
-}
-export declare class RepositoryService {
-    private readonly gitHubClient;
-    private readonly logger;
-    private readonly options;
-    private readonly parser;
-    constructor(options?: Options);
-    getFullUrl(gitDir: string): Promise<string>;
-    getPullRequestUrl(url: string): Promise<string | void>;
-    parseGitBranch(gitDir: string): Promise<string>;
-    parseGitConfig(gitDir: string): Promise<string>;
-}

package/dist/esm/RepositoryService.js

@@ -1,92 +0,0 @@
-import { promises as fsAsync } from 'fs';
-import path from 'path';
-import logdown from 'logdown';
-import { GitHubClient } from './GitHubClient.js';
-export class RepositoryService {
-    constructor(options) {
-        this.parser = {
-            fullUrl: new RegExp('^(?:.+?://(?:.+@)?|(?:.+@)?)(.+?)[:/](.+?)(?:.git)?/?$', 'i'),
-            gitBranch: new RegExp('ref: refs/heads/(?<branch>.*)$', 'mi'),
-            pullRequest: new RegExp('github\\.com\\/(?<user>[^\\/]+)\\/(?<project>[^/]+)\\/tree\\/(?<branch>.*)'),
-            rawUrl: new RegExp('.*url = (?<rawUrl>.*)', 'mi'),
-        };
-        this.options = { debug: false, timeout: 2000, ...options };
-        this.gitHubClient = new GitHubClient(this.options.timeout);
-        this.logger = logdown('gh-open', {
-            logger: console,
-            markdown: false,
-        });
-        this.logger.state.isEnabled = this.options.debug;
-    }
-    async getFullUrl(gitDir) {
-        const rawUrl = await this.parseGitConfig(gitDir);
-        const gitBranch = await this.parseGitBranch(gitDir);
-        const match = this.parser.fullUrl.exec(rawUrl);
-        if (!match) {
-            const errorMessage = 'Could not convert raw URL.';
-            throw new Error(errorMessage);
-        }
-        const parsedUrl = rawUrl.replace(this.parser.fullUrl, 'https://$1/$2');
-        this.logger.info('Found parsed URL', { parsedUrl });
-        return `${parsedUrl}/tree/${gitBranch}`;
-    }
-    async getPullRequestUrl(url) {
-        const match = this.parser.pullRequest.exec(url);
-        if (!match || !match.groups) {
-            const errorMessage = `Could not convert GitHub URL "${url}" to pull request`;
-            throw new Error(errorMessage);
-        }
-        const { user, project, branch } = match.groups;
-        try {
-            const response = await this.gitHubClient.getPullRequestByBranch(user, project, branch);
-            if (response && response._links && response._links.html && response._links.html.href) {
-                const pullRequestUrl = response._links.html.href;
-                this.logger.info('Got pull request URL', { pullRequestUrl });
-                return pullRequestUrl;
-            }
-        }
-        catch (error) {
-            this.logger.warn(`Request failed: "${error.message}"`);
-        }
-    }
-    async parseGitBranch(gitDir) {
-        const gitHeadFile = path.join(gitDir, 'HEAD');
-        let gitHead;
-        try {
-            gitHead = await fsAsync.readFile(gitHeadFile, 'utf-8');
-            gitHead = gitHead.trim();
-            this.logger.info('Read git head file', { gitHead });
-        }
-        catch (error) {
-            const errorMessage = `Could not find git HEAD file in "${gitDir}".`;
-            throw new Error(errorMessage);
-        }
-        const match = this.parser.gitBranch.exec(gitHead);
-        if (!match || !match.groups) {
-            const errorMessage = `No branch found in git HEAD file: "${gitHead}"`;
-            throw new Error(errorMessage);
-        }
-        return match.groups.branch;
-    }
-    async parseGitConfig(gitDir) {
-        const gitConfigFile = path.join(gitDir, 'config');
-        let gitConfig;
-        try {
-            gitConfig = await fsAsync.readFile(gitConfigFile, 'utf-8');
-            gitConfig = gitConfig.trim();
-            this.logger.info('Read git config file', { gitConfigFile });
-        }
-        catch (error) {
-            const errorMessage = `Could not find git config file: "${gitConfigFile}"`;
-            throw new Error(errorMessage);
-        }
-        const match = this.parser.rawUrl.exec(gitConfig);
-        if (!match || !match.groups) {
-            const errorMessage = `No URL found in git config file: "${gitConfigFile}"`;
-            throw new Error(errorMessage);
-        }
-        const rawUrl = match.groups.rawUrl;
-        this.logger.info('Found raw URL', { rawUrl });
-        return rawUrl;
-    }
-}

package/dist/esm/RepositoryService.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/RepositoryService.test.js

@@ -1,74 +0,0 @@
-import { expect, describe, test } from 'vitest';
-import { RepositoryService } from './RepositoryService.js';
-describe('RepositoryService', () => {
-    const repositoryService = new RepositoryService();
-    describe('getFullUrl', () => {
-        const normalizedUrl = 'https://github.com/ffflorian/gh-open';
-        const testRegex = (str) => {
-            const match = repositoryService['parser'].fullUrl.exec(str);
-            expect(match[0]).toEqual(expect.any(String));
-            const replaced = str.replace(repositoryService['parser'].fullUrl, 'https://$1/$2');
-            expect(replaced).toBe(normalizedUrl);
-        };
-        test('converts complete git URLs', () => {
-            const gitUrl = 'git@github.com:ffflorian/gh-open.git';
-            testRegex(gitUrl);
-        });
-        test('converts git URLs without a suffix', () => {
-            const gitUrl = 'git@github.com:ffflorian/gh-open';
-            testRegex(gitUrl);
-        });
-        test('converts git URLs without a user', () => {
-            const gitUrl = 'github.com:ffflorian/gh-open.git';
-            testRegex(gitUrl);
-        });
-        test('converts complete https URLs', () => {
-            const gitUrl = 'https://github.com/ffflorian/gh-open.git';
-            testRegex(gitUrl);
-        });
-        test('converts https URLs without suffix', () => {
-            const gitUrl = 'https://github.com/ffflorian/gh-open';
-            testRegex(gitUrl);
-        });
-        test('converts https URLs with a username', () => {
-            const gitUrl = 'https://git@github.com/ffflorian/gh-open.git';
-            testRegex(gitUrl);
-        });
-        test('converts https URLs with a username and password', () => {
-            const gitUrl = 'https://git:password@github.com/ffflorian/gh-open.git';
-            testRegex(gitUrl);
-        });
-    });
-    describe('parseGitConfig', () => {
-        const rawUrl = 'git@github.com:ffflorian/gh-open.git';
-        const testRegex = (str) => {
-            const match = repositoryService['parser'].rawUrl.exec(str);
-            expect(match.groups.rawUrl).toBe(rawUrl);
-        };
-        test('converts a normal git config', () => {
-            const gitConfig = `[remote "origin"]
-    url = git@github.com:ffflorian/gh-open.git
-    fetch = +refs/heads/*:refs/remotes/origin/*
-[branch "main"]
-    remote = origin
-    merge = refs/heads/main`;
-            testRegex(gitConfig);
-        });
-        describe('parseGitBranch', () => {
-            const testRegex = (str, result) => {
-                const match = repositoryService['parser'].gitBranch.exec(str);
-                expect(match.groups.branch).toBe(result);
-            };
-            test('detects the main branch', () => {
-                const rawBranch = 'main';
-                const gitHead = 'ref: refs/heads/main\n';
-                testRegex(gitHead, rawBranch);
-            });
-            test('detects a branch with a slash', () => {
-                const rawBranch = 'fix/regex';
-                const gitHead = 'ref: refs/heads/fix/regex\n';
-                testRegex(gitHead, rawBranch);
-            });
-        });
-    });
-});

package/dist/esm/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/esm/cli.js

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-import path from 'path';
-import { program as commander } from 'commander';
-import { findUp } from 'find-up';
-import open from 'open';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-import { RepositoryService } from './RepositoryService.js';
-const { description, name, version } = require('../package.json');
-commander
-    .name(name.replace(/^@[^/]+\//, ''))
-    .description(description)
-    .option('-d, --debug', 'Enable debug logging')
-    .option('-p, --print', 'Just print the URL')
-    .option('-b, --branch', 'Open the branch tree (and not the PR)')
-    .option('-t, --timeout <number>', 'Set a custom timeout for HTTP requests')
-    .arguments('[directory]')
-    .version(version, '-v, --version')
-    .parse(process.argv);
-const resolvedBaseDir = path.resolve(commander.args[0] || '.');
-const commanderOptions = commander.opts();
-void (async () => {
-    try {
-        const gitDir = await findUp('.git', { cwd: resolvedBaseDir, type: 'directory' });
-        if (!gitDir) {
-            throw new Error(`Could not find a git repository in "${resolvedBaseDir}".`);
-        }
-        const repositoryService = new RepositoryService({
-            ...(commanderOptions.debug && { debug: commanderOptions.debug }),
-            ...(commanderOptions.timeout && { timeout: parseInt(commanderOptions.timeout, 10) }),
-        });
-        let fullUrl = await repositoryService.getFullUrl(gitDir);
-        if (!commanderOptions.branch) {
-            const pullRequestUrl = await repositoryService.getPullRequestUrl(fullUrl);
-            if (pullRequestUrl) {
-                fullUrl = pullRequestUrl;
-            }
-        }
-        if (commanderOptions.print) {
-            console.info(fullUrl);
-        }
-        else {
-            await open(fullUrl);
-        }
-        process.exit();
-    }
-    catch (error) {
-        console.error(error.message);
-        process.exit(1);
-    }
-})();

package/dist/esm/index.d.ts

@@ -1 +0,0 @@
-export * from './RepositoryService.js';

package/dist/esm/index.js

@@ -1 +0,0 @@
-export * from './RepositoryService.js';

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}