implement addNodeAddonIncludePaths

Extension/package.json

@@ -1102,6 +1102,12 @@
           "markdownDescription": "%c_cpp.configuration.vcpkg.enabled.markdownDescription%",
           "scope": "resource"
         },
+        "C_Cpp.addNodeAddonIncludePaths": {
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "%c_cpp.configuration.addNodeAddonIncludePaths.description%",
+          "scope": "resource"
+        },
         "C_Cpp.renameRequiresIdentifier": {
           "type": "boolean",
           "default": true,
@@ -2679,4 +2685,4 @@
       "integrity": "CF1A01AA75275F76800F6BC1D289F2066DCEBCD983376D344ABF6B03FDB8FEA0"
     }
   ]
-}
+}

Extension/package.nls.json

@@ -160,6 +160,7 @@
     "c_cpp.configuration.enhancedColorization.description": "If enabled, code is colorized based on IntelliSense. This setting only applies if intelliSenseEngine is set to \"Default\".",
     "c_cpp.configuration.codeFolding.description": "If enabled, code folding ranges are provided by the language server.",
     "c_cpp.configuration.vcpkg.enabled.markdownDescription": "Enable integration services for the [vcpkg dependency manager](https://aka.ms/vcpkg/).",
+    "c_cpp.configuration.addNodeAddonIncludePaths.description": "Add include paths from nan and node-addon-api when they're dependencies.",
     "c_cpp.configuration.renameRequiresIdentifier.description": "If true, 'Rename Symbol' will require a valid C/C++ identifier.",
     "c_cpp.configuration.debugger.useBacktickCommandSubstitution.description": "If true, debugger shell command substitution will use obsolete backtick (`).",
     "c_cpp.contributes.views.cppReferencesView.title": "C/C++: Other references results",

Extension/src/LanguageServer/configurations.ts

@@ -21,6 +21,8 @@ import * as nls from 'vscode-nls';
 import { setTimeout } from 'timers';
 import * as which from 'which';
 
+const pfs: any = fs.promises;
+
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
 
@@ -130,6 +132,8 @@ export class CppProperties {
     private defaultWindowsSdkVersion: string | null = null;
     private vcpkgIncludes: string[] = [];
     private vcpkgPathReady: boolean = false;
+    private nodeAddonIncludes: string[] = [];
+    private nodeAddonIncludePathsReady: boolean = false;
     private defaultIntelliSenseMode?: string;
     private defaultCustomConfigurationVariables?: { [key: string]: string };
     private readonly configurationGlobPattern: string = "c_cpp_properties.json";
@@ -155,6 +159,7 @@ export class CppProperties {
         this.configFolder = path.join(rootPath, ".vscode");
         this.diagnosticCollection = vscode.languages.createDiagnosticCollection(rootPath);
         this.buildVcpkgIncludePath();
+        this.addNodeAddonIncludeLocations(rootPath);
         this.disposables.push(vscode.Disposable.from(this.configurationsChanged, this.selectionChanged, this.compileCommandsChanged));
     }
 
@@ -288,7 +293,8 @@ export class CppProperties {
     }
 
     private applyDefaultIncludePathsAndFrameworks(): void {
-        if (this.configurationIncomplete && this.defaultIncludes && this.defaultFrameworks && this.vcpkgPathReady) {
+        if (this.configurationIncomplete && this.defaultIncludes && this.defaultFrameworks && this.vcpkgPathReady
+            && this.nodeAddonIncludePathsReady) {
             const configuration: Configuration | undefined = this.CurrentConfiguration;
             if (configuration) {
                 this.applyDefaultConfigurationValues(configuration);
@@ -317,6 +323,10 @@ export class CppProperties {
         } else {
             configuration.includePath = [defaultFolder];
         }
+        if (isUnset(settings.addNodeAddonIncludePaths)) {
+            configuration.includePath = configuration.includePath.concat(this.nodeAddonIncludes);
+        }
+
         // browse.path is not set by default anymore. When it is not set, the includePath will be used instead.
         if (isUnset(settings.defaultDefines)) {
             configuration.defines = (process.platform === 'win32') ? ["_DEBUG", "UNICODE", "_UNICODE"] : [];
@@ -386,6 +396,52 @@ export class CppProperties {
         }
     }
 
+    private nodeAddonMap: {[dependency: string]: string} = {
+        "nan": "node --no-warnings -e \"require('nan')\"",
+        "node-addon-api": "node --no-warnings -p \"require('node-addon-api').include\""
+    };
+
+    private async addNodeAddonIncludeLocations(rootPath: string): Promise<void> {
+        try {
+
+            const settings: CppSettings = new CppSettings(this.rootUri);
+            if (settings.addNodeAddonIncludePaths) {
+                const package_json: any = JSON.parse(await pfs.readFile(path.join(rootPath, "package.json"), "utf8"));
+                for (const dep in this.nodeAddonMap) {
+                    if (dep in package_json.dependencies) {
+                        const execCmd: string = this.nodeAddonMap[dep];
+                        let stdout: string = await util.execChildProcess(execCmd, rootPath);
+                        if (!stdout) {
+                            continue;
+                        }
+
+                        // cleanup newlines
+                        if (stdout[stdout.length - 1] === "\n") {
+                            stdout = stdout.slice(0, -1);
+                        }
+                        // node-addon-api returns a quoted string, e.g., '"/home/user/dir/node_modules/node-addon-api"'.
+                        if (stdout[0] === "\"" && stdout[stdout.length - 1] === "\"") {
+                            stdout = stdout.slice(1, -1);
+                        }
+                        if (stdout) {
+                            // nan returns the path relative to the working directory
+                            stdout = path.resolve(stdout);
+                            if (!await util.checkDirectoryExists(stdout)) {
+                                continue;
+                            }
+                            this.nodeAddonIncludes.push(stdout);
+                        }
+                    }
+                }
+            }
+        } catch (error) {
+            console.log(error);
+        } finally {
+            this.nodeAddonIncludePathsReady = true;
+            this.handleConfigurationChange();
+        }
+    }
+
     private getConfigIndexForPlatform(config: any): number | undefined {
         if (!this.configurationJson) {
             return undefined;

Extension/src/LanguageServer/settings.ts

@@ -141,6 +141,7 @@ export class CppSettings extends Settings {
     public get preferredPathSeparator(): string | undefined { return super.Section.get<string>("preferredPathSeparator"); }
     public get updateChannel(): string | undefined { return super.Section.get<string>("updateChannel"); }
     public get vcpkgEnabled(): boolean | undefined { return super.Section.get<boolean>("vcpkg.enabled"); }
+    public get addNodeAddonIncludePaths(): boolean | undefined { return super.Section.get<boolean>("addNodeAddonIncludePaths"); }
     public get renameRequiresIdentifier(): boolean | undefined { return super.Section.get<boolean>("renameRequiresIdentifier"); }
     public get defaultIncludePath(): string[] | undefined { return super.Section.get<string[]>("default.includePath"); }
     public get defaultDefines(): string[] | undefined { return super.Section.get<string[]>("default.defines"); }