feat: added filePath to FileUsage report

Author: luistak

__tests__/pkg-usage.test.ts

@@ -60,6 +60,7 @@ describe('getPackagesUsages()', () => {
           files: [
             {
               defaultImport: undefined,
+              filePath: `${MOCKS_DIR_CWD}/${fileName}.ts`,
               name: `${fileName}.ts`,
               namedImports: imports,
             },

package.json

@@ -45,15 +45,16 @@
     "lint": "eslint . --cache --fix --ext .ts,.tsx",
     "format": "prettier --loglevel warn --write \"**/*.{ts,tsx,css,md}\"",
     "test:ci": "CI=true yarn test:coverage",
-    "test:jest": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
+    "test:jest": "NODE_OPTIONS=--max_old_space_size=4096 jest -w=2",
+    "test:watch": "yarn test --watch",
+    "test:coverage": "yarn test --coverage",
     "test": "yarn test:jest",
     "prebuild": "rm -Rf dist",
     "build": "tsc"
   },
   "jest": {
     "testPathIgnorePatterns": [
+      "/dist/",
       "/node_modules/",
       "/__tests__/utils.ts"
     ],

src/core.ts

@@ -1,8 +1,7 @@
 import { Project, SourceFile } from 'ts-morph';
-import pkgup from 'pkg-up';
 
+import { getPackageVersion, nonNullish } from './helpers';
 import { FileUsage, PackageUsage, Options } from './types';
-import { readFileSync } from 'fs';
 
 function getPackageUsage(
   pkg: string,
@@ -27,42 +26,12 @@ function getPackageUsage(
 
   return {
     name: sourceFile.getBaseName(),
+    filePath: sourceFile.getFilePath(),
     defaultImport: defaultImport?.getText(),
     namedImports: namedImports.map((a) => a.getName()),
   };
 }
 
-function getPackageJson(packageJsonCWD?: string) {
-  const pkgJsonPath = pkgup.sync({ cwd: packageJsonCWD });
-
-  const { dependencies, peerDependencies, devDependencies } = JSON.parse(
-    readFileSync(pkgJsonPath!, 'utf8')
-  );
-
-  return {
-    dependencies: new Map<string, string>(
-      dependencies ? Object.entries(dependencies) : undefined
-    ),
-    peerDependencies: new Map<string, string>(
-      peerDependencies ? Object.entries(peerDependencies) : undefined
-    ),
-    devDependencies: new Map<string, string>(
-      devDependencies ? Object.entries(devDependencies) : undefined
-    ),
-  };
-}
-
-function getPackageVersion(pkg: string, packageJsonCWD?: string) {
-  const { dependencies, peerDependencies, devDependencies } =
-    getPackageJson(packageJsonCWD);
-
-  return (
-    dependencies.get(pkg) ||
-    devDependencies.get(pkg) ||
-    peerDependencies.get(pkg)
-  );
-}
-
 export function getPackagesUsages({
   packages,
   fileGlobs,
@@ -78,7 +47,7 @@ export function getPackagesUsages({
   const result = packages.map((pkg) => {
     const fileUsages = sourceFiles
       .map((sourceFile) => getPackageUsage(pkg, sourceFile))
-      .filter(Boolean);
+      .filter(nonNullish);
 
     return {
       name: pkg,

src/helpers.ts

@@ -0,0 +1,40 @@
+import pkgup from 'pkg-up';
+
+import { readFileSync } from 'fs';
+
+// istanbul ignore next
+function getPackageJson(packageJsonCWD?: string) {
+  const pkgJsonPath = pkgup.sync({ cwd: packageJsonCWD });
+
+  const { dependencies, peerDependencies, devDependencies } = JSON.parse(
+    readFileSync(pkgJsonPath!, 'utf8')
+  );
+
+  return {
+    dependencies: new Map<string, string>(
+      dependencies ? Object.entries(dependencies) : undefined
+    ),
+    peerDependencies: new Map<string, string>(
+      peerDependencies ? Object.entries(peerDependencies) : undefined
+    ),
+    devDependencies: new Map<string, string>(
+      devDependencies ? Object.entries(devDependencies) : undefined
+    ),
+  };
+}
+
+// istanbul ignore next
+export function getPackageVersion(pkg: string, packageJsonCWD?: string) {
+  const { dependencies, peerDependencies, devDependencies } =
+    getPackageJson(packageJsonCWD);
+
+  return (
+    dependencies.get(pkg) ||
+    devDependencies.get(pkg) ||
+    peerDependencies.get(pkg)
+  );
+}
+
+export function nonNullish<Value>(v: Value): v is NonNullable<Value> {
+  return v !== undefined && v !== null;
+}

src/types.ts

@@ -6,13 +6,14 @@ export type Options = {
 
 export type FileUsage = {
   name: string;
+  filePath: string;
   defaultImport: string | undefined;
   namedImports: string[];
 };
 
 export type PackageUsage = {
   name: string;
   count: number;
-  files?: (FileUsage | undefined)[];
+  files?: FileUsage[];
   version?: string;
 };

tsconfig.json

@@ -3,10 +3,12 @@
   "compilerOptions": {
     "preserveConstEnums": true,
     "declaration": true,
-    "outDir": "dist"
+    "outDir": "dist",
+    "allowJs": true
   },
   "include": [
     "src/**/*",
+    "scripts/*",
     "__tests__/*",
     "node_modules/@tsconfig/node14/tsconfig.json"
   ],