dependency-owners 1.0.0 → 1.1.0

package/dist/cli.js

@@ -3,7 +3,8 @@ import { buildApplication, buildCommand, run, } from '@stricli/core';
 import { createRequire } from 'node:module';
 import path from 'node:path';
 import { dependencyOwners } from './index.js';
-import { getErrorMessage } from './utils.js';
+import { getErrorMessage } from './utils/message.js';
+import { getUnownedDependencies } from './utils/owners.js';
 const { name, version, description } = createRequire(import.meta.url)('../package.json');
 function cwdParser(rawInput) {
     return this.path.join(this.process.cwd(), rawInput);
@@ -17,6 +18,12 @@ const command = buildCommand({
                 dependencyFile,
                 loader: flags.loader,
             });
+            if (flags['fail-on-unowned']) {
+                const unownedDeps = getUnownedDependencies(result);
+                if (unownedDeps.length > 0) {
+                    throw new Error(`Unowned dependencies found: ${unownedDeps.join(', ')}`);
+                }
+            }
             this.process.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
         }
         catch (error) {
@@ -40,6 +47,11 @@ const command = buildCommand({
                 optional: true,
                 variadic: true,
             },
+            'fail-on-unowned': {
+                kind: 'boolean',
+                brief: 'Fail if any dependencies are unowned.',
+                default: false,
+            },
             loader: {
                 kind: 'parsed',
                 parse: String,

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { DependencyLoader } from './loader.js';
+import { type DependencyLoader } from './utils/loader.js';
 /**
  * Options for the dependency owners lookup.
  */

package/dist/index.js

@@ -1,21 +1,7 @@
-import fs from 'node:fs/promises';
+import * as PackageJsonLoader from '@dependency-owners/package-json-loader';
 import path from 'node:path';
-import { getOwners, getOwnersMapping, resolveDependencyLoader, } from './utils.js';
-/**
- * Loader for loading dependencies from package.json files.
- */
-const PackageJsonLoader = {
-    async canLoad(filePath) {
-        return path.basename(filePath) === 'package.json';
-    },
-    async load(filePath) {
-        const pkg = JSON.parse(await fs.readFile(filePath, 'utf-8'));
-        return [
-            ...Object.keys(pkg.dependencies || {}),
-            ...Object.keys(pkg.devDependencies || {}),
-        ];
-    },
-};
+import { getOwners, getOwnersMapping } from './utils/owners.js';
+import { resolveDependencyLoader, } from './utils/loader.js';
 /**
  * Get the owners of the specified dependencies.
  * @param {Options} options - The options for the dependency owners lookup.

package/dist/loader.d.ts

@@ -1,17 +1 @@
-/**
- * Interface for loading dependencies from various file types.
- */
-export interface DependencyLoader {
-    /**
-     * Check if the loader can handle the specified file.
-     * @param {string} filePath The path to the file to check.
-     * @returns {boolean} True if the loader can handle the file, false otherwise.
-     */
-    canLoad(filePath: string): Promise<boolean>;
-    /**
-     * Load the dependencies from the specified file.
-     * @param {string} filePath The path to the file to load dependencies from.
-     * @returns {string[]} The list of loaded dependencies.
-     */
-    load(filePath: string): Promise<string[]>;
-}
+export type { DependencyLoader } from './utils/loader.js';

package/dist/utils/loader.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Interface for loading dependencies from various file types.
+ */
+export interface DependencyLoader {
+    /**
+     * Check if the loader can handle the specified file.
+     * @param {string} filePath The path to the file to check.
+     * @returns {boolean} True if the loader can handle the file, false otherwise.
+     */
+    canLoad(filePath: string): Promise<boolean>;
+    /**
+     * Load the dependencies from the specified file.
+     * @param {string} filePath The path to the file to load dependencies from.
+     * @returns {string[]} The list of loaded dependencies.
+     */
+    load(filePath: string): Promise<string[]>;
+}
+/**
+ * Resolve a dependency loader for a specific file.
+ * @param {DependencyLoader | string} loader The loader to use.
+ * @param {string} depFilePath The path to the dependency file.
+ * @returns {Promise<DependencyLoader | undefined>} The resolved dependency loader or undefined if not found.
+ */
+export declare function resolveDependencyLoader(loader: DependencyLoader | string, depFilePath: string): Promise<DependencyLoader | undefined>;

package/dist/utils/loader.js

@@ -0,0 +1,48 @@
+import path from 'node:path';
+/**
+ * Import a dependency loader by name.
+ * @param {string} loaderName The name of the loader to import.
+ * @returns {Promise<DependencyLoader>} The imported dependency loader.
+ */
+async function importDependencyLoader(loaderName) {
+    let loaderModule;
+    // Try importing from an installed dependency/absolute path
+    try {
+        loaderModule = await import(loaderName);
+    }
+    catch {
+        // no-op
+    }
+    // Try import from relative path
+    try {
+        loaderModule = await import(path.join(process.cwd(), loaderName));
+    }
+    catch {
+        // no-op
+    }
+    // If we couldn't find the module, throw an error
+    if (!loaderModule) {
+        throw new Error(`Failed to import loader: ${loaderName}`);
+    }
+    // Check if the loader has the required functions
+    const loader = loaderModule.default || loaderModule;
+    if (loader &&
+        typeof loader.canLoad === 'function' &&
+        typeof loader.load === 'function') {
+        return loader;
+    }
+    else {
+        throw new Error(`Invalid loader: ${loaderName}. The module does not export an object with 'canLoad' and 'load' functions.`);
+    }
+}
+/**
+ * Resolve a dependency loader for a specific file.
+ * @param {DependencyLoader | string} loader The loader to use.
+ * @param {string} depFilePath The path to the dependency file.
+ * @returns {Promise<DependencyLoader | undefined>} The resolved dependency loader or undefined if not found.
+ */
+export async function resolveDependencyLoader(loader, depFilePath) {
+    const resolvedLoader = typeof loader === 'string' ? await importDependencyLoader(loader) : loader;
+    const canLoad = await resolvedLoader.canLoad(depFilePath);
+    return canLoad ? resolvedLoader : undefined;
+}

package/dist/utils/message.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get a formatted error message.
+ * @param error The error to format.
+ * @returns The formatted error message.
+ */
+export declare function getErrorMessage(error: unknown): string;

package/dist/utils/message.js

@@ -0,0 +1,11 @@
+/**
+ * Get a formatted error message.
+ * @param error The error to format.
+ * @returns The formatted error message.
+ */
+export function getErrorMessage(error) {
+    if (error instanceof Error) {
+        return error.message;
+    }
+    return String(error);
+}

package/dist/utils/owners.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Get the mapping of dependency owners from a JSON file.
+ * @param {string} filePath - The path to the dependency owners file.
+ * @returns {Record<string, string[]>} A mapping of dependency owners.
+ */
+export declare function getOwnersMapping(filePath: string): Record<string, string[]>;
+/**
+ * Get the owners of the specified dependencies.
+ * @param {string[]} dependencies - The list of dependencies to check.
+ * @param {Record<string, string[]>} ownersMapping - The mapping of dependency owners.
+ * @returns {Record<string, string[]>} A mapping of dependency owners for the specified dependencies.
+ */
+export declare function getOwners(dependencies: string[], ownersMapping: Record<string, string[]>): Record<string, string[]>;
+/**
+ * Get a list of unowned dependencies.
+ * @param owners The mapping of dependency owners.
+ * @returns A list of unowned dependencies.
+ */
+export declare function getUnownedDependencies(owners: Record<string, string[]>): string[];

package/dist/utils/owners.js

@@ -0,0 +1,33 @@
+import fs from 'node:fs';
+/**
+ * Get the mapping of dependency owners from a JSON file.
+ * @param {string} filePath - The path to the dependency owners file.
+ * @returns {Record<string, string[]>} A mapping of dependency owners.
+ */
+export function getOwnersMapping(filePath) {
+    return JSON.parse(fs.readFileSync(filePath, 'utf-8'));
+}
+/**
+ * Get the owners of the specified dependencies.
+ * @param {string[]} dependencies - The list of dependencies to check.
+ * @param {Record<string, string[]>} ownersMapping - The mapping of dependency owners.
+ * @returns {Record<string, string[]>} A mapping of dependency owners for the specified dependencies.
+ */
+export function getOwners(dependencies, ownersMapping) {
+    return dependencies.reduce((result, dep) => {
+        const owners = Object.keys(ownersMapping).filter((owner) => Array.isArray(ownersMapping[owner]) &&
+            ownersMapping[owner].includes(dep));
+        result[dep] = owners;
+        return result;
+    }, {});
+}
+/**
+ * Get a list of unowned dependencies.
+ * @param owners The mapping of dependency owners.
+ * @returns A list of unowned dependencies.
+ */
+export function getUnownedDependencies(owners) {
+    return Object.entries(owners)
+        .filter(([_key, deps]) => deps.length === 0)
+        .map(([key]) => key);
+}

package/dist/utils.d.ts

@@ -1,27 +1 @@
-import { DependencyLoader } from './loader.js';
-/**
- * Get the mapping of dependency owners from a JSON file.
- * @param {string} filePath - The path to the dependency owners file.
- * @returns {Record<string, string[]>} A mapping of dependency owners.
- */
-export declare function getOwnersMapping(filePath: string): Record<string, string[]>;
-/**
- * Get the owners of the specified dependencies.
- * @param {string[]} dependencies - The list of dependencies to check.
- * @param {Record<string, string[]>} ownersMapping - The mapping of dependency owners.
- * @returns {Record<string, string[]>} A mapping of dependency owners for the specified dependencies.
- */
-export declare function getOwners(dependencies: string[], ownersMapping: Record<string, string[]>): Record<string, string[]>;
-/**
- * Resolve a dependency loader for a specific file.
- * @param {DependencyLoader | string} loader The loader to use.
- * @param {string} depFilePath The path to the dependency file.
- * @returns {Promise<DependencyLoader | undefined>} The resolved dependency loader or undefined if not found.
- */
-export declare function resolveDependencyLoader(loader: DependencyLoader | string, depFilePath: string): Promise<DependencyLoader | undefined>;
-/**
- * Get a formatted error message.
- * @param error The error to format.
- * @returns The formatted error message.
- */
-export declare function getErrorMessage(error: unknown): string;
+export { getUnownedDependencies } from './utils/owners.js';

package/dist/utils.js

@@ -1,82 +1 @@
-import fs from 'node:fs';
-import path from 'node:path';
-/**
- * Get the mapping of dependency owners from a JSON file.
- * @param {string} filePath - The path to the dependency owners file.
- * @returns {Record<string, string[]>} A mapping of dependency owners.
- */
-export function getOwnersMapping(filePath) {
-    return JSON.parse(fs.readFileSync(filePath, 'utf-8'));
-}
-/**
- * Get the owners of the specified dependencies.
- * @param {string[]} dependencies - The list of dependencies to check.
- * @param {Record<string, string[]>} ownersMapping - The mapping of dependency owners.
- * @returns {Record<string, string[]>} A mapping of dependency owners for the specified dependencies.
- */
-export function getOwners(dependencies, ownersMapping) {
-    return dependencies.reduce((result, dep) => {
-        const owners = Object.keys(ownersMapping).filter((owner) => Array.isArray(ownersMapping[owner]) &&
-            ownersMapping[owner].includes(dep));
-        result[dep] = owners;
-        return result;
-    }, {});
-}
-/**
- * Import a dependency loader by name.
- * @param {string} loaderName The name of the loader to import.
- * @returns {Promise<DependencyLoader>} The imported dependency loader.
- */
-async function importDependencyLoader(loaderName) {
-    let loaderModule;
-    // Try importing from an installed dependency/absolute path
-    try {
-        loaderModule = await import(loaderName);
-    }
-    catch {
-        // no-op
-    }
-    // Try import from relative path
-    try {
-        loaderModule = await import(path.join(process.cwd(), loaderName));
-    }
-    catch {
-        // no-op
-    }
-    // If we couldn't find the module, throw an error
-    if (!loaderModule) {
-        throw new Error(`Failed to import loader: ${loaderName}`);
-    }
-    // Check if the loader has the required functions
-    const loader = loaderModule.default || loaderModule;
-    if (loader &&
-        typeof loader.canLoad === 'function' &&
-        typeof loader.load === 'function') {
-        return loader;
-    }
-    else {
-        throw new Error(`Invalid loader: ${loaderName}. The module does not export an object with 'canLoad' and 'load' functions.`);
-    }
-}
-/**
- * Resolve a dependency loader for a specific file.
- * @param {DependencyLoader | string} loader The loader to use.
- * @param {string} depFilePath The path to the dependency file.
- * @returns {Promise<DependencyLoader | undefined>} The resolved dependency loader or undefined if not found.
- */
-export async function resolveDependencyLoader(loader, depFilePath) {
-    const resolvedLoader = typeof loader === 'string' ? await importDependencyLoader(loader) : loader;
-    const canLoad = await resolvedLoader.canLoad(depFilePath);
-    return canLoad ? resolvedLoader : undefined;
-}
-/**
- * Get a formatted error message.
- * @param error The error to format.
- * @returns The formatted error message.
- */
-export function getErrorMessage(error) {
-    if (error instanceof Error) {
-        return error.message;
-    }
-    return String(error);
-}
+export { getUnownedDependencies } from './utils/owners.js';

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "dependency-owners",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Determine ownership of dependencies in a project",
   "author": "Kirk Eaton <contact@kirkeaton.ca>",
   "bin": "./dist/cli.js",
   "dependencies": {
+    "@dependency-owners/package-json-loader": "1.0.0",
     "@stricli/core": "1.2.0"
   },
   "devDependencies": {
     "@kirkeaton/prettier-config": "1.0.5",
     "@kirkeaton/semantic-release-config": "1.0.4",
     "@kirkeaton/tsconfig": "1.0.3",
-    "@types/node": "24.2.1",
+    "@types/node": "24.3.0",
     "fs-fixture": "2.8.1",
     "prettier": "3.6.2",
     "semantic-release": "24.2.7",
@@ -29,6 +30,10 @@
     "./loader": {
       "types": "./dist/loader.d.ts",
       "default": "./dist/loader.js"
+    },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "default": "./dist/utils.js"
     }
   },
   "files": [
@@ -50,7 +55,7 @@
     "build": "pnpm clean && tsc",
     "clean": "rm -rf dist",
     "format": "prettier \"**/*.{js,json,md,ts}\" --write",
-    "lint": "prettier \"**/*.{js,json,md,ts,md}\" --check",
+    "lint": "prettier \"**/*.{js,json,md,ts}\" --check",
     "prepublishOnly": "pnpm build",
     "test": "tsx --test",
     "typecheck": "tsc --noEmit"