mapbox / mapbox/node-pre-gyp

packlist usage causes symlinks to not be archived

Open
#411 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.2k
Forks
271
Avg merge
23h 40m
Merged PRs (30d)
2

Description

When calling package on macOS or Linux, the resulting archive does not contain any symbolic links which can cause errors after installing.

https://github.com/mapbox/node-pre-gyp/blob/d606a69fc69f765ccbe5bdb0f0f1ab0b9c0e1d32/lib/package.js#L43

It seems that portable should be set to false?

Upon further investigation is looks like symlinks are explicitly kept out of the list of files provided by the packlist function

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at lib/package.js line 43 and trace how the packlist function is called and how its handling of symbolic links affects the archive. Reproduce packaging on macOS or Linux, then verify that symbolic links are preserved in the resulting archive and remain available after installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.