feat: Added support to configure web-ext by declaring a webExt ob…

…ject within `package.json` (#1266)
mozilla · Mar 1, 2018 · 523767a · 523767a
1 parent 33c0aee
commit 523767a
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 2 deletions.
diff --git a/src/config.js b/src/config.js
@@ -131,6 +131,10 @@ export function loadJSConfigFile(filePath: string): Object {
       `Cannot read config file: ${resolvedFilePath}\n` +
       `Error: ${error.message}`);
   }
+  if (filePath.endsWith('package.json')) {
+    log.debug('Looking for webExt key inside package.json file');
+    configObject = configObject.webExt || {};
+  }
   if (Object.keys(configObject).length === 0) {
     log.debug(`Config file ${resolvedFilePath} did not define any options. ` +
       'Did you set module.exports = {...}?');
@@ -151,6 +155,8 @@ export async function discoverConfigFiles(
   const possibleConfigs = [
     // Look for a magic hidden config (preceded by dot) in home dir.
     path.join(getHomeDir(), `.${magicConfigName}`),
+    // Look for webExt key inside package.json file
+    path.join(process.cwd(), 'package.json'),
     // Look for a magic config in the current working directory.
     path.join(process.cwd(), magicConfigName),
   ];

diff --git a/tests/unit/test.config.js b/tests/unit/test.config.js
@@ -905,6 +905,25 @@ describe('config', () => {
         });
     });
 
+    it('parses package.json file correctly', () => {
+      return withTempDir(
+        (tmpDir) => {
+          const configFilePath = path.join(tmpDir.path(), 'package.json');
+          fs.writeFileSync(
+            configFilePath,
+            `{
+                "name": "dummy-package-json",
+                "version": "1.0.0",
+                "webExt": {
+                  "sourceDir": "path/to/fake/source/dir"
+                }
+            }`
+          );
+          const configObj = loadJSConfigFile(configFilePath);
+          assert.equal(configObj.sourceDir, 'path/to/fake/source/dir');
+        });
+    });
+
     it('does not throw an error for an empty config', () => {
       return withTempDir(
         (tmpDir) => {
@@ -913,6 +932,22 @@ describe('config', () => {
           loadJSConfigFile(configFilePath);
         });
     });
+
+    it('returns an empty object when webExt key is not in package.json', () => {
+      return withTempDir(
+        (tmpDir) => {
+          const configFilePath = path.join(tmpDir.path(), 'package.json');
+          fs.writeFileSync(
+            configFilePath,
+            `{
+              "name": "dummy-package-json",
+              "version": "1.0.0"
+            }`
+          );
+          const configObj = loadJSConfigFile(configFilePath);
+          assert.deepEqual(configObj, {});
+        });
+    });
   });
 
   describe('discoverConfigFiles', () => {
@@ -927,6 +962,10 @@ describe('config', () => {
     it('finds a config in your home directory', () => {
       return withTempDir(
         async (tmpDir) => {
+          // This is actually web-ext itself's package.json file, which
+          // will be discovered because it's inside current working
+          // directory
+          const packageJSON = path.join(process.cwd(), 'package.json');
           const homeDirConfig = path.join(
             tmpDir.path(), '.web-ext-config.js'
           );
@@ -937,7 +976,7 @@ describe('config', () => {
             await _discoverConfigFiles({
               getHomeDir: () => tmpDir.path(),
             }),
-            [path.resolve(homeDirConfig)]
+            [path.resolve(homeDirConfig), packageJSON]
           );
         });
     });
@@ -976,6 +1015,18 @@ describe('config', () => {
             );
             await fs.writeFile(globalConfig, 'module.exports = {}');
 
+            const packageJSONConfig = path.resolve(
+              path.join(process.cwd(), 'package.json')
+            );
+            await fs.writeFile(
+              packageJSONConfig,
+              `{
+                "name": "dummy-package-json",
+                "version": "1.0.0",
+                "webExt": {}
+              }`
+            );
+
             const projectConfig = path.resolve(
               path.join(process.cwd(), 'web-ext-config.js')
             );
@@ -985,7 +1036,7 @@ describe('config', () => {
               await _discoverConfigFiles({
                 getHomeDir: () => fakeHomeDir,
               }),
-              [globalConfig, projectConfig]
+              [globalConfig, packageJSONConfig, projectConfig]
             );
           } finally {
             process.chdir(lastDir);