rev-dep 1.0.0-alpha.0 → 1.0.0-alpha.1

package/README.md

@@ -117,7 +117,7 @@ For example, to support `*.ts` and `*.tsx` implicit extensions in globally insta
 
 ### Command `resolve`
 
-Description not available
+Checks if a filePath is required from entryPoint(s) and prints the resolution path
 
 #### Usage
 
@@ -127,18 +127,58 @@ rev-dep resolve <filePath> [entryPoints...] [options]
 
 #### Arguments
 
-- `filePath` - undefined (**required**),\* `entryPoints...` - undefined (_optional_)
+- `filePath` - Path to a file that should be resolved in entry points (**required**),\* `entryPoints...` - List of entry points to look for file (_optional_)
 
 #### Options
 
+- `-wc, --webpackConfig <path>` - path to webpack config to enable webpack aliases support (_optional_)
+- `--cwd <path>` - path to a directory that should be used as a resolution root (_optional_)
+- `--rr reexportRewire <value>` - resolve actual dependencies for "export \* from" statements (_optional_)
+- `-i include <globs...>` - A list of globs to determine files included in entry points search (_optional_)
+- `-e exclude <globs...>` - A list of globs to determine files excluded in entry points search (_optional_)
 - `-cs, --compactSummary` - print a compact summary of reverse resolution with a count of found paths (_optional_)
-- `--verbose` - print current action information (_optional_)
+- `-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 (_optional_)
+
+### Command `entry-points`
+
+Print list of entry points in current directory
+
+#### Usage
+
+```sh
+rev-dep entry-points [options]
+```
+
+#### Options
+
+- `-wc, --webpackConfig <path>` - path to webpack config to enable webpack aliases support (_optional_)
+- `--cwd <path>` - path to a directory that should be used as a resolution root (_optional_)
+- `--rr reexportRewire <value>` - resolve actual dependencies for "export \* from" statements (_optional_)
+- `-i include <globs...>` - A list of globs to determine files included in entry points search (_optional_)
+- `-e exclude <globs...>` - A list of globs to determine files excluded in entry points search (_optional_)
+- `-pdc, --printDependenciesCount` - print count of entry point dependencies (_optional_)
+- `-c, --count` - print just count of found entry points (_optional_)
+
+### Command `files`
+
+Get list of files required by entry point
+
+#### Usage
+
+```sh
+rev-dep files <entryPoint> [options]
+```
+
+#### Arguments
+
+- `entryPoint` - Path to entry point (**required**)
+
+#### Options
+
 - `-wc, --webpackConfig <path>` - path to webpack config to enable webpack aliases support (_optional_)
-- `-tc, --typescriptConfig <path>` - path to TypeScript config to enable TS aliases support (_optional_)
-- `-md, --maxDepth <maxDepth>` - max depth of the dependency tree (_optional_)
-- `-pmd, --printMaxDepth` - print max depth in the tree (_optional_)
-- `-pdc, --printDependentCount` - print count of entry point dependencies (_optional_)
-- `-co, --checkOnly` - finds only one path to entry point instead of all (_optional_)
+- `--cwd <path>` - path to a directory that should be used as a resolution root (_optional_)
+- `--rr reexportRewire <value>` - resolve actual dependencies for "export \* from" statements (_optional_)
+- `-c, --count` - print only count of entry point dependencies (_optional_)
 
 ### Command `docs`
 

package/dist/cli/commonOptions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reexportRewireOption = exports.cwdOption = exports.webpackConfigOption = void 0;
+exports.excludeOption = exports.includeOption = exports.reexportRewireOption = exports.cwdOption = exports.webpackConfigOption = void 0;
 exports.webpackConfigOption = [
     '-wc, --webpackConfig <path>',
     'path to webpack config to enable webpack aliases support'
@@ -14,3 +14,11 @@ exports.reexportRewireOption = [
     '--rr reexportRewire <value>',
     'resolve actual dependencies for "export * from" statements'
 ];
+exports.includeOption = [
+    '-i include <globs...>',
+    'A list of globs to determine files included in entry points search'
+];
+exports.excludeOption = [
+    '-e exclude <globs...>',
+    'A list of globs to determine files excluded in entry points search'
+];

package/dist/cli/entryPoints/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commonOptions_1 = require("../commonOptions");
 const getEntryPoints_1 = require("../../lib/getEntryPoints");
 const buildDepsGraph_1 = require("../../lib/buildDepsGraph");
+const utils_1 = require("../../lib/utils");
 function createEntryPoints(program) {
     program
         .command('entry-points')
@@ -10,19 +11,32 @@ function createEntryPoints(program) {
         .option(...commonOptions_1.webpackConfigOption)
         .option(...commonOptions_1.cwdOption)
         .option(...commonOptions_1.reexportRewireOption)
-        .option('-pdc, --printDependentCount', 'print count of entry point dependencies', false)
+        .option(...commonOptions_1.includeOption)
+        .option(...commonOptions_1.excludeOption)
+        .option('-pdc, --printDependenciesCount', 'print count of entry point dependencies', false)
+        .option('-c, --count', 'print just count of found entry points', false)
         .action(async (data) => {
-        const { webpackConfig: webpackConfigPath, cwd, printDependentCount } = data;
+        const { webpackConfig: webpackConfigPath, cwd, printDependenciesCount, include, exclude, count } = data;
         const [entryPoints, depsTree] = await (0, getEntryPoints_1.getEntryPoints)({
-            cwd,
-            webpackConfigPath
+            cwd: (0, utils_1.resolvePath)(cwd),
+            webpackConfigPath,
+            exclude,
+            include
         });
         let depsCount = null;
-        if (printDependentCount) {
+        if (printDependenciesCount) {
             depsCount = entryPoints
                 .map((0, buildDepsGraph_1.buildGraphDpdm)(depsTree))
                 .map(([_, __, vertices]) => vertices.size);
         }
+        if (count) {
+            console.log('Found', entryPoints.length, 'entry points.');
+            return;
+        }
+        if (entryPoints.length === 0) {
+            console.log('No results found');
+            return;
+        }
         entryPoints.forEach((pathName, idx) => {
             if (depsCount !== null) {
                 console.log(pathName, depsCount[idx]);

package/dist/cli/files/index.js

@@ -6,7 +6,9 @@ const getDepsTree_1 = require("../../lib/getDepsTree");
 function createFiles(program) {
     program
         .command('files <entryPoint>')
-        .description('Get list of files required by entry point')
+        .description('Get list of files required by entry point', {
+        entryPoint: 'Path to entry point'
+    })
         .option(...commonOptions_1.webpackConfigOption)
         .option(...commonOptions_1.cwdOption)
         .option(...commonOptions_1.reexportRewireOption)
@@ -14,8 +16,12 @@ function createFiles(program) {
         .action(async (entryPoint, data) => {
         const { webpackConfig: webpackConfigPath, cwd, count } = data;
         const sanitizedEntryPoints = (0, utils_1.sanitizeUserEntryPoints)([entryPoint]);
-        const depsTree = await (0, getDepsTree_1.getDepsTree)(cwd, sanitizedEntryPoints, webpackConfigPath);
+        const depsTree = await (0, getDepsTree_1.getDepsTree)((0, utils_1.resolvePath)(cwd), sanitizedEntryPoints, webpackConfigPath);
         const filePaths = Object.keys(depsTree);
+        if (filePaths.length === 0) {
+            console.log('No results found');
+            return;
+        }
         if (count) {
             console.log(filePaths.length);
         }

package/dist/cli/resolve/formatResults.js

@@ -1,6 +1,30 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatResults = void 0;
+const colors = __importStar(require("colorette"));
 const pathToString = (str, filePath, indentation) => {
     return `${str ? `${str}\n` : ''}${' '.repeat(indentation)} ➞ ${filePath}`;
 };
@@ -10,10 +34,10 @@ function formatResults({ results, filePath, entryPoints, compactSummary }) {
     const hasAnyResults = results.some((paths) => paths.length > 0);
     if (!hasAnyResults) {
         formatted = join('No results found for', filePath, 'in', entryPoints);
-        return;
+        return formatted;
     }
-    formatted += join('Results:\n');
     if (compactSummary) {
+        formatted += join('Results:\n');
         const maxEntryLength = entryPoints.reduce((maxLength, entryPoint) => {
             return entryPoint.length > maxLength ? entryPoint.length : maxLength;
         }, 0);
@@ -26,11 +50,15 @@ function formatResults({ results, filePath, entryPoints, compactSummary }) {
     }
     else {
         results.forEach((entryPointResults, index) => {
-            entryPointResults.forEach((path) => {
-                formatted += join(path.reduce(pathToString, ''), '\n');
-            });
-            if (index < results.length - 1 && entryPointResults.length > 0) {
-                formatted += join('_'.repeat(process.stdout.columns));
+            if (entryPointResults.length > 0) {
+                formatted += join(colors.bold(entryPoints[index]), ':', '\n');
+                entryPointResults.forEach((path, resultsIndex) => {
+                    const isLast = resultsIndex === entryPointResults.length - 1;
+                    formatted += join(path.reduce(pathToString, ''), isLast ? '' : '\n');
+                });
+                if (index < results.length - 1 && entryPointResults.length > 0) {
+                    formatted += join('_'.repeat(process.stdout.columns)) + '\n';
+                }
             }
         });
     }

package/dist/cli/resolve/index.js

@@ -3,27 +3,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const find_1 = require("../../lib/find");
 const formatResults_1 = require("./formatResults");
 const utils_1 = require("../../lib/utils");
+const commonOptions_1 = require("../commonOptions");
 function createResolve(program) {
     program
         .command('resolve <filePath> [entryPoints...]')
-        .description('Checks if a filePath is required from entryPoint(s) and prints the resolution path')
+        .description('Checks if a filePath is required from entryPoint(s) and prints the resolution path', {
+        filePath: 'Path to a file that should be resolved in entry points',
+        'entryPoints...': 'List of entry points to look for file'
+    })
+        .option(...commonOptions_1.webpackConfigOption)
+        .option(...commonOptions_1.cwdOption)
+        .option(...commonOptions_1.reexportRewireOption)
+        .option(...commonOptions_1.includeOption)
+        .option(...commonOptions_1.excludeOption)
         .option('-cs, --compactSummary', 'print a compact summary of reverse resolution with a count of found paths')
-        .option('-wc, --webpackConfig <path>', 'path to webpack config to enable webpack aliases support')
-        .option('-pmd, --printMaxDepth', 'print max depth in the tree', false)
-        .option('-a, --all', 'finds all paths combination of a given dependency. Might work very slow and tend to crash for some projects', false)
+        .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, printMaxDepth, all } = data;
+        const { compactSummary, webpackConfig, all, cwd, exclude, include } = data;
         const sanitizedEntryPoints = (0, utils_1.sanitizeUserEntryPoints)(entryPoints);
-        const results = await (0, find_1.resolve)({
+        const [results, resolveEntryPoints] = await (0, find_1.resolve)({
             entryPoints: sanitizedEntryPoints,
             filePath,
             webpackConfig,
-            printMaxDepth,
-            all
+            all,
+            cwd: (0, utils_1.resolvePath)(cwd),
+            exclude,
+            include
         });
         const formatted = (0, formatResults_1.formatResults)({
             results,
-            entryPoints,
+            entryPoints: resolveEntryPoints,
             compactSummary,
             filePath
         });

package/dist/lib/cleanupDpdmDeps.js

@@ -1,10 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanupDpdmDeps = void 0;
+const is_builtin_module_1 = __importDefault(require("is-builtin-module"));
 const cleanupDpdmDeps = (deps) => {
     const newDeps = {};
     Object.entries(deps).forEach(([id, dependencies]) => {
-        if (!id.includes('node_modules') && dependencies !== null) {
+        if (!(0, is_builtin_module_1.default)(id) &&
+            !id.includes('node_modules') &&
+            dependencies !== null) {
             newDeps[id] = dependencies
                 .filter(({ id }) => id && !id.includes('node_modules'))
                 .map(({ id, request }) => ({

package/dist/lib/find.js

@@ -4,7 +4,6 @@ exports.resolve = void 0;
 const buildDepsGraph_1 = require("./buildDepsGraph");
 const getDepsTree_1 = require("./getDepsTree");
 const getEntryPoints_1 = require("./getEntryPoints");
-const getMaxDepthInGrapth_1 = require("./getMaxDepthInGrapth");
 const utils_1 = require("./utils");
 const resolvePathsToRoot = (node, all = false, resolvedPaths = [[]]) => {
     const newPaths = resolvedPaths.map((resolvedPath) => [
@@ -21,7 +20,7 @@ const resolvePathsToRoot = (node, all = false, resolvedPaths = [[]]) => {
     }
     return resolvePathsToRoot(node.parents[0], false, newPaths);
 };
-const resolve = async ({ entryPoints: _entryPoints, filePath, webpackConfig, cwd = process.cwd(), printMaxDepth, all }) => {
+const resolve = async ({ entryPoints: _entryPoints, filePath, webpackConfig, cwd = process.cwd(), all, include, exclude }) => {
     let deps, entryPoints;
     if (_entryPoints.length > 0) {
         entryPoints = _entryPoints;
@@ -29,16 +28,11 @@ const resolve = async ({ entryPoints: _entryPoints, filePath, webpackConfig, cwd
     }
     else {
         ;
-        [entryPoints, deps] = await (0, getEntryPoints_1.getEntryPoints)({ cwd });
+        [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));
-    if (printMaxDepth) {
-        forest.forEach(([tree]) => {
-            console.log('Max depth', ...(0, getMaxDepthInGrapth_1.getMaxDepth)()(tree));
-        });
-    }
     const resolvedPaths = forest.reduce((allPaths, [_, fileNode]) => {
         if (!fileNode) {
             return [...allPaths, []];
@@ -46,6 +40,6 @@ const resolve = async ({ entryPoints: _entryPoints, filePath, webpackConfig, cwd
         const pathsForTree = resolvePathsToRoot(fileNode, all);
         return [...allPaths, pathsForTree];
     }, []);
-    return resolvedPaths;
+    return [resolvedPaths, entryPoints];
 };
 exports.resolve = resolve;

package/dist/lib/getDepsTree.js

@@ -5,11 +5,19 @@ const getDepsSetWebpack_1 = require("./getDepsSetWebpack");
 const dpdm_1 = require("dpdm");
 const cleanupDpdmDeps_1 = require("./cleanupDpdmDeps");
 async function getDepsTree(cwd, entryPoints, webpackConfigPath) {
-    const deps = webpackConfigPath
-        ? (0, getDepsSetWebpack_1.getDepsSetWebpack)(entryPoints, webpackConfigPath, cwd)
-        : (0, cleanupDpdmDeps_1.cleanupDpdmDeps)(await (0, dpdm_1.parseDependencyTree)(entryPoints, {
+    let deps;
+    if (webpackConfigPath) {
+        deps = (0, getDepsSetWebpack_1.getDepsSetWebpack)(entryPoints, webpackConfigPath, cwd);
+    }
+    else {
+        // dpdm does not support custom search directory :/
+        const oldProcessCwd = process.cwd;
+        process.cwd = () => cwd;
+        deps = (0, cleanupDpdmDeps_1.cleanupDpdmDeps)(await (0, dpdm_1.parseDependencyTree)(entryPoints, {
             context: cwd
         }));
+        process.cwd = oldProcessCwd;
+    }
     return deps;
 }
 exports.getDepsTree = getDepsTree;

package/dist/lib/getEntryPoints.js

@@ -9,6 +9,7 @@ const path_1 = __importDefault(require("path"));
 const promises_1 = __importDefault(require("fs/promises"));
 const utils_1 = require("./utils");
 const getDepsTree_1 = require("./getDepsTree");
+const ignore_1 = __importDefault(require("ignore"));
 const getDirectoriesForEntryPointsSearch = async (dir) => {
     const entries = await promises_1.default.readdir(dir);
     const directories = await (0, utils_1.asyncFilter)(entries, async (pathName) => {
@@ -25,7 +26,7 @@ const getDirectoriesForEntryPointsSearch = async (dir) => {
     ];
 };
 exports.getDirectoriesForEntryPointsSearch = getDirectoriesForEntryPointsSearch;
-const findEntryPointsInDepsTree = (deps, exclude = []) => {
+const findEntryPointsInDepsTree = (deps, exclude = [], include = undefined) => {
     const referencedIds = new Set();
     Object.values(deps).forEach((entry) => {
         if (entry !== null) {
@@ -36,17 +37,35 @@ const findEntryPointsInDepsTree = (deps, exclude = []) => {
         .filter((id) => /\.(ts|tsx|mjs|js|jsx)$/.test(id) &&
         !/node_modules/.test(id) &&
         !referencedIds.has(id))
-        .filter((id) => exclude.reduce((result, pattern) => result && !(0, minimatch_1.default)(id, pattern), true));
+        .filter((id) => exclude.reduce((result, pattern) => result && !(0, minimatch_1.default)(id, pattern), true))
+        .filter((id) => include
+        ? include.reduce((result, pattern) => result || (0, minimatch_1.default)(id, pattern), false)
+        : true)
+        .sort();
 };
 exports.findEntryPointsInDepsTree = findEntryPointsInDepsTree;
-const getEntryPoints = async ({ cwd, exclude, webpackConfigPath }) => {
+const getEntryPoints = async ({ cwd, exclude, include, webpackConfigPath }) => {
     const dirs = await (0, exports.getDirectoriesForEntryPointsSearch)(cwd);
     const globs = dirs
         .map((dirName) => path_1.default.relative(cwd, dirName))
         .map((dirName) => `${dirName}/*`);
     const globsWithRoot = ['*', ...globs];
     const depsTree = await (0, getDepsTree_1.getDepsTree)(cwd, globsWithRoot, webpackConfigPath);
-    const possibleEntryPoints = (0, exports.findEntryPointsInDepsTree)(depsTree, exclude);
-    return [possibleEntryPoints, depsTree];
+    const possibleEntryPoints = (0, exports.findEntryPointsInDepsTree)(depsTree, exclude, include);
+    const ignoreInstance = (0, ignore_1.default)();
+    let gitignore = '';
+    try {
+        gitignore = (await promises_1.default.readFile(path_1.default.join(cwd, '.gitignore'))).toString();
+        const lines = gitignore.split('\n');
+        const nonCommentedNonEmptyLines = lines
+            .filter((line) => !/^(\s*)#/.test(line))
+            .filter((line) => !/^(\s*)$/.test(line));
+        gitignore = nonCommentedNonEmptyLines.join('\n');
+    }
+    catch (e) {
+        e;
+    }
+    ignoreInstance.add(gitignore);
+    return [ignoreInstance.filter(possibleEntryPoints), depsTree];
 };
 exports.getEntryPoints = getEntryPoints;

package/dist/lib/getMaxDepthInGraph.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMaxDepth = void 0;
+const getMaxDepth = (depth = 1, path = [], vertices = new Map()) => {
+    return (tree) => {
+        const depthFromCache = vertices.get(tree.path);
+        if (depthFromCache) {
+            return depthFromCache;
+        }
+        const newPath = [...path, tree.path];
+        if (tree.children.length === 0) {
+            return [depth, newPath];
+        }
+        const results = tree.children.map((0, exports.getMaxDepth)(depth + 1, newPath, vertices));
+        const maxChildDepth = Math.max(...results.map(([depth]) => depth));
+        const itemWithMaxDepth = results.find(([depth]) => depth === maxChildDepth);
+        vertices.set(tree.path, itemWithMaxDepth);
+        return itemWithMaxDepth;
+    };
+};
+exports.getMaxDepth = getMaxDepth;

package/dist/lib/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeUserEntryPoints = exports.asyncFilter = exports.createResolveAbsolutePath = exports.removeInitialDot = void 0;
+exports.resolvePath = exports.sanitizeUserEntryPoints = exports.asyncFilter = exports.createResolveAbsolutePath = exports.removeInitialDot = void 0;
 const path_1 = __importDefault(require("path"));
 const glob_escape_1 = __importDefault(require("glob-escape"));
 const removeInitialDot = (path) => path.replace(/^\.\//, '');
@@ -20,3 +20,10 @@ const sanitizeUserEntryPoints = (entryPoints) => {
     return globEscapedEntryPoints;
 };
 exports.sanitizeUserEntryPoints = sanitizeUserEntryPoints;
+const resolvePath = (p) => {
+    if (!p || path_1.default.isAbsolute(p)) {
+        return p;
+    }
+    return path_1.default.resolve(p);
+};
+exports.resolvePath = resolvePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rev-dep",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.1",
   "description": "Reverse dependency resolution tool built with dependency-cruiser",
   "main": "lib/find.js",
   "bin": "bin.js",
@@ -32,11 +32,14 @@
   },
   "dependencies": {
     "@types/dedent": "^0.7.0",
+    "colorette": "^2.0.16",
     "commander": "^6.1.0",
     "dedent": "^0.7.0",
     "dependency-cruiser": "9.23.0",
     "dpdm": "^3.8.0",
     "glob-escape": "^0.0.2",
+    "ignore": "^5.2.0",
+    "is-builtin-module": "^3.1.0",
     "minimatch": "^5.0.1"
   },
   "devDependencies": {