nodejs / nodejs/node-gyp

Don't include common.gypi from node source tree

Open
#1,118 6 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.7k
Forks
1.9k
Avg merge
1d 4h
Merged PRs (30d)
5

Description

node-gyp includes $nodedir/common.gypi when creating build files for an add-on.

Per https://github.com/nodejs/CTC/issues/62#issuecomment-280108504, that probably isn't future-proof and it's a bad idea in general: it makes add-ons pick up compiler and linker settings that aren't intended for them and may be actively harmful. People have filed bug reports about it.

Plan of action:

  1. Merge common.gypi into addon.gypi.
  2. Strip everything that isn't needed by add-ons.
  3. Test the bejebus out of it with citgm.

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 by tracing how node-gyp includes $nodedir/common.gypi when generating add-on build files, then compare the contents and role of common.gypi and addon.gypi. Follow the issue's plan to identify settings needed by add-ons, remove unrelated settings, and validate the result with citgm.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.