rev-dep 0.3.0 → 1.0.0-alpha.2

package/dist/lib/getEntryPoints.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntryPoints = exports.findEntryPointsInDepsTree = exports.getDirectoriesForEntryPointsSearch = void 0;
+const minimatch_1 = __importDefault(require("minimatch"));
+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) => {
+        if (pathName === 'node_modules' || pathName.startsWith('.')) {
+            return false;
+        }
+        const stat = await promises_1.default.lstat(path_1.default.resolve(dir, pathName));
+        return stat.isDirectory();
+    });
+    const joinedWithDir = directories.map((pathName) => path_1.default.join(dir, pathName));
+    return [
+        ...joinedWithDir,
+        ...(await Promise.all(joinedWithDir.map(exports.getDirectoriesForEntryPointsSearch))).flat(1)
+    ];
+};
+exports.getDirectoriesForEntryPointsSearch = getDirectoriesForEntryPointsSearch;
+const findEntryPointsInDepsTree = (deps, exclude = [], include = undefined) => {
+    const referencedIds = new Set();
+    Object.values(deps).forEach((entry) => {
+        if (entry !== null) {
+            entry.forEach(({ id }) => referencedIds.add(id));
+        }
+    });
+    return Object.keys(deps)
+        .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) => include
+        ? include.reduce((result, pattern) => result || (0, minimatch_1.default)(id, pattern), false)
+        : true)
+        .sort();
+};
+exports.findEntryPointsInDepsTree = findEntryPointsInDepsTree;
+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, 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/getMaxDepthInGrapth.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/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/utils.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findTsConfig = exports.resolvePath = exports.sanitizeUserEntryPoints = exports.asyncFilter = exports.createResolveAbsolutePath = exports.removeInitialDot = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const glob_escape_1 = __importDefault(require("glob-escape"));
+const removeInitialDot = (path) => path.replace(/^\.\//, '');
+exports.removeInitialDot = removeInitialDot;
+const createResolveAbsolutePath = (cwd) => (p) => (typeof p === 'string' ? path_1.default.resolve(cwd, p) : p);
+exports.createResolveAbsolutePath = createResolveAbsolutePath;
+const asyncFilter = async (arr, predicate) => {
+    const results = await Promise.all(arr.map(predicate));
+    return arr.filter((_v, index) => results[index]);
+};
+exports.asyncFilter = asyncFilter;
+const sanitizeUserEntryPoints = (entryPoints) => {
+    const globEscapedEntryPoints = entryPoints.map(glob_escape_1.default);
+    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;
+const findTsConfig = (cwd = process.cwd()) => {
+    try {
+        const tsconfig = path_1.default.join(cwd, 'tsconfig.json');
+        const stat = fs_1.default.statSync(tsconfig);
+        if (stat.isFile()) {
+            return tsconfig;
+        }
+    }
+    catch {
+        /**/
+    }
+    return undefined;
+};
+exports.findTsConfig = findTsConfig;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "rev-dep",
-  "version": "0.3.0",
+  "version": "1.0.0-alpha.2",
   "description": "Reverse dependency resolution tool built with dependency-cruiser",
-  "main": "find.js",
-  "bin": "cli.js",
+  "main": "lib/find.js",
+  "bin": "bin.js",
   "files": [
-    "find.js",
-    "cli.js",
-    "getDepsSet.js"
+    "dist/**",
+    "lib/**",
+    "bin.js",
+    "babel.js"
   ],
   "author": "Jakub Mazurek @jayu",
   "license": "MIT",
@@ -20,28 +21,43 @@
     "node": ">=10"
   },
   "scripts": {
-    "lint": "eslint *.js",
-    "lint:fix": "eslint --fix *.js",
-    "format": "prettier --check *.js",
-    "format:fix": "prettier --write *.js",
-    "cli": "node cli.js",
+    "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"
+    "release": "release-it",
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
+    "@babel/parser": "^7.17.8",
+    "@babel/template": "^7.16.7",
+    "@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"
+    "glob-escape": "^0.0.2",
+    "ignore": "^5.2.0",
+    "is-builtin-module": "^3.1.0",
+    "minimatch": "^5.0.1"
   },
   "devDependencies": {
+    "@babel/types": "^7.17.0",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
     "eslint": "^7.11.0",
-    "eslint-config-prettier": "^6.13.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-jest": "^24.1.0",
     "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "jest": "^26.5.3",
     "mock-fs": "^4.13.0",
     "prettier": "^2.1.2",
-    "release-it": "^14.2.1"
+    "release-it": "^14.2.1",
+    "typescript": "^4.6.2"
   }
 }

package/cli.js

@@ -1,69 +0,0 @@
-#!/usr/bin/env node
-
-const package = require('./package.json')
-const { Command } = require('commander')
-
-const { find } = require('./find')
-const program = new Command('rev-dep')
-program.version(package.version, '-v, --version')
-
-const pathToString = (str, f, i) => {
-  return `${str ? `${str}\n` : ''}${' '.repeat(i)} ➞ ${f}`
-}
-
-program
-  .command('resolve <filePath> <entryPoints...>')
-  .option(
-    '-cs, --compactSummary',
-    'print a compact summary of reverse resolution with a count of found paths'
-  )
-  .option('--verbose', 'print current action information')
-  .option(
-    '-wc, --webpackConfig <path>',
-    'path to webpack config to enable webpack aliases support'
-  )
-  .option(
-    '-tc, --typescriptConfig <path>',
-    'path to TypeScript config to enable TS aliases support'
-  )
-  .action(async (filePath, entryPoints, data) => {
-    const { compactSummary, verbose, webpackConfig, typescriptConfig } = data
-
-    const results = await find({
-      entryPoints,
-      filePath,
-      verbose,
-      webpackConfig,
-      typescriptConfig
-    })
-    const hasAnyResults = results.some((paths) => paths.length > 0)
-    if (!hasAnyResults) {
-      console.log('No results found for', filePath, 'in', entryPoints)
-      return
-    }
-    console.log('Results:\n')
-    if (compactSummary) {
-      const maxEntryLength = entryPoints.reduce((maxLength, entryPoint) => {
-        return entryPoint.length > maxLength ? entryPoint.length : maxLength
-      }, 0)
-      let total = 0
-      entryPoints.forEach((entry, index) => {
-        console.log(`${entry.padEnd(maxEntryLength)} :`, results[index].length)
-        total += results[index].length
-      })
-      console.log('\nTotal:', total)
-    } else {
-      results.forEach((entryPointResults, index) => {
-        entryPointResults.forEach((path) => {
-          console.log(path.reduce(pathToString, ''), '\n')
-        })
-        if (index < results.length - 1) {
-          console.log('_'.repeat(process.stdout.columns))
-        }
-      })
-    }
-
-
-  })
-
-program.parse(process.argv)

package/find.js

@@ -1,119 +0,0 @@
-const path = require('path')
-const getDepsSet = require('./getDepsSet')
-const { parseDependencyTree } = require('dpdm');
-const escapeGlob = require('glob-escape');
-
-const buildTree = (deps) => (entryPoint) => {
-  const inner = (path) => {
-    const dep = deps.find((d) => d.source === path)
-    if (dep === undefined) {
-      throw new Error(`Dependency '${path}' not found!`)
-    }
-
-    return {
-      path,
-      children: dep.dependencies.map((d) => {
-        if (d.circular) {
-          return { path: 'CIRCULAR', children: [] }
-        }
-        return inner(d.resolved)
-      })
-    }
-  }
-  return inner(entryPoint)
-}
-
-const buildTreeDpdm = (_deps) => (entryPoint) => {
-
-  const deps = Object.entries(_deps).reduce((deps, [id, data]) => {
-    if (!id.includes('node_modules')) {
-      return Object.assign({}, deps, { [id]: data ? data.filter(({ id }) => id && !id.includes('node_modules')) : data })
-    }
-    return deps
-  }, {})
-
-  const inner = (path, visited = new Set()) => {
-    if (visited.has(path)) {
-      return {
-        path,
-        children: []
-      }
-    }
-    visited.add(path);
-    const dep = deps[path]
-    if (dep === undefined) {
-      throw new Error(`Dependency '${path}' not found!`)
-    }
-
-    return {
-      path,
-      children: (dep || [])
-        .map(d => d.id)
-        .filter(path => path && !path.includes('node_modules'))
-        .map((path) => inner(path, visited))
-    }
-  }
-  return inner(entryPoint)
-}
-
-const traverse = (file) => (tree) => {
-  if (tree.path === file) {
-    return [[file]]
-  } else {
-    return tree.children
-      .map(traverse(file)) // [ [[]],[[]],[[]] ]
-      .filter((p) => p.length > 0)
-      .map((pathsArr) => pathsArr.filter((p) => p.length > 0))
-      .reduce((flat, subPath) => {
-        return [...flat, ...subPath]
-      }, [])
-      .map((p) => [tree.path, ...p])
-  }
-}
-
-const removeInitialDot = (path) => path.replace(/^\.\//, '')
-
-const _resolveAbsolutePath = (cwd) => (p) => typeof p === 'string' ? path.resolve(cwd, p) : p
-
-const find = async ({
-  entryPoints,
-  filePath,
-  skipRegex,
-  verbose,
-  webpackConfig,
-  typescriptConfig,
-  cwd = process.cwd()
-}) => {
-  const resolveAbsolutePath = _resolveAbsolutePath(cwd)
-  const absoluteEntryPoints = entryPoints.map(resolveAbsolutePath)
-  const globEscapedEntryPoints = entryPoints.map(escapeGlob);
-
-  if (verbose) {
-    console.log('Entry points:')
-    console.log(absoluteEntryPoints)
-    console.log('Getting dependency set for entry points...')
-  }
-  const deps = typescriptConfig ? await parseDependencyTree(globEscapedEntryPoints, { context: process.cwd() }) : getDepsSet(
-    absoluteEntryPoints,
-    skipRegex,
-    resolveAbsolutePath(webpackConfig),
-    resolveAbsolutePath(typescriptConfig)
-  )
-
-  const cleanedEntryPoints = entryPoints.map(removeInitialDot)
-  const cleanedFilePath = removeInitialDot(filePath)
-  if (verbose) {
-    console.log('Building dependency trees for entry points...')
-  }
-  const forest = cleanedEntryPoints.map(typescriptConfig ? buildTreeDpdm(deps) : buildTree(deps))
-  if (verbose) {
-    console.log('Finding paths in dependency trees...')
-  }
-  const resolvedPaths = forest.reduce((allPaths, tree) => {
-    const paths = traverse(cleanedFilePath)(tree)
-    return [...allPaths, paths]
-  }, [])
-  return resolvedPaths
-}
-
-module.exports = { find }

package/getDepsSet.js

@@ -1,21 +0,0 @@
-const depcruise = require('dependency-cruiser').cruise
-// eslint-disable-next-line
-const resolveWebpackConfig = require('dependency-cruiser/config-utl/extract-webpack-resolve-config')
-// eslint-disable-next-line
-const resolveTsConfig = require('dependency-cruiser/config-utl/extract-ts-config')
-const getDepsSet = (entryPoints, skipRegex, webpackConfigPath, tsConfigPath) => {
-  const skip =
-    skipRegex || '(node_modules|/__tests__|/__test__|/__mockContent__|.scss)'
-  const webpackResolveOptions = webpackConfigPath ? resolveWebpackConfig(webpackConfigPath) : null
-  const tsConfigOptions = tsConfigPath ? resolveTsConfig(tsConfigPath) : null
-
-  const result = depcruise(entryPoints, {
-    exclude: skip,
-    doNotFollow: { path: skip },
-    tsPreCompilationDeps: true,
-
-  }, webpackResolveOptions, tsConfigOptions)
-  return result.output.modules
-}
-
-module.exports = getDepsSet