refactor: moved legacyDefaultScanPackageOptionsFactory to packageUtils as per CR

Author: artus9033

packages/shared/src/common.ts

@@ -10,7 +10,6 @@ import {
   type AggregatedLicensesObj,
   type LicensePlistPayload,
   type ScanPackageOptionsFactory,
-  legacyDefaultScanPackageOptionsFactory,
 } from './types';
 import { PackageUtils } from './utils';
 
@@ -22,7 +21,7 @@ function scanPackage(
   version: string,
   processedPackages: Set<string>,
   result: AggregatedLicensesObj,
-  scanOptionsFactory: ScanPackageOptionsFactory = legacyDefaultScanPackageOptionsFactory,
+  scanOptionsFactory: ScanPackageOptionsFactory = PackageUtils.legacyDefaultScanPackageOptionsFactory,
 ) {
   const packageKey = `${packageName}@${version}`;
 
@@ -95,7 +94,7 @@ function scanPackage(
  */
 export function scanDependencies(
   appPackageJsonPath: string,
-  scanOptionsFactory: ScanPackageOptionsFactory = legacyDefaultScanPackageOptionsFactory,
+  scanOptionsFactory: ScanPackageOptionsFactory = PackageUtils.legacyDefaultScanPackageOptionsFactory,
 ): AggregatedLicensesObj {
   const appPackageJson = require(path.resolve(appPackageJsonPath));
   const dependencies: Record<string, string> = appPackageJson.dependencies;

packages/shared/src/types/ScanPackageOptions.ts

@@ -24,12 +24,3 @@ export type ScanPackageOptionsFactoryPackageInfo = {
  * Factory to create a filter for scan options for dependencies of a given package
  */
 export type ScanPackageOptionsFactory = (packageInfo: ScanPackageOptionsFactoryPackageInfo) => ScanPackageOptions;
-
-/**
- * Default value consistent with legacy behaviour assumptions for the scan package options factory
- * used so as not to introduce breaking API changes to the shared package
- */
-export const legacyDefaultScanPackageOptionsFactory: ScanPackageOptionsFactory = () => ({
-  includeTransitiveDependencies: true,
-  includeDevDependencies: false,
-});

packages/shared/src/utils/packageUtils.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 
-import type { LicenseObj } from '../types';
+import type { LicenseObj, ScanPackageOptionsFactory } from '../types';
 
 import { sha512 } from './miscUtils';
 import { normalizeRepositoryUrl } from './repositoryUtils';
@@ -80,3 +80,12 @@ export function parseRepositoryFieldToUrl(json: { repository: string | { url?: s
     return normalizeRepositoryUrl(json.repository);
   }
 }
+
+/**
+ * Default value consistent with legacy behaviour assumptions for the scan package options factory
+ * used so as not to introduce breaking API changes to the shared package
+ */
+export const legacyDefaultScanPackageOptionsFactory: ScanPackageOptionsFactory = () => ({
+  includeTransitiveDependencies: true,
+  includeDevDependencies: false,
+});