Merge pull request #3 from luistak/feat/cli-enchancements

luistak · web-flow · commit b8241715cc81 · 2021-10-08T21:56:59.000-03:00
Feat/cli enchancements
diff --git a/README.md b/README.md
@@ -23,35 +23,62 @@ Given a few options you can gets details about how your library is being importe
 ```js
 import { getPackagesUsages } from 'pkg-usage';
 
-const usages = getPackagesUsages({
+const usages: PackageUsage[] = getPackagesUsages({
   packages: ['react'],
   fileGlobs: `**/**.ts`,
 });
 
 console.log(usages);
 ```
 
-Output
-
-```json
-[
-  {
-    count: 1,
-    files: [
-      {
-        defaultImport: undefined,
-        name: `${fileName}.ts`,
-        namedImports: imports,
-      },
-    ],
-    name: pkg,
-    version,
-  }
-]
+Package Usage types
+
+```ts
+export type FileUsage = {
+  name: string;
+  filePath: string;
+  defaultImport: string | undefined;
+  namedImports: string[];
+};
+
+export type PackageUsage = {
+  name: string;
+  count: number;
+  files?: FileUsage[];
+  version?: string;
+};
 ```
 
-## Current features:
+## CLI usage
 
-- The package version
-- How many files are importing your `package`
-- What are the default and named imports by file
+| Options                  | Description                          | Example                                        |
+| ------------------------ | ------------------------------------ | ---------------------------------------------- |
+| -p, --packages           | Packages to analyze                  | -p vue,vuex or --packages="react,redux"        |
+| -f, --file-globs         | Files to analyze based on file globs | -f "_.(ts\|tsx)" or --file-globs="_.(js\|jsx)" |
+| -cwd, --package-json-CWD | Directory to start from              | -cwd "/path/to/start/from"                     |
+
+### npx
+
+[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool
+
+```bash
+npx pkg-usage -p "react,redux" --f "**/*.(ts|tsx)"
+```
+
+Or
+
+```bash
+npx pkg-usage --packages="vue,vuex" --file-globs="**/*.(js|jsx)"
+```
+
+If you use npm 5.1 or earlier, you can't use npx. Instead, install it globally:
+
+```bash
+npm install -g pkg-usage
+```
+
+Now you can run:
+
+```bash
+pkg-usage -p "react,redux" --f "**/*.(ts|tsx)"
+```
diff --git a/__tests__/pkg-usage.test.ts b/__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,
             },
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pkg-usage",
-  "version": "0.2.1-pre",
+  "version": "0.2.1",
   "description": "Npm package usage metrics",
   "main": "dist/src/index.js",
   "files": [
@@ -9,6 +9,13 @@
     "example",
     "scripts"
   ],
+  "keywords": [
+    "node",
+    "npm",
+    "package",
+    "usage",
+    "resources"
+  ],
   "bin": {
     "pkg-usage": "./scripts/pkg-usage.js"
   },
@@ -45,15 +52,18 @@
     "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"
+    "build": "tsc",
+    "prerelease": "cz bump",
+    "release": "npm publish"
   },
   "jest": {
     "testPathIgnorePatterns": [
+      "/dist/",
       "/node_modules/",
       "/__tests__/utils.ts"
     ],
@@ -68,6 +78,7 @@
     ]
   },
   "dependencies": {
+    "commander": "^8.2.0",
     "pkg-up": "^3.1.0",
     "ts-morph": "^11.0.3"
   },
diff --git a/scripts/pkg-usage.js b/scripts/pkg-usage.js
@@ -1,35 +1,37 @@
 #!/usr/bin/env node
 
-const { getPackagesUsages } = require('pkg-usage');
+// const { getPackagesUsages } = require('pkg-usage');
+const { getPackagesUsages } = require('../dist/src');
+const { Command } = require('commander');
 
-function getOptionsFromArgs(options) {
-  const argsMap = {
-    '--packages': 'packages',
-    '--file-globs': 'fileGlobs',
-  };
+const program = new Command();
 
-  return options.reduce((acc, option) => {
-    const [key, value] = option.split('=');
-
-    if (value) {
-      return { ...acc, [argsMap[key]]: value };
-    }
-
-    return acc;
-  }, {});
+function commaSeparatedList(value) {
+  return value.split(',');
 }
 
-async function run() {
-  const args = process.argv.slice(2);
-
-  const { packages, fileGlobs } = getOptionsFromArgs(args);
-
-  const usages = getPackagesUsages({
-    packages: packages.split(','),
-    fileGlobs,
+program
+  .requiredOption(
+    '-p, --packages <items>',
+    'Packages to analyze ex: -p vue,vuex or --packages="react,redux"',
+    commaSeparatedList
+  )
+  .requiredOption(
+    '-f, --file-globs <value>',
+    'Files to analyze based on file globs ex: -f "**/*.(ts|tsx)" or --file-globs="**/*.(js|jsx)"'
+  )
+  .option(
+    '-cwd, --package-json-CWD <value>',
+    'Directory to start from ex: -cwd "/path/to/start/from"'
+  )
+  .action(({ packages, fileGlobs, packageJsonCWD }) => {
+    const usages = getPackagesUsages({
+      packages,
+      fileGlobs,
+      packageJsonCWD,
+    });
+
+    console.log(JSON.stringify(usages, undefined, 2));
   });
 
-  console.log(JSON.stringify(usages, undefined, 2));
-}
-
-run();
+program.parse(process.argv);
diff --git a/src/core.ts b/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,
diff --git a/src/helpers.ts b/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;
+}
diff --git a/src/types.ts b/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;
 };
diff --git a/tsconfig.json b/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"
   ],
diff --git a/yarn.lock b/yarn.lock
@@ -1225,6 +1225,11 @@ combined-stream@^1.0.8:
   dependencies:
     delayed-stream "~1.0.0"
 
+commander@^8.2.0:
+  version "8.2.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-8.2.0.tgz#37fe2bde301d87d47a53adeff8b5915db1381ca8"
+  integrity sha512-LLKxDvHeL91/8MIyTAD5BFMNtoIwztGPMiM/7Bl8rIPmHCZXRxmSWr91h57dpOpnQ6jIUqEWdXE/uBYMfiVZDA==
+
 commitizen@^4.0.3, commitizen@^4.2.4:
   version "4.2.4"
   resolved "https://registry.yarnpkg.com/commitizen/-/commitizen-4.2.4.tgz#a3e5b36bd7575f6bf6e7aa19dbbf06b0d8f37165"

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ describe('getPackagesUsages()', () => {`
`60`	`60`	`files: [`
`61`	`61`	`{`
`62`	`62`	`defaultImport: undefined,`
	`63`	+ filePath: `${MOCKS_DIR_CWD}/${fileName}.ts`,
`63`	`64`	name: `${fileName}.ts`,
`64`	`65`	`namedImports: imports,`
`65`	`66`	`},`