rev-dep 1.0.0-alpha.6 → 1.0.2

package/README.md

@@ -1,5 +1,5 @@
 <h3 align="center">
-  <code>rev←dep</code>
+  <code>rev-dep</code>
 </h3>
 
 <p align="center">
@@ -10,13 +10,15 @@
 
 <img alt="rev-dep version" src="https://img.shields.io/npm/v/rev-dep"> <img alt="rev-dep license" src="https://img.shields.io/npm/l/rev-dep"> <img alt="rev-dep PRs welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square">
 
-## About
+## About 📣
 
 The tool was created help with daily dev struggles by answering these questions:
 
-- What entry points my codebase have
-- Which entry points uses a given file
-- Which dependencies a given file has
+👉 What entry points my codebase have
+
+👉 Which entry points uses a given file
+
+👉 Which dependencies a given file has
 
 This helps to debug project dependencies, plan refactoring, optimize bundles or plan code splitting.
 
@@ -24,14 +26,13 @@ It's especially useful in JS world without TypeScript or tests coverage.
 
 It also helps to identify and eliminate dead files, understand the complexity of the file dependencies
 
-[Jump to CLI reference](#cli-reference)
+[🦘 Jump to CLI reference](#cli-reference)
 
-[`export * from` problem](#export-from-problem)
+[🕸️ `export * from` problem](#export-from-problem)
 
-### Use cases
+### Use cases 🧑‍💻
 
 - [You plan to refactor some file and you wonder which entry points are affected](#how-to-identify-where-a-file-is-used-in-the-project)
-
 - [You are wondering wether a given source file is used](#how-to-check-if-a-file-is-used-in-the-project)
 - [You wonder if there are any dead files in your project](#how-to-identify-dead-files-in-the-project)
 - [You want to verify if a given entry point imports only the required files](#how-to-check-which-files-are-imported-by-a-given-file)
@@ -45,7 +46,7 @@ While graphs can be useful to identify major problems like too big bundle size o
 
 `rev-dep` visualize dependencies as lists, so it's really easy to see where to cut the line to solve the problem.
 
-## Getting Started
+## Getting Started 🎉
 
 ### Install globally to use as CLI tool
 
@@ -63,7 +64,7 @@ or
 
 `npm install rev-dep`
 
-## Recipes
+## Recipes 🌶️
 
 ### How to identify where a file is used in the project?
 
@@ -72,23 +73,24 @@ Just use `rev-dep resolve path/to/file.ts`
 You will see all the entry points that implicitly require given file together with resolution path.
 
 [`resolve` Command CLI reference](#command-resolve)
+
 <details>
 <summary>Example for the rev-dep repository</summary>
 
-command: 
+command:
 
 `rev-dep resolve src/lib/utils.ts`
 
 output:
 
 ```s
-src/babel/index.js : 
+src/babel/index.js :
 
  ➞ src/babel/index.js
-  ➞ src/lib/utils.ts 
+  ➞ src/lib/utils.ts
 _____________________
 
-src/cli/index.ts : 
+src/cli/index.ts :
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
@@ -96,10 +98,11 @@ src/cli/index.ts :
     ➞ src/lib/find.ts
      ➞ src/lib/getDepsTree.ts
       ➞ src/lib/getDepsSetWebpack.ts
-       ➞ src/lib/utils.ts 
+       ➞ src/lib/utils.ts
 _____________________
 
 ```
+
 </details>
 
 #### Getting more details about file resolution in given entry point
@@ -111,14 +114,14 @@ To find out all paths combination use `rev-dep resolve` with `-a` flag
 <details>
 <summary>Example for the rev-dep repository</summary>
 
-command: 
+command:
 
 `rev-dep resolve src/lib/utils.ts src/cli/index.ts --all`
 
 output:
 
 ```s
-src/cli/index.ts : 
+src/cli/index.ts :
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
@@ -126,7 +129,7 @@ src/cli/index.ts :
     ➞ src/lib/find.ts
      ➞ src/lib/getDepsTree.ts
       ➞ src/lib/getDepsSetWebpack.ts
-       ➞ src/lib/utils.ts 
+       ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
@@ -135,7 +138,7 @@ src/cli/index.ts :
      ➞ src/lib/getEntryPoints.ts
       ➞ src/lib/getDepsTree.ts
        ➞ src/lib/getDepsSetWebpack.ts
-        ➞ src/lib/utils.ts 
+        ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
@@ -143,55 +146,56 @@ src/cli/index.ts :
     ➞ src/lib/getEntryPoints.ts
      ➞ src/lib/getDepsTree.ts
       ➞ src/lib/getDepsSetWebpack.ts
-       ➞ src/lib/utils.ts 
+       ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/files/index.ts
     ➞ src/lib/getDepsTree.ts
      ➞ src/lib/getDepsSetWebpack.ts
-      ➞ src/lib/utils.ts 
+      ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/resolve/index.ts
     ➞ src/lib/find.ts
      ➞ src/lib/getEntryPoints.ts
-      ➞ src/lib/utils.ts 
+      ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/entryPoints/index.ts
     ➞ src/lib/getEntryPoints.ts
-     ➞ src/lib/utils.ts 
+     ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/resolve/index.ts
     ➞ src/lib/find.ts
-     ➞ src/lib/utils.ts 
+     ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/resolve/index.ts
-    ➞ src/lib/utils.ts 
+    ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/entryPoints/index.ts
-    ➞ src/lib/utils.ts 
+    ➞ src/lib/utils.ts
 
  ➞ src/cli/index.ts
   ➞ src/cli/createCommands.ts
    ➞ src/cli/files/index.ts
-    ➞ src/lib/utils.ts 
+    ➞ src/lib/utils.ts
 
 ```
+
 </details>
 
 ### How to check if a file is used in the project?
 
-Use `rev-dep resolve path/to/file.ts --compactSummary` 
+Use `rev-dep resolve path/to/file.ts --compactSummary`
 
 As a result you will see total amount of entry points requiring a given file.
 
@@ -202,7 +206,7 @@ As a result you will see total amount of entry points requiring a given file.
 <details>
 <summary>Example for the rev-dep repository</summary>
 
-command: 
+command:
 
 `rev-dep resolve src/lib/utils.ts --compactSummary`
 
@@ -222,6 +226,7 @@ types.d.ts                    : 0
 
 Total: 2
 ```
+
 </details>
 
 ### How to identify dead files in the project?
@@ -237,7 +242,7 @@ Review the list and look for suspicious files like `src/ui/components/SomeCompon
 <details>
 <summary>Example for the rev-dep repository</summary>
 
-command: 
+command:
 
 `rev-dep entry-points --exclude '__tests__/**' 'types.d.ts'`
 
@@ -253,14 +258,15 @@ src/lib/getMaxDepthInGraph.ts
 
 ```
 
-The last one `src/lib/getMaxDepthInGraph.ts` is the source file that is not used at the moment. 
+The last one `src/lib/getMaxDepthInGraph.ts` is the source file that is not used at the moment.
 
 The rest of them looks legit!
+
 </details>
 
 ### How to check which files are imported by a given file?
 
-To get a full list of files imported by given entry point use `rev-dep files path/to/file.ts`. 
+To get a full list of files imported by given entry point use `rev-dep files path/to/file.ts`.
 
 You can use `--count` flag if you are interested in the amount.
 
@@ -271,7 +277,7 @@ This is a good indicator of how heavy a given entry point or component is
 <details>
 <summary>Example for the rev-dep repository</summary>
 
-command: 
+command:
 
 `rev-dep files files src/cli/index.ts`
 
@@ -304,23 +310,25 @@ src/lib/cleanupDpdmDeps.ts
 ```
 
 As you can see cli even import `package.json`. This is to print version of the cli
-</details>
 
+</details>
 
 ### How to reduce amount of files imported by entry point?
 
-There is no easy how to for this process, but you can do it iteratively using two of the `rev-dep` commands:
-- `files` 
-- `resolve`
+There is no easy how to for this process, but you can do it iteratively using `rev-dep` commands `files` and `resolve`
+
+1. Get the list of files imported by entry-point
+
+   `rev-dep files path/to/entry-point`
 
-1. Get the list of files imported by entry-point 
-  - `rev-dep files path/to/entry-point`
 2. Identify some suspicious files on the list, components that should not be used on the given page or not related utility files
 3. Get all resolution paths for a suspicious file
-  - `rev-dep resolve path/to/suspicious-file path/to/entry-point --all`
+
+   `rev-dep resolve path/to/suspicious-file path/to/entry-point --all`
+
 4. You would usually find out that there is some file, like directory `index` file that given entry point is using, which is mandatory, but as a side effect it imports a few files that are redundant for your entry point. In most cases you should be able to decouple the imports or reverse the dependency to cut off the resolution path for the unwanted file
 
-## Usage
+## Usage 🎨
 
 Project can be used as a CLI tool or as a module
 
@@ -335,7 +343,7 @@ For CLI usage see [CLI reference](#cli-reference)
 ```ts
 import { resolve } from "rev-dep";
 
-const paths = resolve({
+const [paths] = await resolve({
   entryPoints: ["index.js"],
   filePath: "utils.js",
 });
@@ -348,14 +356,14 @@ console.log(paths);
 ```ts
 import { getEntryPoints } from "rev-dep";
 
-const entryPoints = getEntryPoints({
+const [entryPoints] = await getEntryPoints({
   cwd: process.cwd(),
 });
 
 console.log(entryPoints);
 ```
 
-## CLI reference
+## CLI reference 📖
 
 <!-- cli-docs-start -->
 
@@ -447,9 +455,7 @@ rev-dep docs <outputPath> [options]
 ```js
 // babel.config.js
 module.exports = {
-  plugins: [
-    'rev-dep/babel'
-  ]
+  plugins: ["rev-dep/babel"],
 };
 ```
 

package/bin.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('./dist/cli');
+require('./dist/cli')

package/dist/babel/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli/commonOptions.d.ts

@@ -0,0 +1,23 @@
+declare type OptionMeta2 = [string, string];
+declare type OptionMeta3 = [string, string, string];
+export declare const webpackConfigOption: OptionMeta2;
+export declare type WebpackConfigOptionType = {
+    webpackConfig?: string;
+};
+export declare const cwdOption: OptionMeta3;
+export declare type CwdOptionType = {
+    cwd: string;
+};
+export declare const reexportRewireOption: OptionMeta2;
+export declare type ReexportRewireOptionType = {
+    reexportRewire?: boolean;
+};
+export declare const includeOption: OptionMeta2;
+export declare type IncludeOptionType = {
+    include?: string[];
+};
+export declare const excludeOption: OptionMeta2;
+export declare type ExcludeOptionType = {
+    exclude?: string[];
+};
+export {};

package/dist/cli/createCommands.d.ts

@@ -0,0 +1,2 @@
+import commander from 'commander';
+export declare function createCommands(program: commander.Command): void;

package/dist/cli/docs/generate.d.ts

@@ -0,0 +1,20 @@
+export declare type Command = {
+    name: string;
+    arguments: {
+        nameRaw: string;
+        name: string;
+        required: boolean;
+        description?: string;
+    }[];
+    description?: string;
+    options: {
+        shortName: string;
+        longName?: string;
+        argument?: string;
+        description?: string;
+        defaultValue?: string;
+        required: boolean;
+    }[];
+};
+declare function generate(output: string, initialHeaderLevel: number): void;
+export default generate;

package/dist/cli/docs/index.d.ts

@@ -0,0 +1,3 @@
+import commander from 'commander';
+declare function create(program: commander.Command): void;
+export default create;

package/dist/cli/docs/template.d.ts

@@ -0,0 +1,3 @@
+import { Command } from './generate';
+declare function template(commands: Command[], headerLevel: number): string;
+export default template;

package/dist/cli/entryPoints/index.d.ts

@@ -0,0 +1,2 @@
+import commander from 'commander';
+export default function createEntryPoints(program: commander.Command): void;

package/dist/cli/entryPoints/types.d.ts

@@ -0,0 +1,4 @@
+export declare type InputParams = {
+    printDependenciesCount?: boolean;
+    count?: boolean;
+};

package/dist/cli/files/index.d.ts

@@ -0,0 +1,2 @@
+import commander from 'commander';
+export default function createFiles(program: commander.Command): void;

package/dist/cli/files/types.d.ts

@@ -0,0 +1,3 @@
+export declare type InputParams = {
+    count?: boolean;
+};

package/dist/cli/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli/resolve/formatResults.d.ts

@@ -0,0 +1,9 @@
+import { InputParams } from './types';
+declare type Results = Array<Array<Array<string>>>;
+export declare function formatResults({ results, filePath, entryPoints, compactSummary }: {
+    results: Results;
+    compactSummary: InputParams['compactSummary'];
+    entryPoints: string[];
+    filePath: string;
+}): string;
+export {};

package/dist/cli/resolve/index.d.ts

@@ -0,0 +1,2 @@
+import commander from 'commander';
+export default function createResolve(program: commander.Command): void;

package/dist/cli/resolve/types.d.ts

@@ -0,0 +1,9 @@
+export declare type InputParams = {
+    compactSummary?: boolean;
+    verbose?: boolean;
+    webpackConfig?: string;
+    typescriptConfig?: string;
+    printMaxDepth?: boolean;
+    printDependentCount?: boolean;
+    all: boolean;
+};

package/dist/lib/buildDepsGraph.d.ts

@@ -0,0 +1,2 @@
+import { Node, MinimalDependencyTree } from './types';
+export declare const buildGraphDpdm: (deps: MinimalDependencyTree, filePath?: string | undefined) => (entryPoint: string) => [Node, Node | null, Map<string, Node>];

package/dist/lib/cleanupDpdmDeps.d.ts

@@ -0,0 +1,3 @@
+import { DependencyTree } from 'dpdm';
+import { MinimalDependencyTree } from './types';
+export declare const cleanupDpdmDeps: (deps: MinimalDependencyTree | DependencyTree) => MinimalDependencyTree;

package/dist/lib/getDepsSetWebpack.d.ts

@@ -0,0 +1,6 @@
+export declare const getDepsSetWebpack: (entryPoints: string[], webpackConfigPath: string, cwd: string, skipRegex?: RegExp | undefined) => {
+    [key: string]: {
+        id: string;
+        request: string;
+    }[];
+};

package/dist/lib/getDepsTree.d.ts

@@ -0,0 +1 @@
+export declare function getDepsTree(cwd: string, entryPoints: string[], webpackConfigPath?: string): Promise<import("./types").MinimalDependencyTree>;

package/dist/lib/getEntryPoints.d.ts

@@ -0,0 +1,9 @@
+import { MinimalDependencyTree } from './types';
+export declare const getDirectoriesForEntryPointsSearch: (dir: string) => Promise<string[]>;
+export declare const findEntryPointsInDepsTree: (deps: MinimalDependencyTree, exclude?: string[], include?: string[] | undefined) => string[];
+export declare const getEntryPoints: ({ cwd, exclude, include, webpackConfigPath }: {
+    cwd: string;
+    exclude?: string[] | undefined;
+    include?: string[] | undefined;
+    webpackConfigPath?: string | undefined;
+}) => Promise<[string[], MinimalDependencyTree]>;

package/dist/lib/getMaxDepthInGraph.d.ts

@@ -0,0 +1,4 @@
+import { Node } from './types';
+declare type MaxDepthMeta = [number, string[]];
+export declare const getMaxDepth: (depth?: number, path?: string[], vertices?: Map<any, any>) => (tree: Node) => MaxDepthMeta;
+export {};

package/dist/lib/resolve.d.ts

@@ -0,0 +1,11 @@
+declare type ResolveParams = {
+    entryPoints: string[];
+    filePath: string;
+    webpackConfig?: string;
+    cwd?: string;
+    all: boolean;
+    exclude?: string[];
+    include?: string[];
+};
+export declare const resolve: ({ entryPoints: _entryPoints, filePath, webpackConfig, cwd, all, include, exclude }: ResolveParams) => Promise<[string[][][], string[]]>;
+export {};

package/dist/lib/types.d.ts

@@ -0,0 +1,10 @@
+import { Dependency } from 'dpdm';
+export declare type Node = {
+    path: string;
+    children: Node[];
+    parents: Node[];
+};
+export declare type MinimalDependency = Pick<Dependency, 'id' | 'request'>;
+export declare type MinimalDependencyTree = {
+    [key: string]: readonly MinimalDependency[] | null;
+};

package/dist/lib/utils.d.ts

@@ -0,0 +1,6 @@
+export declare const removeInitialDot: (path: string) => string;
+export declare const createResolveAbsolutePath: (cwd: string) => (p: string | undefined) => string | undefined;
+export declare const asyncFilter: <T>(arr: T[], predicate: (el: T) => Promise<boolean>) => Promise<T[]>;
+export declare const sanitizeUserEntryPoints: (entryPoints: string[]) => string[];
+export declare const resolvePath: <P extends string | undefined>(p: P) => string | P;
+export declare const findTsConfig: (cwd?: string) => string | undefined;

package/dist/module.d.ts

@@ -0,0 +1,2 @@
+export { resolve } from './lib/resolve';
+export { getEntryPoints } from './lib/getEntryPoints';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rev-dep",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.2",
   "description": "Dependency debugging tool for JavaScript and TypeScript projects",
   "main": "dist/module.js",
   "bin": "bin.js",
@@ -21,13 +21,14 @@
     "node": ">=10"
   },
   "scripts": {
+    "checks": "yarn lint && yarn typecheck",
     "lint": "eslint --ext .js,.ts src",
     "lint:fix": "yarn lint --fix",
     "docs-gen": "node ./scripts/addDocsToReadme.js",
     "dev": "node bin",
     "test": "jest",
     "release": "release-it",
-    "build": "tsc",
+    "build": "tsc --declaration",
     "build:watch": "tsc --watch",
     "typecheck": "tsc --noEmit"
   },

package/dist/lib/find.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolve = void 0;
-const buildDepsGraph_1 = require("./buildDepsGraph");
-const getDepsTree_1 = require("./getDepsTree");
-const getEntryPoints_1 = require("./getEntryPoints");
-const utils_1 = require("./utils");
-const resolvePathsToRoot = (node, all = false, resolvedPaths = [[]]) => {
-    const newPaths = resolvedPaths.map((resolvedPath) => [
-        node.path,
-        ...resolvedPath
-    ]);
-    if (node.parents.length === 0) {
-        return newPaths;
-    }
-    if (all) {
-        return node.parents
-            .map((parentPath) => resolvePathsToRoot(parentPath, all, newPaths))
-            .flat(1);
-    }
-    return resolvePathsToRoot(node.parents[0], false, newPaths);
-};
-const resolve = async ({ entryPoints: _entryPoints, filePath, webpackConfig, cwd = process.cwd(), all, include, exclude }) => {
-    let deps, entryPoints;
-    if (_entryPoints.length > 0) {
-        entryPoints = _entryPoints;
-        const sanitizedEntryPoints = (0, utils_1.sanitizeUserEntryPoints)(entryPoints);
-        deps = await (0, getDepsTree_1.getDepsTree)(cwd, sanitizedEntryPoints, webpackConfig);
-    }
-    else {
-        ;
-        [entryPoints, deps] = await (0, getEntryPoints_1.getEntryPoints)({ cwd, exclude, include });
-    }
-    const cleanedEntryPoints = entryPoints.map(utils_1.removeInitialDot);
-    const cleanedFilePath = (0, utils_1.removeInitialDot)(filePath);
-    const forest = cleanedEntryPoints.map((0, buildDepsGraph_1.buildGraphDpdm)(deps, cleanedFilePath));
-    const resolvedPaths = forest.reduce((allPaths, [_, fileNode]) => {
-        if (!fileNode) {
-            return [...allPaths, []];
-        }
-        const pathsForTree = resolvePathsToRoot(fileNode, all);
-        return [...allPaths, pathsForTree];
-    }, []);
-    return [resolvedPaths, entryPoints];
-};
-exports.resolve = resolve;