feat: add export type to usage report

Author: matheusdc

.eslintrc

@@ -9,5 +9,9 @@
   "env": {
     "node": true,
     "jest": true
+  },
+  "rules": {
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": "error"
   }
 }

README.md

@@ -27,7 +27,6 @@ const usages: PackageUsage[] = getPackagesUsages({
   packages: ['react'],
   fileGlobs: `**/**.ts`,
   packageJsonCWD: './package.json',
-
 });
 
 console.log(usages);
@@ -36,7 +35,6 @@ console.log(usages);
 Package Usage types
 
 ```ts
-
 export type JSXElementUsage = {
   line: number;
   props: string[];
@@ -65,7 +63,8 @@ export type Usages =
 
 export type Import = {
   name: string;
-  usages: Usages;
+  type: ExportType;
+  usages?: Usages;
 };
 
 export type FileUsage = {

__tests__/utils.ts

@@ -2,7 +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';
+import { ExportType, Import } from '../src';
 
 export const MOCKS_DIR = '__mocks__';
 export const MOCKS_DIR_CWD = join(join(cwd(), MOCKS_DIR));
@@ -48,6 +48,7 @@ function jsxElement(value: string, line: number): [Import, string] {
   return [
     {
       name: value,
+      type: ExportType.named,
       usages: [
         {
           line: line + 2,
@@ -67,6 +68,7 @@ function propertyAccess(value: string, line: number): [Import, string] {
   return [
     {
       name: value,
+      type: ExportType.named,
       usages: [{ line: line + 2, property, text: `\n${value}.${property}` }],
     },
     `${value}.${property}`,
@@ -75,14 +77,22 @@ function propertyAccess(value: string, line: number): [Import, string] {
 
 function callExpression(value: string, line: number): [Import, string] {
   return [
-    { name: value, usages: [{ line: line + 2, text: `\n${value}()` }] },
+    {
+      name: value,
+      type: ExportType.named,
+      usages: [{ line: line + 2, text: `\n${value}()` }],
+    },
     `${value}()`,
   ];
 }
 
 function valueUsage(value: string, line: number): [Import, string] {
   return [
-    { name: value, usages: [{ line: line + 2, text: `\n${value};` }] },
+    {
+      name: value,
+      type: ExportType.named,
+      usages: [{ line: line + 2, text: `\n${value};` }],
+    },
     `${value};`,
   ];
 }

example/run-in-ci.js

@@ -10,6 +10,7 @@ const result = getPackagesUsages({
   packages: ['bla', '@scoped/package'],
   fileGlobs: './*{.ts,.tsx}',
   packageJsonCWD: './package.json',
+  analyzeImportUsages: true,
 });
 
 console.log(JSON.stringify(result, null, 2));

src/core.ts

@@ -7,6 +7,7 @@ import {
 } from 'ts-morph';
 
 import {
+  getExportType,
   getJSXElementProps,
   getPackageVersion,
   getProperty,
@@ -27,6 +28,7 @@ import {
   CallExpressionUsage,
   PropertyAccessExpressionUsage,
   FileUsage,
+  ExportType,
 } from './types';
 
 const getImports = (importDeclaration: ImportDeclaration): Import[] => {
@@ -36,8 +38,10 @@ const getImports = (importDeclaration: ImportDeclaration): Import[] => {
     .map((named) => named.getName());
 
   return namedImports
-    .concat(defaultImport ? [defaultImport] : [])
-    .map((name) => ({ name }));
+    .map((name) => ({ name, type: ExportType.named }))
+    .concat(
+      defaultImport ? [{ name: defaultImport, type: ExportType.default }] : []
+    );
 };
 
 const getDetailsFromImports = (importDeclaration: ImportDeclaration) => {
@@ -64,6 +68,7 @@ const getDetailsFromReferences = (
 ): Import[] =>
   references.map((referencedSymbol) => ({
     name: referencedSymbol.getDefinition().getNode().getText(),
+    type: getExportType(referencedSymbol),
     usages: referencedSymbol
       .getReferences()
       .flatMap(

src/helpers.ts

@@ -1,7 +1,8 @@
 import pkgup from 'pkg-up';
 
 import { readFileSync } from 'fs';
-import { ReferenceEntry, SyntaxKind } from 'ts-morph';
+import { ReferencedSymbol, ReferenceEntry, SyntaxKind } from 'ts-morph';
+import { ExportType } from './types';
 
 // istanbul ignore next
 function getPackageJson(packageJsonCWD?: string) {
@@ -40,6 +41,11 @@ export function nonNullish<Value>(v: Value): v is NonNullable<Value> {
   return v !== undefined && v !== null;
 }
 
+export const getExportType = (referencedSymbol: ReferencedSymbol) =>
+  referencedSymbol.getDefinition().getDeclarationNode()?.getParentSyntaxList()
+    ? ExportType.named
+    : ExportType.default;
+
 export const getJSXElementProps = (reference: ReferenceEntry) =>
   reference
     .getNode()

src/types.ts

@@ -11,12 +11,18 @@ export type FileUsage = {
   imports: Import[];
 };
 
+export enum ExportType {
+  named = 'named',
+  default = 'default',
+}
+
 export type Usages =
   | JSXElementUsage[]
   | (CallExpressionUsage | PropertyAccessExpressionUsage | ValueUsage)[];
 
 export type Import = {
   name: string;
+  type: ExportType;
   usages?: Usages;
 };