feat(core): find license in package.json

biome.json

@@ -46,5 +46,17 @@
     "formatter": {
       "quoteStyle": "double"
     }
-  }
+  },
+  "overrides": [
+    {
+      "include": ["packages/core/**"],
+      "linter": {
+        "rules": {
+          "nursery": {
+            "useExplicitFunctionReturnType": "error"
+          }
+        }
+      }
+    }
+  ]
 }

packages/core/license.d.ts

@@ -0,0 +1,6 @@
+declare global {
+  type AvailableLicense = (typeof licenses)[number];
+  type License = AvailableLicense | AvailableLicense[] | undefined;
+}
+
+export {};

packages/core/src/audit-licenses.ts

@@ -1,12 +1,12 @@
 import { checkLicenseStatus, type LicenseStatus } from "./check-license-status";
 import { extractPackageName, readPackageJson } from "./file-utils";
-import { findLicense } from "./find-license";
+import { findLicense } from "./license-finder/find-license";
 import { getChildDependencies } from "./get-child-dependencies";
 
 interface PackageInfo {
   package: string;
   path: string;
-  license: string | undefined;
+  license: License;
   licensePath: string | undefined;
   status: LicenseStatus;
 }
@@ -28,7 +28,7 @@ function auditLicenses(packagePaths: string[]) {
     }
     const packageJson = readPackageJson(packagePath);
 
-    const { license, licensePath } = findLicense(packagePath);
+    const { license, licensePath } = findLicense(packageJson, packagePath);
 
     const status = checkLicenseStatus(license);
 
@@ -72,7 +72,6 @@ const packagePaths: string[] = [
   "/Users/angelikajeziorska/Documents/projects/license-auditor/node_modules/husky",
   "/Users/angelikajeziorska/Documents/projects/license-auditor/node_modules/turbo",
   "/Users/angelikajeziorska/Documents/projects/license-auditor/node_modules/typescript",
-  "/Users/angelikajeziorska/Documents/projects/license-auditor/node_modules/@license-auditor/eslint-config",
   "/Users/angelikajeziorska/Documents/projects/license-auditor/node_modules/@total-typescript/ts-reset",
 ];
 

packages/core/src/check-license-status.ts

@@ -1,6 +1,6 @@
 export type LicenseStatus = "allowed" | "disallowed" | "unknown";
 
-export function checkLicenseStatus(license: string | undefined): LicenseStatus {
+export function checkLicenseStatus(license: License): LicenseStatus {
   // todo: compare license with the whitelist/banlist provided through configuration
   return "allowed";
 }

packages/core/src/file-utils.ts

@@ -1,19 +1,23 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 
-export function readPackageJson(packagePath: string) {
+export function readPackageJson(packagePath: string): object {
   const packageJsonPath = path.join(packagePath, "package.json");
 
   if (fs.existsSync(packageJsonPath)) {
     const packageJsonContent = fs.readFileSync(packageJsonPath, "utf-8");
-    return JSON.parse(packageJsonContent);
+    const parsedPackageJson = JSON.parse(packageJsonContent);
+    if (!!parsedPackageJson && typeof parsedPackageJson === "object") {
+      return parsedPackageJson;
+    }
   }
-  console.warn(`package.json not found for package at ${packageJsonPath}`);
+  // unsure how often such case happens and whether the license verification should be skipped
+  throw new Error(`package.json not found for package at ${packagePath}`);
 }
 
 // done this way to avoid reading package.json when checking for an existing value in Map
 // if it proves unreliable reading package.json will be inevitable
-export function extractPackageName(packagePath: string) {
+export function extractPackageName(packagePath: string): string {
   const baseName = path.basename(packagePath);
   const parentName = path.basename(path.dirname(packagePath));