Envinfo config file

__tests__/config.test.js

@@ -0,0 +1,52 @@
+const envinfo = require('../src/envinfo');
+const path = require('path');
+
+describe('envinfo.js config file', () => {
+  test('will read the file and use it', async () => {
+    const cwd = process.cwd();
+    process.chdir(path.join(__dirname, 'packages', path.sep, 'test-config'));
+    try {
+      const data = JSON.parse(await envinfo.run());
+      expect(Object.keys(data)).toEqual(['System', 'npmPackages']);
+      expect(Object.keys(data.System)).toEqual(['OS', 'CPU']);
+    } finally {
+      process.chdir(cwd);
+    }
+  });
+
+  test('run will read the file and use it as a promise', async () => {
+    const cwd = process.cwd();
+    process.chdir(path.join(__dirname, 'packages', path.sep, 'test-config-as-promise'));
+    try {
+      const data = JSON.parse(await envinfo.run());
+      expect(Object.keys(data)).toEqual(['System', 'Binaries']);
+      expect(Object.keys(data.System)).toEqual(['OS', 'CPU']);
+      expect(Object.keys(data.Binaries)).toEqual(['Node', 'npm']);
+    } finally {
+      process.chdir(cwd);
+    }
+  });
+
+  test('command line flags will override config file', async () => {
+    const cwd = process.cwd();
+    process.chdir(path.join(__dirname, 'packages', path.sep, 'test-config'));
+
+    const consoleLogSpy = jest.spyOn(global.console, 'log');
+
+    consoleLogSpy.mockImplementation(() => () => {});
+
+    try {
+      await envinfo.cli({
+        markdown: true,
+        json: false,
+        npmPackages: false,
+        system: true,
+        console: true,
+      });
+      expect(consoleLogSpy.mock.calls[0][0].includes('##')).toBe(true);
+    } finally {
+      consoleLogSpy.mockClear();
+      process.chdir(cwd);
+    }
+  });
+});

__tests__/packages/test-config-as-promise/envinfo.config.js

@@ -0,0 +1,5 @@
+module.exports = () => {
+  return new Promise(resolve =>
+    resolve({ System: ['OS', 'CPU'], Binaries: ['Node', 'npm'], options: { json: true } })
+  );
+};

__tests__/packages/test-config-as-promise/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "test-config-as-promise",
+  "version": "1.0.0",
+  "dependencies": {
+    "a": "1.0.0",
+    "b": "1.0.0"
+  }
+}

__tests__/packages/test-config/envinfo.config.js

@@ -0,0 +1,3 @@
+module.exports = () => {
+  return { System: ['OS', 'CPU'], npmPackages: true, options: { json: true } };
+};

__tests__/packages/test-config/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "test-config",
+  "version": "1.0.0",
+  "dependencies": {
+    "a": "1.0.0",
+    "b": "1.0.0"
+  }
+}

package.json

@@ -55,7 +55,8 @@
     ]
   },
   "jest": {
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": ["/node_modules/", "/__tests__/packages/"]
   },
   "dependencies": {},
   "devDependencies": {

src/envinfo.js

@@ -83,9 +83,20 @@ function main(props, options) {
   });
 }
 
+function runMainFromConfigFile(configFile, options) {
+  return Promise.resolve(configFile()).then(({ options: configOptions, ...config }) => {
+    return main(config, { ...configOptions, ...options });
+  });
+}
+
 // Example usage:
 // $ envinfo --system --npmPackages
 function cli(options) {
+  const configFile = utils.findConfigFile();
+  if (configFile) {
+    return runMainFromConfigFile(configFile, options);
+  }
+
   // if all option is passed, do not pass go, do not collect 200 dollars, go straight to main
   if (options.all) {
     return main(
@@ -135,8 +146,14 @@ function cli(options) {
 
 // require('envinfo);
 // envinfo.run({ system: [os, cpu]}, {fullTree: true })
-function run(args, options) {
+function run(args = {}, options = {}) {
   if (typeof args.preset === 'string') return main(presets[args.preset], options);
+
+  const configFile = utils.findConfigFile();
+  if (configFile) {
+    return runMainFromConfigFile(configFile, options);
+  }
+
   return main(args, options);
 }
 

src/nativeRequire.js

@@ -0,0 +1,3 @@
+// needed for the dynamic requiring of a config file
+// https://stackoverflow.com/questions/42797313/webpack-dynamic-module-loader-by-require/54559637#54559637
+module.exports = require;

src/utils.js

@@ -4,6 +4,7 @@ const os = require('os');
 const childProcess = require('child_process');
 const libWhich = require('which');
 const glob = require('glob');
+const nativeRequire = require('./nativeRequire');
 const matchers = require('./matchers');
 
 const run = (cmd, { unify = false } = {}) => {
@@ -92,9 +93,20 @@ const parseSDKManagerOutput = output => {
   };
 };
 
+function findConfigFile() {
+  const configPath = path.join(process.cwd(), 'envinfo.config.js');
+  try {
+    const fn = nativeRequire(configPath); // eslint-disable-line global-require
+    return fn;
+  } catch (error) {
+    return null;
+  }
+}
+
 module.exports = {
   run: run,
   log: log,
+  findConfigFile: findConfigFile,
   fileExists: fileExists,
   readFile: readFile,
   requireJson: requireJson,

webpack.config.js

@@ -18,6 +18,7 @@ module.exports = {
     path: path.join(__dirname, '/dist'),
   },
   module: {
+    noParse: /\/src\/nativeRequire.js$/,
     rules: [
       {
         use: 'babel-loader',