@rowanmanning/package-json-github 2.0.0 → 3.0.0

package/README.md

@@ -16,7 +16,7 @@ Load and parse `package.json` and `package-lock.json` files from GitHub reposito
 
 This library requires the following to run:
 
-  * [Node.js](https://nodejs.org/) 20+
+  * [Node.js](https://nodejs.org/) 22+
 
 
 ## Usage
@@ -31,8 +31,6 @@ Load into your code with `import` or `require`:
 
 ```js
 import { packageJson, packageLock } from '@rowanmanning/package-json-github';
-// or
-const { packageJson, packageLock } = require('@rowanmanning/package-json-github');
 ```
 
 The following exports are available.

package/index.d.ts

@@ -2,11 +2,11 @@ import type { AnyPackageLock, PackageJson } from '@rowanmanning/package-json';
 
 declare module '@rowanmanning/package-json-github' {
 	export type {
+		AnyPackageLock,
 		PackageJson,
 		PackageLockV1,
 		PackageLockV2,
-		PackageLockV3,
-		AnyPackageLock
+		PackageLockV3
 	} from '@rowanmanning/package-json';
 
 	export interface GitHubOptions {

package/index.js

@@ -1,4 +1,2 @@
-'use strict';
-
-exports.packageJson = require('./lib/package-json');
-exports.packageLock = require('./lib/package-lock-json');
+export * as packageJson from './lib/package-json.js';
+export * as packageLock from './lib/package-lock-json.js';

package/lib/github.js

@@ -1,18 +1,16 @@
-'use strict';
-
-const { name, version, homepage } = require('../package.json');
+import packageJson from '../package.json' with { type: 'json' };
 
 /**
  * @import { GitHubOptions } from '@rowanmanning/package-json-github'
  */
 
-const userAgent = `${name}/${version} (${homepage})`;
+const userAgent = `${packageJson.name}/${packageJson.version} (${packageJson.homepage})`;
 
 /**
  * @param {GitHubOptions & { path: string }} options
  * @returns {Promise<string>}
  */
-exports.getRepoContent = async function getRepoContent(options) {
+export async function getRepoContent(options) {
 	if (!options || typeof options !== 'object' || Array.isArray(options)) {
 		throw new TypeError('Invalid argument: options must be an object');
 	}
@@ -54,4 +52,4 @@ exports.getRepoContent = async function getRepoContent(options) {
 		);
 	}
 	return await response.text();
-};
+}

package/lib/package-json.js

@@ -1,16 +1,12 @@
-'use strict';
-
-const { getRepoContent } = require('./github');
-const {
-	packageJson: { fromString }
-} = require('@rowanmanning/package-json');
+import { packageJson } from '@rowanmanning/package-json';
+import { getRepoContent } from './github.js';
 
 /**
- * @import { packageJson } from '@rowanmanning/package-json-github'
+ * @import { packageJson as packageJsonGitHub } from '@rowanmanning/package-json-github'
  */
 
-/** @type {packageJson['fromGitHubRepo']} */
-exports.fromGitHubRepo = async function fromGitHubRepo(options) {
+/** @type {packageJsonGitHub['fromGitHubRepo']} */
+export async function fromGitHubRepo(options) {
 	const optionsWithPath = Object.assign({ path: 'package.json' }, options);
-	return fromString(await getRepoContent(optionsWithPath));
-};
+	return packageJson.fromString(await getRepoContent(optionsWithPath));
+}

package/lib/package-lock-json.js

@@ -1,16 +1,12 @@
-'use strict';
-
-const { getRepoContent } = require('./github');
-const {
-	packageLock: { fromString }
-} = require('@rowanmanning/package-json');
+import { packageLock } from '@rowanmanning/package-json';
+import { getRepoContent } from './github.js';
 
 /**
- * @import { packageLock } from '@rowanmanning/package-json-github'
+ * @import { packageLock as packageLockGitHub } from '@rowanmanning/package-json-github'
  */
 
-/** @type {packageLock['fromGitHubRepo']} */
-exports.fromGitHubRepo = async function fromGitHubRepo(options) {
+/** @type {packageLockGitHub['fromGitHubRepo']} */
+export async function fromGitHubRepo(options) {
 	const optionsWithPath = Object.assign({ path: 'package-lock.json' }, options);
-	return fromString(await getRepoContent(optionsWithPath));
-};
+	return packageLock.fromString(await getRepoContent(optionsWithPath));
+}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@rowanmanning/package-json-github",
-  "version": "2.0.0",
+  "version": "3.0.0",
+  "type": "module",
   "description": "Load and parse package.json and package-lock.json files from GitHub repositories",
   "keywords": [],
   "author": "Rowan Manning (https://rowanmanning.com/)",
@@ -13,11 +14,22 @@
   "bugs": "https://github.com/rowanmanning/repo-tools/issues",
   "license": "MIT",
   "engines": {
-    "node": "20.x || 22.x"
+    "node": "22.x || 24.x"
   },
-  "main": "index.js",
-  "types": "index.d.ts",
+  "scripts": {
+    "test": "npm run test:unit && npm run test:end-to-end",
+    "test:unit": "node --test --experimental-test-module-mocks --experimental-test-coverage --test-coverage-exclude '**/*.test.js' --test-coverage-branches=100 --test-coverage-functions=100 --test-coverage-lines=100 'test/unit/**/*.test.js'",
+    "test:end-to-end": "node --test 'test/end-to-end/**/*.test.js'"
+  },
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "types": "./index.d.ts",
+  "main": "./index.js",
   "dependencies": {
-    "@rowanmanning/package-json": "^2.0.0"
+    "@rowanmanning/package-json": "^3.0.0"
   }
 }