npmpackage.info

resolve-package-path

a special purpose fast memoizing way to resolve a node modules package.json

4.0.3

MIT

TypeScript

Installations

npm install resolve-package-path

Pull Requests

Open

4

Total

46

Closed

5

Merged

37

Issues

Open

3

Total

16

Closed

13

Releases

Unable to fetch releases

Developer

stefanpenner

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 12

Typescript Support

Yes

Node Version

12.19.0

NPM Version

6.14.8 Statistics

30 Stars

159 Commits

10 Forks

5 Watching

7 Branches

9 Contributors

Updated on 27 Oct 2024

Languages

TypeScript (97.71%)

JavaScript (2.29%)

Total Downloads

Cumulative downloads

Total Downloads

171,305,371

Last day

-19.1%

213,146

Compared to previous day

Last week

-8.6%

1,116,701

Compared to previous week

Last month

17.7%

5,050,081

Compared to previous month

Last year

68.4%

63,626,223

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

resolve-package-path

This project is special-purpose, made to resolve package.json files for:

a given module name and basedir or
a given basedir

It cannot and does not resolve anything else.

To achieve its file-resolution performance, it does two specific things:

It memoizes results identically to node's require. Specifically, for a given moduleName and baseDir it will, for the duration of the process, always return the exact same response.
It re-implements the parts of require.resolve needed to resolve package.json files ONLY. This removes unneeded I/O. (based on @davecombs approach)

Usage

1yarn add resolve-package-path

1const resolvePackagePath = require('resolve-package-path');
2
3resolvePackagePath('rsvp', 'base-dir/to/start/the/node_resolution-algorithm-from') // => /path/to/rsvp.json or null
4
5const { findUpPackagePath } = resolvePackagePath;
6findUpPackagePath('base-dir/to/start') // => path/to/package.json or null

Advanced usage

Preserve Symlinks

Node supports --preserve-symlinks and NODE_PRESERVE_SYMLINKS=1 for compatibility this library respects these.

Disable default caching

Although by default resolve-package-path caches or memoizes results, this feature can be disabled:

1const resolvePackagePath = require('resolve-package-path');
2
3resolvePackagePath('rsvp', 'base-dir/to/start/the/node_resolution-algorithm-from', false) // => uncached result /path/to/rsvp.json or null
4
5const { findUpPackagePath } = resolvePackagePath;
6findUpPackagePath('base-dir/to/start', false) // => path/to/package.json or null

Purge the cache

1const resolvePackagePath = require('resolve-package-path');
2resolvePackagePath._resetCache();

Provide an alternative cache

In some advanced circumtances, you may want to gain access to the cache to share between more systems. In that case, a cache instance of the following form can be provided as a third argument:

1cache = {
2  RESOLVED_PACKAGE_PATH: new Map(),
3  REAL_FILE_PATH: new Map(),
4  REAL_DIRECTORY_PATH: new Map(),
5};
6findUpCache = new Map();
7
8const resolvePackagePath = require('resolve-package-path');
9resolvePackagePath('rsvp', 'path/to/start/from', cache);
10
11const { findUpPackagePath } = resolvePackagePath;
12findUpPackagePath('base-dir/to/start', findUpCache) // => path/to/package.json or null

Use internal helper functions

For consumers who also do getRealFilePath or getRealDirectoryPath calls on relevant paths, we expose them as utilities. These utilties ensure identical functionality to resolve-package-path, and a shared cache, which may help reduce IO.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to resolve-package-path

@rigor789/resolve-package-path

1.0.7

[![CI](https://github.com/rigor789/resolve-package-path/actions/workflows/ci.yml/badge.svg)](https://github.com/rigor789/resolve-package-path/actions/workflows/ci.yml)

resolve-from

5.0.0

Resolve the path of a module like `require.resolve()` but from a given path

enhanced-resolve

5.17.1

Offers a async require.resolve function. It's highly configurable.

resolve-dir

1.0.1

Resolve a directory that is either local, global or in the user's home directory.

resolve-package-path

Installations

Pull Requests

4

46

5

37

Issues

3

16

13

Releases

Unable to fetch releases

Developer

stefanpenner

Developer Guide

CommonJS

>= 12

Yes

12.19.0

6.14.8

Statistics

Languages

Total Downloads

171,305,371

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

resolve-package-path

Usage

Advanced usage

Preserve Symlinks

Disable default caching

Purge the cache

Provide an alternative cache

Use internal helper functions

10

10

10

1

0

0

0

0

0

0

0

0

0

2.6

/10

Other packages similar to resolve-package-path