feat: add a flag to control usage analysis

Author: matheusdc

__tests__/pkg-usage.test.ts

@@ -17,41 +17,46 @@ beforeEach(() => {
 describe('getPackagesUsages()', () => {
   describe('given a wrong file glob', () => {
     it('should THROW an Error', () => {
-      const { pkg } = mockPackageUsageFile();
+      const { pkg } = mockPackageUsageFile({});
 
       expect(() =>
         getPackagesUsages({
           packages: [pkg],
           fileGlobs: `WRONG_FILE_GLOB/**.xyz`,
+          analyzeImportUsages: false,
         })
       ).toThrow();
     });
   });
 
   describe('given a file without import declaration', () => {
     it('should return a package usage without a single count', () => {
-      const { pkg, version } = mockPackageUsageFile(
-        ` file data without import declaration `
-      );
+      const { pkg, version } = mockPackageUsageFile({
+        customData: ` file data without import declaration `,
+      });
 
       expect(
         getPackagesUsages({
           packages: [pkg],
           fileGlobs: `${MOCKS_DIR}/**.tsx`,
+          analyzeImportUsages: false,
           packageJsonCWD: MOCKS_DIR_CWD,
         })
       ).toStrictEqual([{ count: 0, files: [], name: pkg, version }]);
     });
   });
 
-  describe('given any package name and named imports', () => {
+  describe('given any package name and imports', () => {
     it('should return the right package usage', () => {
-      const { fileName, imports, pkg, version } = mockPackageUsageFile();
+      const { fileName, imports, pkg, version } = mockPackageUsageFile({
+        analyzeImportUsages: true,
+      });
 
       expect(
         getPackagesUsages({
           packages: [pkg],
           fileGlobs: `${MOCKS_DIR}/**.tsx`,
+          analyzeImportUsages: true,
           packageJsonCWD: MOCKS_DIR_CWD,
         })
       ).toStrictEqual([

__tests__/utils.ts

@@ -2,6 +2,7 @@ import { join, dirname } from 'path';
 import { cwd } from 'process';
 import { writeFileSync, existsSync, mkdirSync, rmdirSync } from 'fs';
 import f from 'faker';
+import { Import } from '../src';
 
 export const MOCKS_DIR = '__mocks__';
 export const MOCKS_DIR_CWD = join(join(cwd(), MOCKS_DIR));
@@ -42,7 +43,7 @@ function generatePropList(props: string[]) {
   return props.map((prop) => `${prop}="${prop}"`).join(' ');
 }
 
-function jsxElement(value: string, line: number) {
+function jsxElement(value: string, line: number): [Import, string] {
   const props = mockUniqueList(() => word().toLowerCase());
   return [
     {
@@ -61,7 +62,7 @@ function jsxElement(value: string, line: number) {
   ];
 }
 
-function propertyAccess(value: string, line: number) {
+function propertyAccess(value: string, line: number): [Import, string] {
   const property = word();
   return [
     {
@@ -72,14 +73,14 @@ function propertyAccess(value: string, line: number) {
   ];
 }
 
-function callExpression(value: string, line: number) {
+function callExpression(value: string, line: number): [Import, string] {
   return [
     { name: value, usages: [{ line: line + 2, text: `\n${value}()` }] },
     `${value}()`,
   ];
 }
 
-function valueUsage(value: string, line: number) {
+function valueUsage(value: string, line: number): [Import, string] {
   return [
     { name: value, usages: [{ line: line + 2, text: `\n${value};` }] },
     `${value};`,
@@ -103,7 +104,15 @@ function mockTSFile(pkgName: string, imports: string[]) {
   };
 }
 
-export function mockPackageUsageFile(customData?: string) {
+type mockPackageUsageFileAttributes = {
+  customData?: string;
+  analyzeImportUsages?: boolean;
+};
+
+export function mockPackageUsageFile({
+  customData,
+  analyzeImportUsages = false,
+}: mockPackageUsageFileAttributes) {
   const importNames = mockUniqueList(() => capitalize(word()));
   const fileName = f.datatype.uuid();
   const pkg = f.hacker.noun();
@@ -128,8 +137,18 @@ export function mockPackageUsageFile(customData?: string) {
     })
   );
 
+  if (customData) {
+    return {
+      fileName,
+      pkg,
+      version,
+    };
+  }
+
   return {
-    imports: !customData ? imports : undefined,
+    imports: analyzeImportUsages
+      ? imports
+      : imports.map(({ name }) => ({ name })),
     fileName,
     pkg,
     version,

scripts/pkg-usage.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const { getPackagesUsages } = require('pkg-usage');
-// const { getPackagesUsages } = require('../dist/src');
+
 const { Command } = require('commander');
 
 const program = new Command();
@@ -24,10 +24,15 @@ program
     '-cwd, --package-json-CWD <value>',
     'Directory to start from ex: -cwd "/path/to/start/from"'
   )
-  .action(({ packages, fileGlobs, packageJsonCWD }) => {
+  .option(
+    '-u, --analyze-import-usages',
+    'Experimental feature that analyzes usages of imported JSXElements, function calls, object properties, and value usages'
+  )
+  .action(({ packages, fileGlobs, analyzeImportUsages, packageJsonCWD }) => {
     const usages = getPackagesUsages({
       packages,
       fileGlobs,
+      analyzeImportUsages,
       packageJsonCWD,
     });
 

src/core.ts

@@ -29,6 +29,17 @@ import {
   FileUsage,
 } from './types';
 
+const getImports = (importDeclaration: ImportDeclaration): Import[] => {
+  const defaultImport = importDeclaration.getDefaultImport()?.getText();
+  const namedImports = importDeclaration
+    .getNamedImports()
+    .map((named) => named.getName());
+
+  return namedImports
+    .concat(defaultImport ? [defaultImport] : [])
+    .map((name) => ({ name }));
+};
+
 const getDetailsFromImports = (importDeclaration: ImportDeclaration) => {
   const defaultReferences = importDeclaration
     .getDefaultImport()
@@ -100,7 +111,8 @@ const getDetailsFromReferences = (
 
 function getPackageUsage(
   pkg: string,
-  sourceFile: SourceFile
+  sourceFile: SourceFile,
+  analyzeImportUsages: boolean
 ): FileUsage | undefined {
   const importDeclaration = sourceFile.getImportDeclaration(
     (importDeclaration) => {
@@ -116,8 +128,16 @@ function getPackageUsage(
     return undefined;
   }
 
-  const imports = getDetailsFromImports(importDeclaration);
+  if (analyzeImportUsages) {
+    const imports = getDetailsFromImports(importDeclaration);
+    return {
+      name: sourceFile.getBaseName(),
+      filePath: sourceFile.getFilePath(),
+      imports,
+    };
+  }
 
+  const imports = getImports(importDeclaration);
   return {
     name: sourceFile.getBaseName(),
     filePath: sourceFile.getFilePath(),
@@ -128,6 +148,7 @@ function getPackageUsage(
 export function getPackagesUsages({
   packages,
   fileGlobs,
+  analyzeImportUsages,
   packageJsonCWD,
 }: Options): PackageUsage[] | undefined {
   const project = new Project();
@@ -139,7 +160,9 @@ export function getPackagesUsages({
 
   const result = packages.map((pkg) => {
     const fileUsages = sourceFiles
-      .map((sourceFile) => getPackageUsage(pkg, sourceFile))
+      .map((sourceFile) =>
+        getPackageUsage(pkg, sourceFile, analyzeImportUsages)
+      )
       .filter(nonNullish);
 
     return {

src/types.ts

@@ -1,6 +1,7 @@
 export type Options = {
   fileGlobs: string;
   packages: string[];
+  analyzeImportUsages: boolean;
   packageJsonCWD?: string;
 };
 
@@ -16,7 +17,7 @@ export type Usages =
 
 export type Import = {
   name: string;
-  usages: Usages;
+  usages?: Usages;
 };
 
 export type PackageUsage = {