@custom-elements-manifest/find-dependencies
v0.0.5
Published
Given an array of paths, scans all modules and returns all depending paths.
Downloads
112,918
Readme
find-dependencies
Given an array of paths, scans all modules and returns all depending paths.
Intended to be used on post-build, frontend facing, ESM based code.
Usage
import { findDependencies } from '@custom-elements-manifest/find-dependencies';
const inputPaths = ['my-package/index.js'];
const dependencies = await findDependencies(inputPaths);
Where my-package/index.js
contains:
import '@scoped/package';
import {b} from '@scoped/package/baz/index.js';
import c from 'export-map';
import d from 'nested';
import e from 'regular';
import g from './bla.js';
import('dynamic-import');
Will output:
[
'/Users/blank/my-package/node_modules/@scoped/package/index.js',
'/Users/blank/my-package/node_modules/@scoped/package/baz/index.js',
'/Users/blank/my-package/node_modules/export-map/long/path/index.js',
'/Users/blank/my-package/node_modules/nested/index.js',
'/Users/blank/my-package/node_modules/regular/index.js',
'/Users/blank/my-package/node_modules/dynamic-import/index.js',
'/Users/blank/my-package/node_modules/nested/node_modules/regular/index.js'
]
Configuration
interface Options {
/**
* In case `node_modules` is higher up in the file tree, for example in a monorepo
* Defaults to 3
*/
nodeModulesDepth?: number,
/** Defaults to `process.cwd()` */
basePath?: string
}
findDependencies(inputPaths, {
basePath: 'foo/bar',
nodeModulesDepth: 5,
});
Utils
import {
splitPath,
getUniquePackages,
extractPackageNameFromSpecifier,
isBareModuleSpecifier,
isScopedPackage
} from '@custom-elements-manifest/find-dependencies';
splitPath
splitPath('/blank/node_modules/foo/index.js');
// {packageRoot: '/blank/node_modules/foo', packageName: 'foo', specifier: 'foo/index.js', type: 'js' }
splitPath('/blank/node_modules/foo/data.json');
// {packageRoot: '/blank/node_modules/foo', packageName: 'foo', specifier: 'foo/data.json', type: 'json' }
extractPackageNameFromSpecifier
extractPackageNameFromSpecifier('foo/index.js') // foo
extractPackageNameFromSpecifier('foo/bar/baz/index.js') // foo
extractPackageNameFromSpecifier('@foo/bar/index.js') // @foo/bar
extractPackageNameFromSpecifier('@foo/bar/baz/asdgf/index.js') // @foo/bar
isBareModuleSpecifier
isBareModuleSpecifier('foo') // true
isBareModuleSpecifier('foo/bar.js') // true
isBareModuleSpecifier('./foo.js') // false
isBareModuleSpecifier('../foo.js') // false
isScopedPackage
isScopedPackage('foo') // false
isScopedPackage('@foo/bar') // true
getUniquePackages
getUniquePackages([
'blank/node_modules/foo/index.js',
'blank/node_modules/bar/index.js',
'blank/node_modules/bar/index2.js'
'blank/node_modules/bar/index3.js'
])
// ['foo', 'bar',]
/** Or */
const dependencies = await findDependencies(inputPaths);
const unique = getUniquePackages(dependencies);