rev-dep 1.0.0-alpha.5 → 1.0.1

package/README.md

@@ -1,5 +1,5 @@
 <h3 align="center">
-  <code>rev⭠dep</code>
+  <code>rev←dep</code>
 </h3>
 
 <p align="center">
@@ -24,18 +24,18 @@ 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
 
-- You plan to refactor some file and you wonder which entry points are affected
-- You are wondering wether a given source file is used
-- You wonder if there are any dead files in your project
-- You want to identify all dead files at once
-- You want to verify if a given entry point imports only the required files
-- You want to optimize the amount of files imported by an entry point
+- [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)
+- [You want to optimize the amount of files imported by an entry point](#how-to-reduce-amount-of-files-imported-by-entry-point)
 
 ### How about dependency or bundle graphs?
 
@@ -67,48 +67,302 @@ or
 
 ### How to identify where a file is used in the project?
 
+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:
+
+`rev-dep resolve src/lib/utils.ts`
+
+output:
+
+```s
+src/babel/index.js :
+
+ ➞ src/babel/index.js
+  ➞ src/lib/utils.ts
+_____________________
+
+src/cli/index.ts :
+
+ ➞ src/cli/index.ts
+  ➞ src/cli/createCommands.ts
+   ➞ src/cli/resolve/index.ts
+    ➞ src/lib/find.ts
+     ➞ src/lib/getDepsTree.ts
+      ➞ src/lib/getDepsSetWebpack.ts
+       ➞ src/lib/utils.ts
+_____________________
+
+```
+
+</details>
+
+#### Getting more details about file resolution in given entry point
+
+To find out all paths combination use `rev-dep resolve` with `-a` flag
+
+> You might be surprised how complex dependency tree can be!
+
+<details>
+<summary>Example for the rev-dep repository</summary>
+
+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/createCommands.ts
+   ➞ src/cli/resolve/index.ts
+    ➞ src/lib/find.ts
+     ➞ src/lib/getDepsTree.ts
+      ➞ src/lib/getDepsSetWebpack.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/getDepsTree.ts
+       ➞ src/lib/getDepsSetWebpack.ts
+        ➞ src/lib/utils.ts
+
+ ➞ src/cli/index.ts
+  ➞ src/cli/createCommands.ts
+   ➞ src/cli/entryPoints/index.ts
+    ➞ src/lib/getEntryPoints.ts
+     ➞ src/lib/getDepsTree.ts
+      ➞ src/lib/getDepsSetWebpack.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/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/cli/index.ts
+  ➞ src/cli/createCommands.ts
+   ➞ src/cli/entryPoints/index.ts
+    ➞ src/lib/getEntryPoints.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/cli/index.ts
+  ➞ src/cli/createCommands.ts
+   ➞ src/cli/resolve/index.ts
+    ➞ src/lib/utils.ts
+
+ ➞ src/cli/index.ts
+  ➞ src/cli/createCommands.ts
+   ➞ src/cli/entryPoints/index.ts
+    ➞ src/lib/utils.ts
+
+ ➞ src/cli/index.ts
+  ➞ src/cli/createCommands.ts
+   ➞ src/cli/files/index.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`
+
+As a result you will see total amount of entry points requiring a given file.
+
+> Note that among the entry points list there might be some dead files importing the searched file
+
+[`resolve` Command CLI reference](#command-resolve)
+
+<details>
+<summary>Example for the rev-dep repository</summary>
+
+command:
+
+`rev-dep resolve src/lib/utils.ts --compactSummary`
+
+output:
+
+```s
+Results:
+
+__tests__/find.test.js        : 0
+babel.js                      : 0
+bin.js                        : 0
+scripts/addDocsToReadme.js    : 0
+src/babel/index.js            : 1
+src/cli/index.ts              : 1
+src/lib/getMaxDepthInGraph.ts : 0
+types.d.ts                    : 0
+
+Total: 2
+```
+
+</details>
+
 ### How to identify dead files in the project?
 
+Use `rev-dep entry-points` to get list of all files that are not required by any other files in the project.
+
+You might want to exclude some file paths that are meant to be actual entry point like `index.js` or `**/pages/**` in `next.js` projects using `--exclude` flag. The same for configuration files like `babel.config.js`
+
+Review the list and look for suspicious files like `src/ui/components/SomeComponent/index.js`
+
+[`entry-points` command CLI reference](#command-entry-points)
+
+<details>
+<summary>Example for the rev-dep repository</summary>
+
+command:
+
+`rev-dep entry-points --exclude '__tests__/**' 'types.d.ts'`
+
+output:
+
+```s
+babel.js
+bin.js
+scripts/addDocsToReadme.js
+src/babel/index.js
+src/cli/index.ts
+src/lib/getMaxDepthInGraph.ts
+
+```
+
+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`.
+
+You can use `--count` flag if you are interested in the amount.
+
+This is a good indicator of how heavy a given entry point or component is
+
+[`files` command CLI reference](#command-files)
+
+<details>
+<summary>Example for the rev-dep repository</summary>
+
+command:
+
+`rev-dep files files src/cli/index.ts`
+
+output:
+
+```s
+src/cli/index.ts
+src/cli/createCommands.ts
+package.json
+src/cli/resolve/index.ts
+src/cli/docs/index.ts
+src/cli/entryPoints/index.ts
+src/cli/files/index.ts
+src/lib/find.ts
+src/cli/resolve/types.ts
+src/cli/resolve/formatResults.ts
+src/lib/utils.ts
+src/cli/commonOptions.ts
+src/cli/docs/generate.ts
+src/cli/entryPoints/types.ts
+src/lib/getEntryPoints.ts
+src/lib/buildDepsGraph.ts
+src/cli/files/types.ts
+src/lib/getDepsTree.ts
+src/lib/types.ts
+src/cli/docs/template.ts
+src/lib/getDepsSetWebpack.ts
+src/lib/cleanupDpdmDeps.ts
+
+```
+
+As you can see cli even import `package.json`. This is to print version of the cli
+
+</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`
+
+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`
+
+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
 
 Project can be used as a CLI tool or as a module
 
 ### CLI Tool
 
-For CLI usage see [CLI reference](#CLI-reference)
+For CLI usage see [CLI reference](#cli-reference)
 
 ### Module
 
-#### `find` Function
+#### `resolve` Function
 
 ```ts
-import { find } from "rev-dep";
+import { resolve } from "rev-dep";
 
-const path = find({
+const [paths] = await resolve({
   entryPoints: ["index.js"],
   filePath: "utils.js",
 });
 
-console.log(path);
+console.log(paths);
 ```
 
-#### `find` Function
+#### `getEntryPoints` Function
 
 ```ts
-import { find } from "rev-dep";
+import { getEntryPoints } from "rev-dep";
 
-const path = find({
-  entryPoints: ["index.js"],
-  filePath: "utils.js",
+const [entryPoints] = await getEntryPoints({
+  cwd: process.cwd(),
 });
 
-console.log(path);
+console.log(entryPoints);
 ```
 
 ## CLI reference
@@ -203,9 +457,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/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const find_1 = require("../../lib/find");
+const resolve_1 = require("../../lib/resolve");
 const formatResults_1 = require("./formatResults");
 const utils_1 = require("../../lib/utils");
 const commonOptions_1 = require("../commonOptions");
@@ -20,7 +20,7 @@ function createResolve(program) {
         .option('-a, --all', 'finds all paths combination of a given dependency. Might work very slow or crash for some projects due to heavy usage of RAM', false)
         .action(async (filePath, entryPoints, data) => {
         const { compactSummary, webpackConfig, all, cwd, exclude, include } = data;
-        const [results, resolveEntryPoints] = await (0, find_1.resolve)({
+        const [results, resolveEntryPoints] = await (0, resolve_1.resolve)({
             entryPoints,
             filePath,
             webpackConfig,

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/dist/module.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntryPoints = exports.resolve = void 0;
+var resolve_1 = require("./lib/resolve");
+Object.defineProperty(exports, "resolve", { enumerable: true, get: function () { return resolve_1.resolve; } });
+var getEntryPoints_1 = require("./lib/getEntryPoints");
+Object.defineProperty(exports, "getEntryPoints", { enumerable: true, get: function () { return getEntryPoints_1.getEntryPoints; } });

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "rev-dep",
-  "version": "1.0.0-alpha.5",
-  "description": "Reverse dependency resolution tool built with dependency-cruiser",
-  "main": "lib/find.js",
+  "version": "1.0.1",
+  "description": "Dependency debugging tool for JavaScript and TypeScript projects",
+  "main": "dist/module.js",
   "bin": "bin.js",
   "files": [
     "dist/**",
@@ -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"
   },
@@ -59,5 +60,18 @@
     "prettier": "^2.1.2",
     "release-it": "^14.2.1",
     "typescript": "^4.6.2"
-  }
+  },
+  "keywords": [
+    "dependencies",
+    "deps",
+    "dependency graph",
+    "dependency debugging",
+    "entry points",
+    "dependency resolution",
+    "reverse dependency resolution",
+    "dependency tree",
+    "import path",
+    "resolution path",
+    "dependency optimization"
+  ]
 }