gyp-parser

library1.0.4jsnpmunverified

gyp-parser is a JavaScript library dedicated to parsing files written in the GYP (Generate Your Projects) format. GYP is a build system historically used by projects like Chromium and Node.js to generate native project files (e.g., Makefiles, Visual Studio projects). This package provides a robust, pure JavaScript implementation that converts GYP source strings into standard JavaScript objects. It serves as a secure and reliable alternative to using `eval()` for GYP content, adeptly handling complex GYP features such as implicit string concatenation, variable expansion, and dictionary merging that `eval()` might misinterpret or fail to process. The current stable version is 1.0.4, indicating a mature and specific tool that likely has an infrequent release cadence. Its key differentiator is its ability to parse the GYP format comprehensively without relying on `eval()` or performing any I/O operations, making it suitable for secure and isolated parsing tasks within applications.

serialization

npm install gyp-parser

github ↗package ↗

INSTALL

IMPORT

SIG · GYP-PARSER

gyp-parser

serializationjavascriptv1.0.4

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

parse

✓ import { parse } from 'gyp-parser';

✗ const parse = require('gyp-parser');

The package is primarily designed for ESM environments and ships TypeScript types. While a CommonJS `require` might work with transpilation, direct named ESM import is the idiomatic way.

parse (CommonJS)

✓ const { parse } = require('gyp-parser');

✗ const parse = require('gyp-parser'); // This tries to import the default export, which doesn't exist for 'parse'

For CommonJS environments, ensure you destructure the named export. However, native ESM usage is recommended.

This quickstart demonstrates parsing a complex GYP file string, including nested objects, arrays, variables, and actions, and then logging the resulting JavaScript object.

import { parse } from 'gyp-parser'; // Example GYP source with implicit string concatenation and a variable const gypFileSource = ` { 'target_name': 'my_app', 'type': 'executable', 'variables': { 'common_flags': [ '-Wall', '-std=c++17' ] }, 'sources': [ 'src/main.cc', 'src/utils.cc' ], 'defines': [ 'VERSION=1.0', 'DEBUG=1' ], 'configurations': { 'Release': { 'defines': [ 'NDEBUG=1' ] } }, 'actions': [ { 'action_name': 'generate_header', 'inputs': [ 'templates/config.h.in' ], 'outputs': [ '$$(RULE_DIR)/config.h' ], 'action': ['python', 'generate_config.py', '<@(_inputs)', '>', '<@(_outputs)'], } ] } `; try { const parsedGyp = parse(gypFileSource); console.log('Successfully parsed GYP data:'); console.log(JSON.stringify(parsedGyp, null, 2)); // Accessing a specific property console.log(`\nTarget Name: ${parsedGyp.target_name}`); console.log(`Common Flags: ${parsedGyp.variables.common_flags.join(', ')}`); } catch (error) { console.error('Failed to parse GYP data:', error.message); }

Debug

Known issues

gotchaDirectly using `eval()` to parse GYP file content is strongly discouraged and can lead to incorrect parsing, security vulnerabilities, and runtime errors.

fix

Always use `gyp-parser`'s `parse` function. It is specifically designed to handle GYP syntax securely and correctly, including features like implicit string concatenation and dictionary merging that `eval()` will not support natively.

affects: >=1.0.0

gotchaThis package is a parser only; it does not perform any I/O operations (e.g., reading files from disk).

fix

You must provide the GYP file content as a string to the `parse` function. Handle file reading (e.g., using `fs.readFileSync` in Node.js) separately before passing the content to `gyp-parser`.

affects: >=1.0.0

gotchaGYP syntax, while similar to JSON, has specific differences (e.g., unquoted keys, comments, string concatenation, variable expansion). Input must conform to GYP syntax, not strict JSON.

fix

Ensure the input string adheres to the GYP format. Errors for malformed GYP will be thrown as `SyntaxError` by the parser. Consult GYP documentation for exact syntax rules if encountering parsing issues.

affects: >=1.0.0

Errors

Common errors & fixes

SyntaxError: Unexpected token '...' in GYP file

The input GYP string contains a syntax error (e.g., unclosed quotes, incorrect punctuation, unsupported construct) that prevents successful parsing.

fix

Carefully review the GYP input string for any syntax inconsistencies. Ensure all strings are correctly quoted, dictionaries and arrays are properly terminated, and no invalid characters are present according to GYP rules.

TypeError: parse is not a function

This typically occurs in CommonJS environments if `require('gyp-parser')` is assigned directly to `parse` without destructuring, or if there's an attempt to call a default export that doesn't exist.

fix

For CommonJS, use `const { parse } = require('gyp-parser');`. In ESM, ensure you are using `import { parse } from 'gyp-parser';`.

TypeError: Cannot read properties of undefined (reading 'some_key')

Attempting to access a property on the parsed GYP object that does not exist or is undefined in the GYP structure.

fix

Verify the GYP file content and the property path you are trying to access. Add checks (e.g., `if (parsedData && parsedData.some_key)`) to handle cases where properties might be missing or optional.

Upgrade

Version history

1.0.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/addaleax/gyp-parser ↗

packagehttps://www.npmjs.com/package/gyp-parser ↗