chakra-core/ChakraCore

Include paths prevent hermetically sealed builds

Open

#3,916 opened on Oct 10, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (9,000 stars) (1,374 forks)batch import
Codebase Qualityhelp wanted

Description

I am trying to port ChakraCore to Buck Build, but the include paths used in ChakraCore are making this difficult.

For instance:

  • RuntimeBasePch.h contains #include "Runtime.h";
  • Runtime.h contains #include "../JITIDL/JITTypes.h".

This causes the compiler to walk outside of the top-level of the build, which breaks reproducibility.

This scenario is avoidable if a path without ../ is used instead. For example:

#include "JITIDL/JITTypes.h"

Or better yet, something like this:

#include <ChakraCore/JITIDL/JITTypes.h>

Ideally, all headers would be included from the same include-path. This is common practice is many C++ libraries, such as Boost.

What are the ChakraCore team's thoughts on this?

Contributor guide

Tech stack
cpp
Domain
build systemdevops
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with C++Understanding of include paths
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests replacing relative include paths (e.g., '../') with paths relative to a common root or using angle bracket includes. The fix involves modifying header files like RuntimeBasePch.h and Runtime.h to remove '..' references, as demonstrated in the issue. There are no linked PRs or recent comments, so the contributor should first verify the current state of the codebase and then systematically update include directives across the project, ensuring all headers are reachable from a single include directory.