feat(webpackConfig): experimental native dep check

Author: nklayman

index.js

@@ -61,6 +61,9 @@ module.exports = (api, options) => {
     async (args, rawArgs) => {
       // Use custom config for webpack
       process.env.IS_ELECTRON = true
+      if (args.experimentalNativeDepCheck) {
+        process.env.VCPEB_EXPERIMENTAL_NATIVE_DEP_CHECK = true
+      }
       const builder = require('electron-builder')
       const yargs = require('yargs')
       // Import the yargs options from electron-builder
@@ -74,6 +77,7 @@ module.exports = (api, options) => {
       removeArg('--skipBundle', 1, rawArgs)
       removeArg('--report', 1, rawArgs)
       removeArg('--report-json', 1, rawArgs)
+      removeArg('--experimentalNativeDepCheck', 1, rawArgs)
       // Parse the raw arguments using electron-builder yargs config
       const builderArgs = yargs
         .command(['build', '*'], 'Build', configureBuildCommand)
@@ -261,6 +265,9 @@ module.exports = (api, options) => {
     async (args, rawArgs) => {
       // Use custom config for webpack
       process.env.IS_ELECTRON = true
+      if (args.experimentalNativeDepCheck) {
+        process.env.VCPEB_EXPERIMENTAL_NATIVE_DEP_CHECK = true
+      }
       const execa = require('execa')
       const preload = pluginOptions.preload || {}
       const mainProcessWatch = [
@@ -275,6 +282,7 @@ module.exports = (api, options) => {
       removeArg('--debug', 1, rawArgs)
       removeArg('--headless', 1, rawArgs)
       removeArg('--https', 1, rawArgs)
+      removeArg('--experimentalNativeDepCheck', 1, rawArgs)
 
       // Run the serve command
       const server = await api.service.run('serve', {

lib/webpackConfig.js

@@ -97,41 +97,65 @@ function getExternals (api, pluginOptions) {
   const { dependencies } = require(api.resolve('./package.json'))
   const externalsList = Object.keys(dependencies || {}).reduce(
     (depList, dep) => {
-      // Return true if we want to add a dependency to externals
       try {
-        let pgkString
-        for (const path of nodeModulesPaths) {
-          // Check if package.json exists
-          if (fs.existsSync(api.resolve(`${path}/${dep}/package.json`))) {
-            // If it does, read it and break
-            pgkString = fs
-              .readFileSync(api.resolve(`${path}/${dep}/package.json`))
-              .toString()
-            break
+        if (process.env.VCPEB_EXPERIMENTAL_NATIVE_DEP_CHECK) {
+          // If dep is in whitelist, don't add it no matter what
+          if (userExternalsWhitelist.includes(dep)) {
+            return depList
+          }
+          const name = userExternals.find((name) =>
+            new RegExp(`^${dep}(/|$)`).test(name)
+          )
+          // If dep is listed in user external array, it is an external
+          if (name) {
+            // Use user-provided name if it exists to support subpaths
+            depList.push(name || dep)
+            return depList
+          }
+          for (const path of nodeModulesPaths) {
+            // Check if binding.gyp exists
+            if (fs.existsSync(api.resolve(`${path}/${dep}/binding.gyp`))) {
+              // If it does, dep is native
+              // Use user-provided name if it exists to support subpaths
+              depList.push(name || dep)
+              return depList
+            }
+          }
+        } else {
+          let pgkString
+          for (const path of nodeModulesPaths) {
+            // Check if package.json exists
+            if (fs.existsSync(api.resolve(`${path}/${dep}/package.json`))) {
+              // If it does, read it and break
+              pgkString = fs
+                .readFileSync(api.resolve(`${path}/${dep}/package.json`))
+                .toString()
+              break
+            }
+          }
+          if (!pgkString) {
+            throw new Error(`Could not find a package.json for module ${dep}`)
+          }
+          const pkg = JSON.parse(pgkString)
+          const name = userExternals.find((name) =>
+            new RegExp(`^${pkg.name}(/|$)`).test(name)
+          )
+          const fields = ['main', 'module', 'jsnext:main', 'browser']
+          if (
+            // Not whitelisted
+            userExternalsWhitelist.indexOf(dep) === -1 &&
+            // Doesn't have main property
+            (!fields.some((field) => field in pkg) ||
+              // Has binary property
+              !!pkg.binary ||
+              // Has gypfile property
+              !!pkg.gypfile ||
+              // Listed in user-defined externals list
+              !!name)
+          ) {
+            // Use user-provided name if it exists, for subpaths
+            depList.push(name || dep)
           }
-        }
-        if (!pgkString) {
-          throw new Error(`Could not find a package.json for module ${dep}`)
-        }
-        const pkg = JSON.parse(pgkString)
-        const name = userExternals.find((name) =>
-          new RegExp(`^${pkg.name}(/|$)`).test(name)
-        )
-        const fields = ['main', 'module', 'jsnext:main', 'browser']
-        if (
-          // Not whitelisted
-          userExternalsWhitelist.indexOf(dep) === -1 &&
-          // Doesn't have main property
-          (!fields.some((field) => field in pkg) ||
-            // Has binary property
-            !!pkg.binary ||
-            // Has gypfile property
-            !!pkg.gypfile ||
-            // Listed in user-defined externals list
-            !!name)
-        ) {
-          // Use user-provided name if it exists, for subpaths
-          depList.push(name || dep)
         }
       } catch (e) {
         console.log(e)