added: search-dir to config

README.md

@@ -58,6 +58,7 @@ Pure Index supports three ways to define config.
   "entry": "index.ts",
   "exclude": ["node_modules"],
   "extensions": ["ts", "tsx"],
+  "searchDir": "my-path",
   "babelPlugins": ["typescript"],
   "batch": 100
 }
@@ -70,6 +71,7 @@ Pure Index supports three ways to define config.
     "entry": "index.ts",
     "exclude": ["node_modules"],
     "extensions": ["ts", "tsx"],
+    "searchDir": "my-path",
     "babelPlugins": ["typescript"],
     "batch": 100
   }
@@ -82,6 +84,7 @@ module.exports = {
   entry: 'index.ts',
   exclude: ['node_modules'],
   extensions: ['ts', 'tsx'],
+  searchDir: 'my-path',
   babelPlugins: ['typescript'],
   batch: 100
 }
@@ -92,6 +95,7 @@ module.exports = {
 - `entry (String)` — path to the package index file. relative to the package directory.
 - `extensions (Array<string>)` — list of file extensions to be considered during the search.
 - `exclude (Array<string>)` — list of directories that will be excluded when searching for imports.
+- `searchDir (string)` — path to the directory where imports should be searched for.
 - `babelPlugins (Array<string>)` — list of babel plugins that will be used when parsing files.
 - `batch (Number)` — number of files to be traversed in parallel. Changing the value may speed up or slow down the script. Choose the value yourself.
 
@@ -132,6 +136,17 @@ Allows to override the config values for package.
     }
 ```
 
+### `--search-dir, -s`
+
+```diff
+    "scripts": {
+      "build": "webpack ./webpack.config.js",
+-     "check-exports": "pure-index",
++     "check-exports": "pure-index --search-dir /Users/user/another-repo",
+      "test": "vitest"
+    }
+```
+
 ### `--babel-plugins, -p`
 
 ```diff

bin/__tests__/getConfig/cli.test.js

@@ -12,7 +12,8 @@ test('default value', async () => {
         collectUsages: 'package-a',
         batch: 1,
         babelPlugins: 'decorators-legacy,classPrivateProperties',
-        exclude: 'biba,boba,.cache,www/assets,__tests__'
+        exclude: 'biba,boba,.cache,www/assets,__tests__',
+        searchDir: 'dir-from-cli'
       }
     }))
   }))
@@ -33,7 +34,8 @@ test('default value', async () => {
       '.cache',
       'www/assets',
       '__tests__'
-    ])
+    ]),
+    searchDir: 'dir-from-cli'
   })
 
   vi.resetAllMocks()

bin/__tests__/getConfig/config+cli.js

@@ -12,7 +12,8 @@ test('default value', async () => {
           batch: 500,
           entry: 'src/index.ts',
           exclude: ['build'],
-          extensions: ['js', 'jsx']
+          extensions: ['js', 'jsx'],
+          searchDir: 'dir-from-cli'
         }
       })
     })
@@ -26,7 +27,8 @@ test('default value', async () => {
         collectUsages: 'package-a',
         batch: 1,
         babelPlugins: 'decorators-legacy,classPrivateProperties',
-        exclude: 'biba,boba,.cache,www/assets,__tests__'
+        exclude: 'biba,boba,.cache,www/assets,__tests__',
+        searchDir: 'dir-from-config'
       }
     }))
   }))
@@ -47,7 +49,8 @@ test('default value', async () => {
       '.cache',
       'www/assets',
       '__tests__'
-    ])
+    ]),
+    searchDir: 'dir-from-cli'
   })
 
   vi.resetAllMocks()

bin/__tests__/getConfig/constants.js

@@ -4,5 +4,6 @@ export const CONFIG = {
   collectUsages: null,
   entry: 'index.ts',
   exclude: new Set(['node_modules']),
-  extensions: ['ts', 'tsx']
+  extensions: ['ts', 'tsx'],
+  searchDir: 'repo-root'
 }

bin/__tests__/getConfig/index.test.js

@@ -1,9 +1,13 @@
-import { expect, test } from 'vitest'
+import { expect, test, mock, vi } from 'vitest'
 
 import { getConfig } from '../../getConfig.js'
 import { CONFIG } from './constants.js'
 
 test('default value', async () => {
+  vi.mock('../../../bin/utils/getRepoRoot.js', () => ({
+    getRepoRoot: () => 'repo-root'
+  }))
+
   const config = await getConfig()
 
   expect(config).toStrictEqual(CONFIG)

bin/__tests__/getConfig/withconfig.test.js

@@ -12,7 +12,8 @@ test('default value', async () => {
           batch: 500,
           entry: 'src/index.ts',
           exclude: ['build'],
-          extensions: ['js', 'jsx']
+          extensions: ['js', 'jsx'],
+          searchDir: 'dir-from-config'
         }
       })
     })
@@ -26,7 +27,8 @@ test('default value', async () => {
     batch: 500,
     entry: 'src/index.ts',
     extensions: ['js', 'jsx'],
-    exclude: new Set([...CONFIG.exclude, 'build'])
+    exclude: new Set([...CONFIG.exclude, 'build']),
+    searchDir: 'dir-from-config'
   })
 
   vi.resetAllMocks()

bin/collectUsages.js

@@ -9,6 +9,7 @@ import { createStatusAPI } from './utils/index.js'
  *      collectUsages: string
  *      exclude: Set<string>
  *      extensions: Array<string>
+ *      searchDir: string
  *   },
  * }}
  *

bin/fileTraversal/getFiles.js

@@ -1,10 +1,6 @@
-import { execSync } from 'node:child_process'
 import { join } from 'node:path'
 import { fdir } from 'fdir'
 
-const getRepoRoot = () =>
-  execSync('git rev-parse --show-toplevel', { encoding: 'utf8' }).trim()
-
 const formattedExtensions = list =>
   list.reduce((acc, ext) => acc + (acc ? ',' : '') + ext, '')
 
@@ -13,6 +9,7 @@ const formattedExtensions = list =>
  *   config: {
  *      exclude: Set<string>
  *      extensions: Array<string>
+ *      searchDir: string
  *   }
  *   pkg: {
  *      name: string
@@ -33,18 +30,13 @@ const getFiles = async ({ config, pkg }) => {
     )
     .join('|')
   const excludeRegExp = new RegExp(exclude)
-  const repoRoot = getRepoRoot()
-  const source = join(
-    repoRoot,
-    '**',
-    `*.{${formattedExtensions(config.extensions)}}`
-  )
+  const source = join('**', `*.{${formattedExtensions(config.extensions)}}`)
 
   const files = new fdir()
     .exclude(dirName => excludeRegExp.test(dirName))
     .globWithOptions([source], { dot: false })
     .withFullPaths()
-    .crawl(repoRoot)
+    .crawl(config.searchDir)
     .sync()
 
   return files

bin/fileTraversal/index.js

@@ -9,6 +9,7 @@ import { getFiles } from './getFiles.js'
  *      batch: number
  *      exclude: Set<string>
  *      extensions: Array<string>
+ *      searchDir: string
  *   }
  *   pkg: {
  *      name: string

bin/getConfig.js

@@ -2,11 +2,14 @@ import { join } from 'node:path'
 import { lilconfig } from 'lilconfig'
 import meow from 'meow'
 
+import { getRepoRoot } from './utils/index.js'
+
 const BASE_CONFIG = {
   babelPlugins: ['typescript'],
   batch: 100,
   collectUsages: null,
   entry: 'index.ts',
+  searchDir: null,
   exclude: new Set(['node_modules']),
   extensions: ['ts', 'tsx']
 }
@@ -17,6 +20,7 @@ const cli = meow(
 	  --entry, -e  path to the package index file. relative to the package directory
     --exclude, -i list of directories that will be excluded when searching for imports
     --extensions, -x  list of file extensions to be considered during the search
+    --search-dir, -s  path to the directory where imports should be searched for
     --babel-plugins, -p  list of babel plugins that will be used when parsing files
     --batch, -b  number of files to be traversed in parallel
     --collect-usages, -u  outputs a list of all unique uses of the package
@@ -29,6 +33,7 @@ const cli = meow(
       entry: { type: 'string', shortFlag: 'e' },
       exclude: { type: 'string', shortFlag: 'i' },
       extensions: { type: 'string', shortFlag: 'x' },
+      searchDir: { type: 'string', shortFlag: 's' },
       babelPlugins: { type: 'string', shortFlag: 'p' },
       batch: { type: 'number', shortFlag: 'b' },
       collectUsages: { type: 'string', shortFlag: 'u' }
@@ -51,7 +56,8 @@ const getConfig = async () => {
     babelPlugins = BASE_CONFIG.babelPlugins,
     entry = BASE_CONFIG.entry,
     batch = BASE_CONFIG.batch,
-    extensions = BASE_CONFIG.extensions
+    extensions = BASE_CONFIG.extensions,
+    searchDir
   } = result.config
 
   return result === null
@@ -68,7 +74,8 @@ const getConfig = async () => {
         collectUsages: cli.flags.collectUsages || BASE_CONFIG.collectUsages,
         extensions: cli.flags.extensions
           ? cli.flags.extensions.split(',')
-          : extensions
+          : extensions,
+        searchDir: cli.flags.searchDir || searchDir || getRepoRoot()
       }
 }
 

bin/main.js

@@ -10,6 +10,7 @@ import { createStatusAPI, readJSON } from './utils/index.js'
  *      entry: string
  *      exclude: Set<string>
  *      extensions: Array<string>
+ *      searchDir: string
  *   },
  * }}
  *

bin/utils/getRepoRoot.js

@@ -0,0 +1,4 @@
+import { execSync } from 'node:child_process'
+
+export const getRepoRoot = () =>
+  execSync('git rev-parse --show-toplevel', { encoding: 'utf8' }).trim()

bin/utils/index.js

@@ -44,4 +44,5 @@ const createStatusAPI = ({ title }) => {
 }
 
 export { readFile, readJSON, createStatusAPI }
+export { getRepoRoot } from './getRepoRoot.js'
 export { ObservableSet } from './observableSet.js'

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pure-index",
   "type": "module",
-  "version": "0.0.29",
+  "version": "0.0.32",
   "description": "Utility for monorepos. It helps to find unused exports from packages or get a list of all unique uses of any package",
   "main": "./bin/index.js",
   "bin": "./bin/index.js",