rev-dep 0.1.1 → 0.3.0

package/README.md

@@ -46,7 +46,7 @@ Results:
    ➞ getDepsSet.js
 ```
 
-What says that `getDepsSet.js` file is used in `cli.js` entry point and is required through `find.js`
+Which says that `getDepsSet.js` file is used in `cli.js` entry point and is required through `find.js`
 
 ## About
 
@@ -54,7 +54,7 @@ The tool was created to determine places in the project where a particular file
 
 It's especially useful in JS world without TypeScript or tests coverage.
 
-Except the reverse dependency resolution path, it can print statistics about how many times a particular module is required in the project, which might be helpful for planning code-splitting.
+Except the reverse dependency resolution path, it can print statistics about how many times a particular module is required in the project, which might be helpful for code-splitting planning.
 
 ## Usage
 
@@ -67,13 +67,14 @@ Avaliable commands:
 #### `resolve`
 
 ```sh
-rev-dep resolve <file> <entryPoints...>
+rev-dep resolve <filePath> <entryPoints...>
 ```
 
 Available options are
 
 - `-cs or --compactSummary` - instead of file paths print a compact summary of reverse resolution with a count of found paths
 - `--verbose` - log currently performed operation
+- `-wc, --webpackConfig <path>` - path to webpack config to enable webpack aliases support
 
 ### Module
 
@@ -84,7 +85,7 @@ import { find } from 'rev-dep'
 
 const path = find({
   entryPoints: ['index.js'],
-  file: 'utils.js'
+  filePath: 'utils.js'
 })
 
 console.log(path)
@@ -93,10 +94,22 @@ console.log(path)
 #### `find` Options
 
 - `entryPoints (Array)` - Array of entry points to build a tree for search. Usually it will be one entry point, but project can have many of them, eg. next.js application. **Required**
-- `file (String)` - A file that we want to find path for. **Required**
+- `filePath (String)` - A file that we want to find path for. **Required**
 - `skipRegex (String | RegExp)` - If a file path matches the pattern, we stop to traverse it's dependencies and do not include that file in the search tree. _Optional_, default: `'(node_modules|/__tests__|/__test__|/__mockContent__|.scss)'`
 - `verbose (Boolean)` - when set to true, will print current operation performed by find function. _Optional_, default: `false`
 - `cwd` - root for resolved files, must be an absolute path. _Optional_, default: `process.cwd()`
+- `webpackConfig (String)` - path to webpack config to enable webpack aliases support
+
+### Additional setup may be required
+
+#### Resolving implicit file extensions
+
+A vast amount of JS/TS projects are configured in a way that allows (or even forces) to skip file extensions in import statements. Rev-dep is strongly based on [dependency-cruiser](https://github.com/sverweij/dependency-cruiser) which by default support implicit file extensions for `*.js, *.cjs, *.mjs, *.jsx` files (check [source](https://github.com/sverweij/dependency-cruiser/blob/96e34d0cf158034f2b7c8cafe9cec72dd74d8c45/src/extract/transpile/meta.js)).
+In order to resolve implicit extensions for other JS based languages it look for available corresponding compiler in `package.json`. If compiler is available, then extension is supported.
+
+If you installed `rev-dep` **globally**, you will have appropriate compiler installed **globally** as well. If you use it as a module, your project has to have compiler in it's package.json.
+
+For example, to support `*.ts` and `*.tsx` implicit extensions in globally installed `rev-dep`, you have to also install globally `typescript` package (see [source](https://github.com/sverweij/dependency-cruiser/blob/96e34d0cf158034f2b7c8cafe9cec72dd74d8c45/src/extract/transpile/typescript-wrap.js))
 
 ## Contributing
 

package/cli.js

@@ -12,19 +12,35 @@ const pathToString = (str, f, i) => {
 }
 
 program
-  .command('resolve <file> <entryPoints...>')
+  .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')
-  .action((filePath, entryPoints, data) => {
-    const { compactSummary, verbose } = data
-    const results = find({
-      entryPoints: entryPoints,
-      file: filePath,
-      verbose
+  .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) => {
@@ -39,13 +55,15 @@ program
     } else {
       results.forEach((entryPointResults, index) => {
         entryPointResults.forEach((path) => {
-          console.log(path.reduce(pathToString, ''))
+          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,5 +1,7 @@
 const path = require('path')
 const getDepsSet = require('./getDepsSet')
+const { parseDependencyTree } = require('dpdm');
+const escapeGlob = require('glob-escape');
 
 const buildTree = (deps) => (entryPoint) => {
   const inner = (path) => {
@@ -21,6 +23,39 @@ const buildTree = (deps) => (entryPoint) => {
   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]]
@@ -38,35 +73,44 @@ const traverse = (file) => (tree) => {
 
 const removeInitialDot = (path) => path.replace(/^\.\//, '')
 
-const resolveAbsolutePath = (cwd) => (p) => path.resolve(cwd, p)
+const _resolveAbsolutePath = (cwd) => (p) => typeof p === 'string' ? path.resolve(cwd, p) : p
 
-const find = ({
+const find = async ({
   entryPoints,
-  file,
+  filePath,
   skipRegex,
   verbose,
+  webpackConfig,
+  typescriptConfig,
   cwd = process.cwd()
 }) => {
-  const absoluteEntryPoints = entryPoints.map((e) =>
-    resolveAbsolutePath(cwd)(e)
-  )
+  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 = getDepsSet(absoluteEntryPoints, skipRegex)
+  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(buildTree(deps))
+  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(file)(tree)
+    const paths = traverse(cleanedFilePath)(tree)
     return [...allPaths, paths]
   }, [])
   return resolvedPaths

package/getDepsSet.js

@@ -1,17 +1,21 @@
 const depcruise = require('dependency-cruiser').cruise
-
-const getDepsSet = (entryPoints, skipRegex) => {
+// 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 dependencies = depcruise(entryPoints, {
+  const result = depcruise(entryPoints, {
     exclude: skip,
     doNotFollow: { path: skip },
-    tsConfig: {
-      fileName: 'tsconfig.json'
-    }
-  }).output
-  return dependencies.modules
+    tsPreCompilationDeps: true,
+
+  }, webpackResolveOptions, tsConfigOptions)
+  return result.output.modules
 }
 
 module.exports = getDepsSet

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rev-dep",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Reverse dependency resolution tool built with dependency-cruiser",
   "main": "find.js",
   "bin": "cli.js",
@@ -30,7 +30,9 @@
   },
   "dependencies": {
     "commander": "^6.1.0",
-    "dependency-cruiser": "^9.15.0"
+    "dependency-cruiser": "9.23.0",
+    "dpdm": "^3.8.0",
+    "glob-escape": "^0.0.2"
   },
   "devDependencies": {
     "eslint": "^7.11.0",