feat: add option to skip API extraction

Author: velut

src/package-analyzer/analyze-registry-package.ts

@@ -31,6 +31,7 @@ import { tryGetPackageAPI } from './try-get-package-api';
  * @param mirrors - URLs of registry mirrors (default: npm registry mirrors)
  * @param ignoreLicense - if `true`, extract API from unlicensed or proprietary packages (default: `false`)
  * @param ignoreFilePatternOptimizations - if `true`, ignore file pattern optimizations for known npm packages (default: `false`)
+ * @param skipAPIExtraction - if `true`, do not extract the API from the package (default: `false`)
  *
  * @see {@link RegistryPackageInfo}
  */
@@ -41,13 +42,15 @@ export async function analyzeRegistryPackage({
     mirrors,
     ignoreLicense,
     ignoreFilePatternOptimizations,
+    skipAPIExtraction = false,
 }: {
     name: string;
     version?: string;
     registry?: string;
     mirrors?: string[];
     ignoreLicense?: boolean;
     ignoreFilePatternOptimizations?: boolean;
+    skipAPIExtraction?: boolean;
 }): Promise<RegistryPackageInfo> {
     const start = performance.now();
     log('analyzeRegistryPackage: analyzing package: %O', { name, version });
@@ -61,6 +64,17 @@ export async function analyzeRegistryPackage({
     const { id } = manifest;
     log('analyzeRegistryPackage: got manifest: %O', { id, manifest });
 
+    if (skipAPIExtraction) {
+        log('analyzeRegistryPackage: skipping API extraction: %O', { id });
+        return {
+            id,
+            manifest,
+            api: undefined,
+            elapsed: Math.round(performance.now() - start),
+            createdAt: new Date().toISOString(),
+        };
+    }
+
     const api = await tryGetPackageAPI({
         manifest,
         ignoreLicense,

test/package-analyzer/analyze-registry-package.test.ts

@@ -116,6 +116,18 @@ describe('analyzeRegistryPackage', () => {
         expect(api).toBeUndefined();
     });
 
+    it('skips API extraction if required', async () => {
+        expect.assertions(1);
+
+        const { api } = await analyzeRegistryPackage({
+            name: 'short-time-ago',
+            version: '2.0.0',
+            skipAPIExtraction: true,
+        });
+
+        expect(api).toBeUndefined();
+    });
+
     it('extracts the API from a registry package', async () => {
         expect.assertions(1);