npmpackage.info

Gathering detailed insights and metrics for @vercel/webpack-asset-relocator-loader

Other packages similar to @vercel/webpack-asset-relocator-loader

@timfish/webpack-asset-relocator-loader

0.1.0

This loader wraps `@vercel/webpack-asset-relocator-loader@1.4.1` and modifies loading paths so that they are compatible with [**Electron Forge**](https://www.electronforge.io/config/plugins/webpack).

@vercel/webpack-asset-relocator-loader

Used in ncc while emitting and relocating any asset references

1.7.4

101

MIT

JavaScript

136.67 kB

40,315,507 4.1

Installations

npm install @vercel/webpack-asset-relocator-loader

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.20.2

NPM Version

6.14.9 Score

95.1

Supply Chain

99.6

Quality

83.5

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

2

Total

153

Closed

14

Merged

137

Issues

Open

17

Total

40

Closed

23

Releases

v1.7.4

Published on 16 May 2024

v1.7.3

Published on 13 Jul 2022

v1.7.2

Published on 22 Mar 2022

v1.7.1

Published on 22 Mar 2022

v1.7.0

Published on 19 Aug 2021

v1.6.0

Published on 06 Jul 2021

View all 31 releases

Contributors

Unable to fetch Contributors

View all 82 contributors

Languages

JavaScript

JavaScript (100%)

Developer

vercel

Download Statistics

Total Downloads

40,315,507

Last Day

19,946

Last Week

127,828

Last Month

852,438

Last Year

12,546,049

GitHub Statistics

101 Stars

316 Commits

33 Forks

52 Watching

7 Branches

82 Contributors

Bundle Size

476.31 kB

Minified

136.67 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.7.4

Package Id

@vercel/webpack-asset-relocator-loader@1.7.4

Unpacked Size

0.96 MB

Size

235.18 kB

File Count

NPM Version

6.14.9

Node Version

18.20.2

Publised On

16 May 2024

Total Downloads

Cumulative downloads

Total Downloads

40,315,507

Last day

3.2%

19,946

Compared to previous day

Last week

-30.7%

127,828

Compared to previous week

Last month

-12.7%

852,438

Compared to previous month

Last year

-7.8%

12,546,049

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Asset Relocator Loader for Webpack

Asset relocation loader used in ncc for performing Node.js builds while emitting and relocating any asset references.

Usage

Installation

1npm i -g @vercel/webpack-asset-relocator-loader

Usage

Add this loader as a Webpack plugin for any JS files.

Any .node files included will also support binary relocation.

1{
2  target: "node",
3  output: {
4    libraryTarget: "commonjs2"
5  },
6  module: {
7    rules: [
8      {
9        // For node binary relocations, include ".node" files as well here
10        test: /\.(m?js|node)$/,
11        // it is recommended for Node builds to turn off AMD support
12        parser: { amd: false },
13        use: {
14          loader: '@vercel/webpack-asset-relocator-loader',
15          options: {
16            // optional, base folder for asset emission (eg assets/name.ext)
17            outputAssetBase: 'assets',
18            // optional, restrict asset emissions to only the given folder.
19            filterAssetBase: process.cwd(),
20            // optional, permit entire __dirname emission
21            // eg `const nonAnalyzable = __dirname` can emit everything in the folder
22            emitDirnameAll: false,
23            // optional, permit entire filterAssetBase emission
24            // eg `const nonAnalyzable = process.cwd()` can emit everything in the cwd()
25            emitFilterAssetBaseAll: false,
26            // optional, custom functional asset emitter
27            // takes an asset path and returns the replacement
28            // or returns false to skip emission
29            customEmit: (path, { id, isRequire }) => false | '"./custom-replacement"',
30            // optional, a list of asset names already emitted or
31            // defined that should not be emitted
32            existingAssetNames: [],
33            wrapperCompatibility: false, // optional, default
34            // build for process.env.NODE_ENV = 'production'
35            production: true, // optional, default is undefined
36            cwd: process.cwd(), // optional, default
37            debugLog: false, // optional, default
38          }
39        }
40      }
41    ]
42  }
43}

Assets will be emitted using emitAsset, with their references updated in the code by the loader to the new output location.

Asset Permissions and Symlinks

Asset symlinks and permissions are maintained in the loader, but aren't passed to Webpack as emit doesn't support these.

This information can be obtained from the loader through the API calls getAssetMeta() and getSymlinks():

1const relocateLoader = require('webpack-asset-relocator-loader');
2
3webpack({...}).run((err, stats) => {
4  const assetMeta = relocateLoader.getAssetMeta();
5  const symlinks = relocateLoader.getSymlinks();
6});

They will always contain the most recent build state.

Caching

When using Webpack 5 caching, asset permissions need to be maintained through their own cache, and the public path needs to be injected into the build.

To ensure these cases work out, make sure to run initAssetCache in the build, with the options.outputAssetBase argument:

1const relocateLoader = require('webpack-asset-relocator-loader');
2
3webpack({
4  // ...
5
6  plugins: [
7    {
8      apply(compiler) {
9        compiler.hooks.compilation.tap("webpack-asset-relocator-loader", compilation => {
10          relocateLoader.initAssetCache(compilation, outputAssetBase);
11        });
12      }
13    }
14  ]
15});

How it Works

Asset Relocation

Assets are detected using static analysis of code, based on very specific triggers designed for common Node.js workflows to provide build support for a very high (but not perfect) level of compatibility with existing Node.js libraries.

process.cwd(), __filename, __dirname, path.*(), require.resolve are all statically analyzed when possible.
File emissions for exact asset paths
Whole directory asset emissions for exact directory paths
Wildcard asset emissions for variable path expressions

When an asset is emitted, the pure expression referencing the asset path is replaced with a new expression to the relocated asset and the asset emitted. In the case of wildcard emission, the dynamic parts of the expression are maintained.

Binary Relocation

Node binary loading conventions cover the following triggers for binary relocations:

require('bindings')(...)
nbind.init(..)
node-pre-gyp include patterns

Any shared libraries loaded by these binaries will also be emitted as well.

Node.js Compatibility Features

In addition to asset relocation, this loader also provides a couple of compatibility features for Webpack Node.js builds as part of its analysis.

These include:

require.main === module checks are retained for the entry point being built.
options.wrapperCompatibility: Automatically handles common AMD / Browserify wrappers to ensure they are properly built by Webpack. See the utils/wrappers.js file for the exact transformations currently provided.
require.resolve support in the target environment, while also supporting emission in the build environment.
Dynamic require statements are analyzed to exact paths wherever possible, and when not possible to analyze, turned into dynamic requires in the target environment.

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.

10

Security-Policy

Determines if the project has published a security policy.

6

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

CII-Best-Practices

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

0

Pinned-Dependencies

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

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.1

/10

Last Scanned on 2025-01-06

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 @vercel/webpack-asset-relocator-loader

@vercel/webpack-asset-relocator-loader

Installations

Developer Guide

No

CommonJS

18.20.2

6.14.9

Score

Pull Requests

2

153

14

137

Issues

17

40

23

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

476.31 kB

136.67 kB

Maintainers

Package Meta Information

Total Downloads

40,315,507

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Asset Relocator Loader for Webpack

Usage

Installation

Usage

Asset Permissions and Symlinks

Caching

How it Works

Asset Relocation

Binary Relocation

Node.js Compatibility Features

10

10

10

10

6

0

0

0

0

0

0

0

4.1

/10