web-ext 6.8.0 → 7.0.0

package/lib/cmd/run.js

@@ -0,0 +1,191 @@
+import { fs } from 'mz';
+import defaultBuildExtension from './build.js';
+import { showDesktopNotification as defaultDesktopNotifications } from '../util/desktop-notifier.js';
+import * as defaultFirefoxApp from '../firefox/index.js';
+import { connectWithMaxRetries as defaultFirefoxClient } from '../firefox/remote.js';
+import { createLogger } from '../util/logger.js';
+import defaultGetValidatedManifest from '../util/manifest.js';
+import { UsageError } from '../errors.js';
+import { createExtensionRunner, defaultReloadStrategy, MultiExtensionRunner as DefaultMultiExtensionRunner } from '../extension-runners/index.js'; // Import objects that are only used as Flow types.
+
+const log = createLogger(import.meta.url); // Run command types and implementation.
+
+export default async function run({
+  artifactsDir,
+  browserConsole = false,
+  pref,
+  firefox,
+  firefoxProfile,
+  profileCreateIfMissing,
+  keepProfileChanges = false,
+  ignoreFiles,
+  noInput = false,
+  noReload = false,
+  preInstall = false,
+  sourceDir,
+  watchFile,
+  watchIgnored,
+  startUrl,
+  target,
+  args,
+  // Android CLI options.
+  adbBin,
+  adbHost,
+  adbPort,
+  adbDevice,
+  adbDiscoveryTimeout,
+  adbRemoveOldArtifacts,
+  firefoxApk,
+  firefoxApkComponent,
+  // Chromium CLI options.
+  chromiumBinary,
+  chromiumProfile
+}, {
+  buildExtension = defaultBuildExtension,
+  desktopNotifications = defaultDesktopNotifications,
+  firefoxApp = defaultFirefoxApp,
+  firefoxClient = defaultFirefoxClient,
+  reloadStrategy = defaultReloadStrategy,
+  MultiExtensionRunner = DefaultMultiExtensionRunner,
+  getValidatedManifest = defaultGetValidatedManifest
+} = {}) {
+  log.info(`Running web extension from ${sourceDir}`);
+
+  if (preInstall) {
+    log.info('Disabled auto-reloading because it\'s not possible with ' + '--pre-install');
+    noReload = true;
+  }
+
+  if (watchFile != null && (!Array.isArray(watchFile) || !watchFile.every(el => typeof el === 'string'))) {
+    throw new UsageError('Unexpected watchFile type');
+  } // Create an alias for --pref since it has been transformed into an
+  // object containing one or more preferences.
+
+
+  const customPrefs = pref;
+  const manifestData = await getValidatedManifest(sourceDir);
+  const profileDir = firefoxProfile || chromiumProfile;
+
+  if (profileCreateIfMissing) {
+    if (!profileDir) {
+      throw new UsageError('--profile-create-if-missing requires ' + '--firefox-profile or --chromium-profile');
+    }
+
+    const isDir = fs.existsSync(profileDir);
+
+    if (isDir) {
+      log.info(`Profile directory ${profileDir} already exists`);
+    } else {
+      log.info(`Profile directory not found. Creating directory ${profileDir}`);
+      await fs.mkdir(profileDir);
+    }
+  }
+
+  const runners = [];
+  const commonRunnerParams = {
+    // Common options.
+    extensions: [{
+      sourceDir,
+      manifestData
+    }],
+    keepProfileChanges,
+    startUrl,
+    args,
+    desktopNotifications
+  };
+
+  if (!target || target.length === 0 || target.includes('firefox-desktop')) {
+    const firefoxDesktopRunnerParams = { ...commonRunnerParams,
+      // Firefox specific CLI options.
+      firefoxBinary: firefox,
+      profilePath: firefoxProfile,
+      customPrefs,
+      browserConsole,
+      preInstall,
+      // Firefox runner injected dependencies.
+      firefoxApp,
+      firefoxClient
+    };
+    const firefoxDesktopRunner = await createExtensionRunner({
+      target: 'firefox-desktop',
+      params: firefoxDesktopRunnerParams
+    });
+    runners.push(firefoxDesktopRunner);
+  }
+
+  if (target && target.includes('firefox-android')) {
+    const firefoxAndroidRunnerParams = { ...commonRunnerParams,
+      // Firefox specific CLI options.
+      profilePath: firefoxProfile,
+      customPrefs,
+      browserConsole,
+      preInstall,
+      firefoxApk,
+      firefoxApkComponent,
+      adbDevice,
+      adbHost,
+      adbPort,
+      adbBin,
+      adbDiscoveryTimeout,
+      adbRemoveOldArtifacts,
+      // Injected dependencies.
+      firefoxApp,
+      firefoxClient,
+      desktopNotifications: defaultDesktopNotifications,
+      buildSourceDir: (extensionSourceDir, tmpArtifactsDir) => {
+        return buildExtension({
+          sourceDir: extensionSourceDir,
+          ignoreFiles,
+          asNeeded: false,
+          // Use a separate temporary directory for building the extension zip file
+          // that we are going to upload on the android device.
+          artifactsDir: tmpArtifactsDir
+        }, {
+          // Suppress the message usually logged by web-ext build.
+          showReadyMessage: false
+        });
+      }
+    };
+    const firefoxAndroidRunner = await createExtensionRunner({
+      target: 'firefox-android',
+      params: firefoxAndroidRunnerParams
+    });
+    runners.push(firefoxAndroidRunner);
+  }
+
+  if (target && target.includes('chromium')) {
+    const chromiumRunnerParams = { ...commonRunnerParams,
+      chromiumBinary,
+      chromiumProfile
+    };
+    const chromiumRunner = await createExtensionRunner({
+      target: 'chromium',
+      params: chromiumRunnerParams
+    });
+    runners.push(chromiumRunner);
+  }
+
+  const extensionRunner = new MultiExtensionRunner({
+    desktopNotifications,
+    runners
+  });
+  await extensionRunner.run();
+
+  if (noReload) {
+    log.info('Automatic extension reloading has been disabled');
+  } else {
+    log.info('The extension will reload if any source file changes');
+    reloadStrategy({
+      extensionRunner,
+      sourceDir,
+      watchFile,
+      watchIgnored,
+      artifactsDir,
+      ignoreFiles,
+      noInput
+    });
+  }
+
+  return extensionRunner;
+}
+//# sourceMappingURL=run.js.map

package/lib/cmd/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","names":["fs","defaultBuildExtension","showDesktopNotification","defaultDesktopNotifications","defaultFirefoxApp","connectWithMaxRetries","defaultFirefoxClient","createLogger","defaultGetValidatedManifest","UsageError","createExtensionRunner","defaultReloadStrategy","MultiExtensionRunner","DefaultMultiExtensionRunner","log","import","meta","url","run","artifactsDir","browserConsole","pref","firefox","firefoxProfile","profileCreateIfMissing","keepProfileChanges","ignoreFiles","noInput","noReload","preInstall","sourceDir","watchFile","watchIgnored","startUrl","target","args","adbBin","adbHost","adbPort","adbDevice","adbDiscoveryTimeout","adbRemoveOldArtifacts","firefoxApk","firefoxApkComponent","chromiumBinary","chromiumProfile","buildExtension","desktopNotifications","firefoxApp","firefoxClient","reloadStrategy","getValidatedManifest","info","Array","isArray","every","el","customPrefs","manifestData","profileDir","isDir","existsSync","mkdir","runners","commonRunnerParams","extensions","length","includes","firefoxDesktopRunnerParams","firefoxBinary","profilePath","firefoxDesktopRunner","params","push","firefoxAndroidRunnerParams","buildSourceDir","extensionSourceDir","tmpArtifactsDir","asNeeded","showReadyMessage","firefoxAndroidRunner","chromiumRunnerParams","chromiumRunner","extensionRunner"],"sources":["../../src/cmd/run.js"],"sourcesContent":["/* @flow */\nimport { fs } from 'mz';\n\nimport defaultBuildExtension from './build.js';\nimport {\n  showDesktopNotification as defaultDesktopNotifications,\n} from '../util/desktop-notifier.js';\nimport * as defaultFirefoxApp from '../firefox/index.js';\nimport {\n  connectWithMaxRetries as defaultFirefoxClient,\n} from '../firefox/remote.js';\nimport {createLogger} from '../util/logger.js';\nimport defaultGetValidatedManifest from '../util/manifest.js';\nimport {UsageError} from '../errors.js';\nimport {\n  createExtensionRunner,\n  defaultReloadStrategy,\n  MultiExtensionRunner as DefaultMultiExtensionRunner,\n} from '../extension-runners/index.js';\n// Import objects that are only used as Flow types.\nimport type {FirefoxPreferences} from '../firefox/preferences.js';\n\nconst log = createLogger(import.meta.url);\n\n\n// Run command types and implementation.\n\nexport type CmdRunParams = {|\n  artifactsDir: string,\n  browserConsole: boolean,\n  pref?: FirefoxPreferences,\n  firefox: string,\n  firefoxProfile?: string,\n  profileCreateIfMissing?: boolean,\n  ignoreFiles?: Array<string>,\n  keepProfileChanges: boolean,\n  noInput?: boolean,\n  noReload: boolean,\n  preInstall: boolean,\n  sourceDir: string,\n  watchFile?: Array<string>,\n  watchIgnored?: Array<string>,\n  startUrl?: Array<string>,\n  target?: Array<string>,\n  args?: Array<string>,\n\n  // Android CLI options.\n  adbBin?: string,\n  adbHost?: string,\n  adbPort?: string,\n  adbDevice?: string,\n  adbDiscoveryTimeout?: number,\n  adbRemoveOldArtifacts?: boolean,\n  firefoxApk?: string,\n  firefoxApkComponent?: string,\n\n  // Chromium Desktop CLI options.\n  chromiumBinary?: string,\n  chromiumProfile?: string,\n|};\n\nexport type CmdRunOptions = {\n  buildExtension: typeof defaultBuildExtension,\n  desktopNotifications: typeof defaultDesktopNotifications,\n  firefoxApp: typeof defaultFirefoxApp,\n  firefoxClient: typeof defaultFirefoxClient,\n  reloadStrategy: typeof defaultReloadStrategy,\n  shouldExitProgram?: boolean,\n  MultiExtensionRunner?: typeof DefaultMultiExtensionRunner,\n  getValidatedManifest?: typeof defaultGetValidatedManifest,\n};\n\nexport default async function run(\n  {\n    artifactsDir,\n    browserConsole = false,\n    pref,\n    firefox,\n    firefoxProfile,\n    profileCreateIfMissing,\n    keepProfileChanges = false,\n    ignoreFiles,\n    noInput = false,\n    noReload = false,\n    preInstall = false,\n    sourceDir,\n    watchFile,\n    watchIgnored,\n    startUrl,\n    target,\n    args,\n    // Android CLI options.\n    adbBin,\n    adbHost,\n    adbPort,\n    adbDevice,\n    adbDiscoveryTimeout,\n    adbRemoveOldArtifacts,\n    firefoxApk,\n    firefoxApkComponent,\n    // Chromium CLI options.\n    chromiumBinary,\n    chromiumProfile,\n  }: CmdRunParams,\n  {\n    buildExtension = defaultBuildExtension,\n    desktopNotifications = defaultDesktopNotifications,\n    firefoxApp = defaultFirefoxApp,\n    firefoxClient = defaultFirefoxClient,\n    reloadStrategy = defaultReloadStrategy,\n    MultiExtensionRunner = DefaultMultiExtensionRunner,\n    getValidatedManifest = defaultGetValidatedManifest,\n  }: CmdRunOptions = {}): Promise<DefaultMultiExtensionRunner> {\n\n  log.info(`Running web extension from ${sourceDir}`);\n  if (preInstall) {\n    log.info('Disabled auto-reloading because it\\'s not possible with ' +\n             '--pre-install');\n    noReload = true;\n  }\n\n  if (watchFile != null && (!Array.isArray(watchFile) ||\n      !watchFile.every((el) => typeof el === 'string'))) {\n    throw new UsageError('Unexpected watchFile type');\n  }\n\n  // Create an alias for --pref since it has been transformed into an\n  // object containing one or more preferences.\n  const customPrefs = pref;\n  const manifestData = await getValidatedManifest(sourceDir);\n\n  const profileDir = firefoxProfile || chromiumProfile;\n\n  if (profileCreateIfMissing) {\n    if (!profileDir) {\n      throw new UsageError(\n        '--profile-create-if-missing requires ' +\n        '--firefox-profile or --chromium-profile'\n      );\n    }\n    const isDir = fs.existsSync(profileDir);\n    if (isDir) {\n      log.info(`Profile directory ${profileDir} already exists`);\n    } else {\n      log.info(`Profile directory not found. Creating directory ${profileDir}`);\n      await fs.mkdir(profileDir);\n    }\n  }\n\n  const runners = [];\n\n  const commonRunnerParams = {\n    // Common options.\n    extensions: [{sourceDir, manifestData}],\n    keepProfileChanges,\n    startUrl,\n    args,\n    desktopNotifications,\n  };\n\n  if (!target || target.length === 0 || target.includes('firefox-desktop')) {\n    const firefoxDesktopRunnerParams = {\n      ...commonRunnerParams,\n\n      // Firefox specific CLI options.\n      firefoxBinary: firefox,\n      profilePath: firefoxProfile,\n      customPrefs,\n      browserConsole,\n      preInstall,\n\n      // Firefox runner injected dependencies.\n      firefoxApp,\n      firefoxClient,\n    };\n\n    const firefoxDesktopRunner = await createExtensionRunner({\n      target: 'firefox-desktop',\n      params: firefoxDesktopRunnerParams,\n    });\n    runners.push(firefoxDesktopRunner);\n  }\n\n  if (target && target.includes('firefox-android')) {\n    const firefoxAndroidRunnerParams = {\n      ...commonRunnerParams,\n\n      // Firefox specific CLI options.\n      profilePath: firefoxProfile,\n      customPrefs,\n      browserConsole,\n      preInstall,\n      firefoxApk,\n      firefoxApkComponent,\n      adbDevice,\n      adbHost,\n      adbPort,\n      adbBin,\n      adbDiscoveryTimeout,\n      adbRemoveOldArtifacts,\n\n      // Injected dependencies.\n      firefoxApp,\n      firefoxClient,\n      desktopNotifications: defaultDesktopNotifications,\n      buildSourceDir: (extensionSourceDir: string, tmpArtifactsDir: string) => {\n        return buildExtension({\n          sourceDir: extensionSourceDir,\n          ignoreFiles,\n          asNeeded: false,\n          // Use a separate temporary directory for building the extension zip file\n          // that we are going to upload on the android device.\n          artifactsDir: tmpArtifactsDir,\n        }, {\n          // Suppress the message usually logged by web-ext build.\n          showReadyMessage: false,\n        });\n      },\n    };\n\n    const firefoxAndroidRunner = await createExtensionRunner({\n      target: 'firefox-android',\n      params: firefoxAndroidRunnerParams,\n    });\n    runners.push(firefoxAndroidRunner);\n  }\n\n  if (target && target.includes('chromium')) {\n    const chromiumRunnerParams = {\n      ...commonRunnerParams,\n      chromiumBinary,\n      chromiumProfile,\n    };\n\n    const chromiumRunner = await createExtensionRunner({\n      target: 'chromium',\n      params: chromiumRunnerParams,\n    });\n    runners.push(chromiumRunner);\n  }\n\n  const extensionRunner = new MultiExtensionRunner({\n    desktopNotifications,\n    runners,\n  });\n\n  await extensionRunner.run();\n\n  if (noReload) {\n    log.info('Automatic extension reloading has been disabled');\n  } else {\n    log.info('The extension will reload if any source file changes');\n\n    reloadStrategy({\n      extensionRunner,\n      sourceDir,\n      watchFile,\n      watchIgnored,\n      artifactsDir,\n      ignoreFiles,\n      noInput,\n    });\n  }\n\n  return extensionRunner;\n}\n"],"mappings":"AACA,SAASA,EAAT,QAAmB,IAAnB;AAEA,OAAOC,qBAAP,MAAkC,YAAlC;AACA,SACEC,uBAAuB,IAAIC,2BAD7B,QAEO,6BAFP;AAGA,OAAO,KAAKC,iBAAZ,MAAmC,qBAAnC;AACA,SACEC,qBAAqB,IAAIC,oBAD3B,QAEO,sBAFP;AAGA,SAAQC,YAAR,QAA2B,mBAA3B;AACA,OAAOC,2BAAP,MAAwC,qBAAxC;AACA,SAAQC,UAAR,QAAyB,cAAzB;AACA,SACEC,qBADF,EAEEC,qBAFF,EAGEC,oBAAoB,IAAIC,2BAH1B,QAIO,+BAJP,C,CAKA;;AAGA,MAAMC,GAAG,GAAGP,YAAY,CAACQ,MAAM,CAACC,IAAP,CAAYC,GAAb,CAAxB,C,CAGA;;AA+CA,eAAe,eAAeC,GAAf,CACb;EACEC,YADF;EAEEC,cAAc,GAAG,KAFnB;EAGEC,IAHF;EAIEC,OAJF;EAKEC,cALF;EAMEC,sBANF;EAOEC,kBAAkB,GAAG,KAPvB;EAQEC,WARF;EASEC,OAAO,GAAG,KATZ;EAUEC,QAAQ,GAAG,KAVb;EAWEC,UAAU,GAAG,KAXf;EAYEC,SAZF;EAaEC,SAbF;EAcEC,YAdF;EAeEC,QAfF;EAgBEC,MAhBF;EAiBEC,IAjBF;EAkBE;EACAC,MAnBF;EAoBEC,OApBF;EAqBEC,OArBF;EAsBEC,SAtBF;EAuBEC,mBAvBF;EAwBEC,qBAxBF;EAyBEC,UAzBF;EA0BEC,mBA1BF;EA2BE;EACAC,cA5BF;EA6BEC;AA7BF,CADa,EAgCb;EACEC,cAAc,GAAG7C,qBADnB;EAEE8C,oBAAoB,GAAG5C,2BAFzB;EAGE6C,UAAU,GAAG5C,iBAHf;EAIE6C,aAAa,GAAG3C,oBAJlB;EAKE4C,cAAc,GAAGvC,qBALnB;EAMEC,oBAAoB,GAAGC,2BANzB;EAOEsC,oBAAoB,GAAG3C;AAPzB,IAQmB,EAxCN,EAwCgD;EAE7DM,GAAG,CAACsC,IAAJ,CAAU,8BAA6BtB,SAAU,EAAjD;;EACA,IAAID,UAAJ,EAAgB;IACdf,GAAG,CAACsC,IAAJ,CAAS,6DACA,eADT;IAEAxB,QAAQ,GAAG,IAAX;EACD;;EAED,IAAIG,SAAS,IAAI,IAAb,KAAsB,CAACsB,KAAK,CAACC,OAAN,CAAcvB,SAAd,CAAD,IACtB,CAACA,SAAS,CAACwB,KAAV,CAAiBC,EAAD,IAAQ,OAAOA,EAAP,KAAc,QAAtC,CADD,CAAJ,EACuD;IACrD,MAAM,IAAI/C,UAAJ,CAAe,2BAAf,CAAN;EACD,CAZ4D,CAc7D;EACA;;;EACA,MAAMgD,WAAW,GAAGpC,IAApB;EACA,MAAMqC,YAAY,GAAG,MAAMP,oBAAoB,CAACrB,SAAD,CAA/C;EAEA,MAAM6B,UAAU,GAAGpC,cAAc,IAAIsB,eAArC;;EAEA,IAAIrB,sBAAJ,EAA4B;IAC1B,IAAI,CAACmC,UAAL,EAAiB;MACf,MAAM,IAAIlD,UAAJ,CACJ,0CACA,yCAFI,CAAN;IAID;;IACD,MAAMmD,KAAK,GAAG5D,EAAE,CAAC6D,UAAH,CAAcF,UAAd,CAAd;;IACA,IAAIC,KAAJ,EAAW;MACT9C,GAAG,CAACsC,IAAJ,CAAU,qBAAoBO,UAAW,iBAAzC;IACD,CAFD,MAEO;MACL7C,GAAG,CAACsC,IAAJ,CAAU,mDAAkDO,UAAW,EAAvE;MACA,MAAM3D,EAAE,CAAC8D,KAAH,CAASH,UAAT,CAAN;IACD;EACF;;EAED,MAAMI,OAAO,GAAG,EAAhB;EAEA,MAAMC,kBAAkB,GAAG;IACzB;IACAC,UAAU,EAAE,CAAC;MAACnC,SAAD;MAAY4B;IAAZ,CAAD,CAFa;IAGzBjC,kBAHyB;IAIzBQ,QAJyB;IAKzBE,IALyB;IAMzBY;EANyB,CAA3B;;EASA,IAAI,CAACb,MAAD,IAAWA,MAAM,CAACgC,MAAP,KAAkB,CAA7B,IAAkChC,MAAM,CAACiC,QAAP,CAAgB,iBAAhB,CAAtC,EAA0E;IACxE,MAAMC,0BAA0B,GAAG,EACjC,GAAGJ,kBAD8B;MAGjC;MACAK,aAAa,EAAE/C,OAJkB;MAKjCgD,WAAW,EAAE/C,cALoB;MAMjCkC,WANiC;MAOjCrC,cAPiC;MAQjCS,UARiC;MAUjC;MACAmB,UAXiC;MAYjCC;IAZiC,CAAnC;IAeA,MAAMsB,oBAAoB,GAAG,MAAM7D,qBAAqB,CAAC;MACvDwB,MAAM,EAAE,iBAD+C;MAEvDsC,MAAM,EAAEJ;IAF+C,CAAD,CAAxD;IAIAL,OAAO,CAACU,IAAR,CAAaF,oBAAb;EACD;;EAED,IAAIrC,MAAM,IAAIA,MAAM,CAACiC,QAAP,CAAgB,iBAAhB,CAAd,EAAkD;IAChD,MAAMO,0BAA0B,GAAG,EACjC,GAAGV,kBAD8B;MAGjC;MACAM,WAAW,EAAE/C,cAJoB;MAKjCkC,WALiC;MAMjCrC,cANiC;MAOjCS,UAPiC;MAQjCa,UARiC;MASjCC,mBATiC;MAUjCJ,SAViC;MAWjCF,OAXiC;MAYjCC,OAZiC;MAajCF,MAbiC;MAcjCI,mBAdiC;MAejCC,qBAfiC;MAiBjC;MACAO,UAlBiC;MAmBjCC,aAnBiC;MAoBjCF,oBAAoB,EAAE5C,2BApBW;MAqBjCwE,cAAc,EAAE,CAACC,kBAAD,EAA6BC,eAA7B,KAAyD;QACvE,OAAO/B,cAAc,CAAC;UACpBhB,SAAS,EAAE8C,kBADS;UAEpBlD,WAFoB;UAGpBoD,QAAQ,EAAE,KAHU;UAIpB;UACA;UACA3D,YAAY,EAAE0D;QANM,CAAD,EAOlB;UACD;UACAE,gBAAgB,EAAE;QAFjB,CAPkB,CAArB;MAWD;IAjCgC,CAAnC;IAoCA,MAAMC,oBAAoB,GAAG,MAAMtE,qBAAqB,CAAC;MACvDwB,MAAM,EAAE,iBAD+C;MAEvDsC,MAAM,EAAEE;IAF+C,CAAD,CAAxD;IAIAX,OAAO,CAACU,IAAR,CAAaO,oBAAb;EACD;;EAED,IAAI9C,MAAM,IAAIA,MAAM,CAACiC,QAAP,CAAgB,UAAhB,CAAd,EAA2C;IACzC,MAAMc,oBAAoB,GAAG,EAC3B,GAAGjB,kBADwB;MAE3BpB,cAF2B;MAG3BC;IAH2B,CAA7B;IAMA,MAAMqC,cAAc,GAAG,MAAMxE,qBAAqB,CAAC;MACjDwB,MAAM,EAAE,UADyC;MAEjDsC,MAAM,EAAES;IAFyC,CAAD,CAAlD;IAIAlB,OAAO,CAACU,IAAR,CAAaS,cAAb;EACD;;EAED,MAAMC,eAAe,GAAG,IAAIvE,oBAAJ,CAAyB;IAC/CmC,oBAD+C;IAE/CgB;EAF+C,CAAzB,CAAxB;EAKA,MAAMoB,eAAe,CAACjE,GAAhB,EAAN;;EAEA,IAAIU,QAAJ,EAAc;IACZd,GAAG,CAACsC,IAAJ,CAAS,iDAAT;EACD,CAFD,MAEO;IACLtC,GAAG,CAACsC,IAAJ,CAAS,sDAAT;IAEAF,cAAc,CAAC;MACbiC,eADa;MAEbrD,SAFa;MAGbC,SAHa;MAIbC,YAJa;MAKbb,YALa;MAMbO,WANa;MAObC;IAPa,CAAD,CAAd;EASD;;EAED,OAAOwD,eAAP;AACD"}

package/lib/cmd/sign.js

@@ -0,0 +1,140 @@
+import path from 'path';
+import { fs } from 'mz';
+import { signAddon as defaultAddonSigner } from 'sign-addon';
+import defaultBuilder from './build.js';
+import getValidatedManifest, { getManifestId } from '../util/manifest.js';
+import { withTempDir } from '../util/temp-dir.js';
+import { isErrorWithCode, UsageError, WebExtError } from '../errors.js';
+import { prepareArtifactsDir } from '../util/artifacts.js';
+import { createLogger } from '../util/logger.js';
+const log = createLogger(import.meta.url);
+const defaultAsyncFsReadFile = fs.readFile.bind(fs);
+export const extensionIdFile = '.web-extension-id'; // Sign command types and implementation.
+
+export default function sign({
+  apiKey,
+  apiProxy,
+  apiSecret,
+  apiUrlPrefix,
+  artifactsDir,
+  id,
+  ignoreFiles = [],
+  sourceDir,
+  timeout,
+  verbose,
+  channel
+}, {
+  build = defaultBuilder,
+  preValidatedManifest,
+  signAddon = defaultAddonSigner
+} = {}) {
+  return withTempDir(async function (tmpDir) {
+    await prepareArtifactsDir(artifactsDir);
+    let manifestData;
+
+    if (preValidatedManifest) {
+      manifestData = preValidatedManifest;
+    } else {
+      manifestData = await getValidatedManifest(sourceDir);
+    }
+
+    const [buildResult, idFromSourceDir] = await Promise.all([build({
+      sourceDir,
+      ignoreFiles,
+      artifactsDir: tmpDir.path()
+    }, {
+      manifestData,
+      showReadyMessage: false
+    }), getIdFromSourceDir(sourceDir)]);
+    const manifestId = getManifestId(manifestData);
+
+    if (id && manifestId) {
+      throw new UsageError(`Cannot set custom ID ${id} because manifest.json ` + `declares ID ${manifestId}`);
+    }
+
+    if (id) {
+      log.debug(`Using custom ID declared as --id=${id}`);
+    }
+
+    if (manifestId) {
+      id = manifestId;
+    }
+
+    if (!id && idFromSourceDir) {
+      log.info(`Using previously auto-generated extension ID: ${idFromSourceDir}`);
+      id = idFromSourceDir;
+    }
+
+    if (!id) {
+      log.warn('No extension ID specified (it will be auto-generated)');
+    }
+
+    const signingResult = await signAddon({
+      apiKey,
+      apiSecret,
+      apiUrlPrefix,
+      apiProxy,
+      timeout,
+      verbose,
+      id,
+      xpiPath: buildResult.extensionPath,
+      version: manifestData.version,
+      downloadDir: artifactsDir,
+      channel
+    });
+
+    if (signingResult.id) {
+      await saveIdToSourceDir(sourceDir, signingResult.id);
+    } // All information about the downloaded files would have
+    // already been logged by signAddon().
+
+
+    if (signingResult.success) {
+      log.info(`Extension ID: ${signingResult.id}`);
+      log.info('SUCCESS');
+    } else {
+      log.info('FAIL');
+      throw new WebExtError('The extension could not be signed');
+    }
+
+    return signingResult;
+  });
+}
+export async function getIdFromSourceDir(sourceDir, asyncFsReadFile = defaultAsyncFsReadFile) {
+  const filePath = path.join(sourceDir, extensionIdFile);
+  let content;
+
+  try {
+    content = await asyncFsReadFile(filePath);
+  } catch (error) {
+    if (isErrorWithCode('ENOENT', error)) {
+      log.debug(`No ID file found at: ${filePath}`);
+      return;
+    }
+
+    throw error;
+  }
+
+  let lines = content.toString().split('\n');
+  lines = lines.filter(line => {
+    line = line.trim();
+
+    if (line && !line.startsWith('#')) {
+      return line;
+    }
+  });
+  const id = lines[0];
+  log.debug(`Found extension ID ${id} in ${filePath}`);
+
+  if (!id) {
+    throw new UsageError(`No ID found in extension ID file ${filePath}`);
+  }
+
+  return id;
+}
+export async function saveIdToSourceDir(sourceDir, id) {
+  const filePath = path.join(sourceDir, extensionIdFile);
+  await fs.writeFile(filePath, ['# This file was created by https://github.com/mozilla/web-ext', '# Your auto-generated extension ID for addons.mozilla.org is:', id.toString()].join('\n'));
+  log.debug(`Saved auto-generated ID ${id} to ${filePath}`);
+}
+//# sourceMappingURL=sign.js.map

package/lib/cmd/sign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign.js","names":["path","fs","signAddon","defaultAddonSigner","defaultBuilder","getValidatedManifest","getManifestId","withTempDir","isErrorWithCode","UsageError","WebExtError","prepareArtifactsDir","createLogger","log","import","meta","url","defaultAsyncFsReadFile","readFile","bind","extensionIdFile","sign","apiKey","apiProxy","apiSecret","apiUrlPrefix","artifactsDir","id","ignoreFiles","sourceDir","timeout","verbose","channel","build","preValidatedManifest","tmpDir","manifestData","buildResult","idFromSourceDir","Promise","all","showReadyMessage","getIdFromSourceDir","manifestId","debug","info","warn","signingResult","xpiPath","extensionPath","version","downloadDir","saveIdToSourceDir","success","asyncFsReadFile","filePath","join","content","error","lines","toString","split","filter","line","trim","startsWith","writeFile"],"sources":["../../src/cmd/sign.js"],"sourcesContent":["/* @flow */\nimport path from 'path';\n\nimport {fs} from 'mz';\nimport {signAddon as defaultAddonSigner} from 'sign-addon';\n\nimport defaultBuilder from './build.js';\nimport getValidatedManifest, {getManifestId} from '../util/manifest.js';\nimport {withTempDir} from '../util/temp-dir.js';\nimport {isErrorWithCode, UsageError, WebExtError} from '../errors.js';\nimport {prepareArtifactsDir} from '../util/artifacts.js';\nimport {createLogger} from '../util/logger.js';\nimport type {ExtensionManifest} from '../util/manifest.js';\n\nconst log = createLogger(import.meta.url);\n\nconst defaultAsyncFsReadFile: (string) => Promise<Buffer> =\n  fs.readFile.bind(fs);\n\nexport const extensionIdFile = '.web-extension-id';\n\n// Sign command types and implementation.\n\nexport type SignParams = {|\n  apiKey: string,\n  apiProxy: string,\n  apiSecret: string,\n  apiUrlPrefix: string,\n  artifactsDir: string,\n  id?: string,\n  ignoreFiles?: Array<string>,\n  sourceDir: string,\n  timeout: number,\n  verbose?: boolean,\n  channel?: string,\n|};\n\nexport type SignOptions = {\n  build?: typeof defaultBuilder,\n  signAddon?: typeof defaultAddonSigner,\n  preValidatedManifest?: ExtensionManifest,\n  shouldExitProgram?: boolean,\n};\n\nexport type SignResult = {|\n  success: boolean,\n  id: string,\n  downloadedFiles: Array<string>,\n|};\n\nexport default function sign(\n  {\n    apiKey,\n    apiProxy,\n    apiSecret,\n    apiUrlPrefix,\n    artifactsDir,\n    id,\n    ignoreFiles = [],\n    sourceDir,\n    timeout,\n    verbose,\n    channel,\n  }: SignParams,\n  {\n    build = defaultBuilder,\n    preValidatedManifest,\n    signAddon = defaultAddonSigner,\n  }: SignOptions = {}\n): Promise<SignResult> {\n  return withTempDir(\n    async function(tmpDir) {\n      await prepareArtifactsDir(artifactsDir);\n\n      let manifestData;\n\n      if (preValidatedManifest) {\n        manifestData = preValidatedManifest;\n      } else {\n        manifestData = await getValidatedManifest(sourceDir);\n      }\n\n      const [buildResult, idFromSourceDir] = await Promise.all([\n        build({sourceDir, ignoreFiles, artifactsDir: tmpDir.path()},\n              {manifestData, showReadyMessage: false}),\n        getIdFromSourceDir(sourceDir),\n      ]);\n\n      const manifestId = getManifestId(manifestData);\n\n      if (id && manifestId) {\n        throw new UsageError(\n          `Cannot set custom ID ${id} because manifest.json ` +\n          `declares ID ${manifestId}`);\n      }\n      if (id) {\n        log.debug(`Using custom ID declared as --id=${id}`);\n      }\n\n      if (manifestId) {\n        id = manifestId;\n      }\n\n      if (!id && idFromSourceDir) {\n        log.info(\n          `Using previously auto-generated extension ID: ${idFromSourceDir}`);\n        id = idFromSourceDir;\n      }\n\n      if (!id) {\n        log.warn('No extension ID specified (it will be auto-generated)');\n      }\n\n      const signingResult = await signAddon({\n        apiKey,\n        apiSecret,\n        apiUrlPrefix,\n        apiProxy,\n        timeout,\n        verbose,\n        id,\n        xpiPath: buildResult.extensionPath,\n        version: manifestData.version,\n        downloadDir: artifactsDir,\n        channel,\n      });\n\n      if (signingResult.id) {\n        await saveIdToSourceDir(sourceDir, signingResult.id);\n      }\n\n      // All information about the downloaded files would have\n      // already been logged by signAddon().\n      if (signingResult.success) {\n        log.info(`Extension ID: ${signingResult.id}`);\n        log.info('SUCCESS');\n      } else {\n        log.info('FAIL');\n        throw new WebExtError(\n          'The extension could not be signed');\n      }\n\n      return signingResult;\n    }\n  );\n}\n\n\nexport async function getIdFromSourceDir(\n  sourceDir: string,\n  asyncFsReadFile: typeof defaultAsyncFsReadFile = defaultAsyncFsReadFile,\n): Promise<string | void> {\n  const filePath = path.join(sourceDir, extensionIdFile);\n\n  let content;\n\n  try {\n    content = await asyncFsReadFile(filePath);\n  } catch (error) {\n    if (isErrorWithCode('ENOENT', error)) {\n      log.debug(`No ID file found at: ${filePath}`);\n      return;\n    }\n    throw error;\n  }\n\n  let lines = content.toString().split('\\n');\n  lines = lines.filter((line) => {\n    line = line.trim();\n    if (line && !line.startsWith('#')) {\n      return line;\n    }\n  });\n\n  const id = lines[0];\n  log.debug(`Found extension ID ${id} in ${filePath}`);\n\n  if (!id) {\n    throw new UsageError(`No ID found in extension ID file ${filePath}`);\n  }\n\n  return id;\n}\n\n\nexport async function saveIdToSourceDir(\n  sourceDir: string, id: string\n): Promise<void> {\n  const filePath = path.join(sourceDir, extensionIdFile);\n  await fs.writeFile(filePath, [\n    '# This file was created by https://github.com/mozilla/web-ext',\n    '# Your auto-generated extension ID for addons.mozilla.org is:',\n    id.toString(),\n  ].join('\\n'));\n\n  log.debug(`Saved auto-generated ID ${id} to ${filePath}`);\n}\n"],"mappings":"AACA,OAAOA,IAAP,MAAiB,MAAjB;AAEA,SAAQC,EAAR,QAAiB,IAAjB;AACA,SAAQC,SAAS,IAAIC,kBAArB,QAA8C,YAA9C;AAEA,OAAOC,cAAP,MAA2B,YAA3B;AACA,OAAOC,oBAAP,IAA8BC,aAA9B,QAAkD,qBAAlD;AACA,SAAQC,WAAR,QAA0B,qBAA1B;AACA,SAAQC,eAAR,EAAyBC,UAAzB,EAAqCC,WAArC,QAAuD,cAAvD;AACA,SAAQC,mBAAR,QAAkC,sBAAlC;AACA,SAAQC,YAAR,QAA2B,mBAA3B;AAGA,MAAMC,GAAG,GAAGD,YAAY,CAACE,MAAM,CAACC,IAAP,CAAYC,GAAb,CAAxB;AAEA,MAAMC,sBAAmD,GACvDhB,EAAE,CAACiB,QAAH,CAAYC,IAAZ,CAAiBlB,EAAjB,CADF;AAGA,OAAO,MAAMmB,eAAe,GAAG,mBAAxB,C,CAEP;;AA6BA,eAAe,SAASC,IAAT,CACb;EACEC,MADF;EAEEC,QAFF;EAGEC,SAHF;EAIEC,YAJF;EAKEC,YALF;EAMEC,EANF;EAOEC,WAAW,GAAG,EAPhB;EAQEC,SARF;EASEC,OATF;EAUEC,OAVF;EAWEC;AAXF,CADa,EAcb;EACEC,KAAK,GAAG7B,cADV;EAEE8B,oBAFF;EAGEhC,SAAS,GAAGC;AAHd,IAIiB,EAlBJ,EAmBQ;EACrB,OAAOI,WAAW,CAChB,gBAAe4B,MAAf,EAAuB;IACrB,MAAMxB,mBAAmB,CAACe,YAAD,CAAzB;IAEA,IAAIU,YAAJ;;IAEA,IAAIF,oBAAJ,EAA0B;MACxBE,YAAY,GAAGF,oBAAf;IACD,CAFD,MAEO;MACLE,YAAY,GAAG,MAAM/B,oBAAoB,CAACwB,SAAD,CAAzC;IACD;;IAED,MAAM,CAACQ,WAAD,EAAcC,eAAd,IAAiC,MAAMC,OAAO,CAACC,GAAR,CAAY,CACvDP,KAAK,CAAC;MAACJ,SAAD;MAAYD,WAAZ;MAAyBF,YAAY,EAAES,MAAM,CAACnC,IAAP;IAAvC,CAAD,EACC;MAACoC,YAAD;MAAeK,gBAAgB,EAAE;IAAjC,CADD,CADkD,EAGvDC,kBAAkB,CAACb,SAAD,CAHqC,CAAZ,CAA7C;IAMA,MAAMc,UAAU,GAAGrC,aAAa,CAAC8B,YAAD,CAAhC;;IAEA,IAAIT,EAAE,IAAIgB,UAAV,EAAsB;MACpB,MAAM,IAAIlC,UAAJ,CACH,wBAAuBkB,EAAG,yBAA3B,GACC,eAAcgB,UAAW,EAFtB,CAAN;IAGD;;IACD,IAAIhB,EAAJ,EAAQ;MACNd,GAAG,CAAC+B,KAAJ,CAAW,oCAAmCjB,EAAG,EAAjD;IACD;;IAED,IAAIgB,UAAJ,EAAgB;MACdhB,EAAE,GAAGgB,UAAL;IACD;;IAED,IAAI,CAAChB,EAAD,IAAOW,eAAX,EAA4B;MAC1BzB,GAAG,CAACgC,IAAJ,CACG,iDAAgDP,eAAgB,EADnE;MAEAX,EAAE,GAAGW,eAAL;IACD;;IAED,IAAI,CAACX,EAAL,EAAS;MACPd,GAAG,CAACiC,IAAJ,CAAS,uDAAT;IACD;;IAED,MAAMC,aAAa,GAAG,MAAM7C,SAAS,CAAC;MACpCoB,MADoC;MAEpCE,SAFoC;MAGpCC,YAHoC;MAIpCF,QAJoC;MAKpCO,OALoC;MAMpCC,OANoC;MAOpCJ,EAPoC;MAQpCqB,OAAO,EAAEX,WAAW,CAACY,aARe;MASpCC,OAAO,EAAEd,YAAY,CAACc,OATc;MAUpCC,WAAW,EAAEzB,YAVuB;MAWpCM;IAXoC,CAAD,CAArC;;IAcA,IAAIe,aAAa,CAACpB,EAAlB,EAAsB;MACpB,MAAMyB,iBAAiB,CAACvB,SAAD,EAAYkB,aAAa,CAACpB,EAA1B,CAAvB;IACD,CA1DoB,CA4DrB;IACA;;;IACA,IAAIoB,aAAa,CAACM,OAAlB,EAA2B;MACzBxC,GAAG,CAACgC,IAAJ,CAAU,iBAAgBE,aAAa,CAACpB,EAAG,EAA3C;MACAd,GAAG,CAACgC,IAAJ,CAAS,SAAT;IACD,CAHD,MAGO;MACLhC,GAAG,CAACgC,IAAJ,CAAS,MAAT;MACA,MAAM,IAAInC,WAAJ,CACJ,mCADI,CAAN;IAED;;IAED,OAAOqC,aAAP;EACD,CAzEe,CAAlB;AA2ED;AAGD,OAAO,eAAeL,kBAAf,CACLb,SADK,EAELyB,eAA8C,GAAGrC,sBAF5C,EAGmB;EACxB,MAAMsC,QAAQ,GAAGvD,IAAI,CAACwD,IAAL,CAAU3B,SAAV,EAAqBT,eAArB,CAAjB;EAEA,IAAIqC,OAAJ;;EAEA,IAAI;IACFA,OAAO,GAAG,MAAMH,eAAe,CAACC,QAAD,CAA/B;EACD,CAFD,CAEE,OAAOG,KAAP,EAAc;IACd,IAAIlD,eAAe,CAAC,QAAD,EAAWkD,KAAX,CAAnB,EAAsC;MACpC7C,GAAG,CAAC+B,KAAJ,CAAW,wBAAuBW,QAAS,EAA3C;MACA;IACD;;IACD,MAAMG,KAAN;EACD;;EAED,IAAIC,KAAK,GAAGF,OAAO,CAACG,QAAR,GAAmBC,KAAnB,CAAyB,IAAzB,CAAZ;EACAF,KAAK,GAAGA,KAAK,CAACG,MAAN,CAAcC,IAAD,IAAU;IAC7BA,IAAI,GAAGA,IAAI,CAACC,IAAL,EAAP;;IACA,IAAID,IAAI,IAAI,CAACA,IAAI,CAACE,UAAL,CAAgB,GAAhB,CAAb,EAAmC;MACjC,OAAOF,IAAP;IACD;EACF,CALO,CAAR;EAOA,MAAMpC,EAAE,GAAGgC,KAAK,CAAC,CAAD,CAAhB;EACA9C,GAAG,CAAC+B,KAAJ,CAAW,sBAAqBjB,EAAG,OAAM4B,QAAS,EAAlD;;EAEA,IAAI,CAAC5B,EAAL,EAAS;IACP,MAAM,IAAIlB,UAAJ,CAAgB,oCAAmC8C,QAAS,EAA5D,CAAN;EACD;;EAED,OAAO5B,EAAP;AACD;AAGD,OAAO,eAAeyB,iBAAf,CACLvB,SADK,EACcF,EADd,EAEU;EACf,MAAM4B,QAAQ,GAAGvD,IAAI,CAACwD,IAAL,CAAU3B,SAAV,EAAqBT,eAArB,CAAjB;EACA,MAAMnB,EAAE,CAACiE,SAAH,CAAaX,QAAb,EAAuB,CAC3B,+DAD2B,EAE3B,+DAF2B,EAG3B5B,EAAE,CAACiC,QAAH,EAH2B,EAI3BJ,IAJ2B,CAItB,IAJsB,CAAvB,CAAN;EAMA3C,GAAG,CAAC+B,KAAJ,CAAW,2BAA0BjB,EAAG,OAAM4B,QAAS,EAAvD;AACD"}

package/lib/config.js

@@ -0,0 +1,144 @@
+import os from 'os';
+import path from 'path';
+import importFresh from 'import-fresh';
+import camelCase from 'camelcase';
+import decamelize from 'decamelize';
+import fileExists from './util/file-exists.js';
+import { createLogger } from './util/logger.js';
+import { UsageError, WebExtError } from './errors.js';
+const log = createLogger(import.meta.url);
+export function applyConfigToArgv({
+  argv,
+  argvFromCLI,
+  configObject,
+  options,
+  configFileName
+}) {
+  let newArgv = { ...argv
+  };
+
+  for (const option of Object.keys(configObject)) {
+    if (camelCase(option) !== option) {
+      throw new UsageError(`The config option "${option}" must be ` + `specified in camel case: "${camelCase(option)}"`);
+    } // A config option cannot be a sub-command config
+    // object if it is an array.
+
+
+    if (!Array.isArray(configObject[option]) && typeof options[option] === 'object' && typeof configObject[option] === 'object') {
+      // Descend into the nested configuration for a sub-command.
+      newArgv = applyConfigToArgv({
+        argv: newArgv,
+        argvFromCLI,
+        configObject: configObject[option],
+        options: options[option],
+        configFileName
+      });
+      continue;
+    }
+
+    const decamelizedOptName = decamelize(option, {
+      separator: '-'
+    });
+
+    if (typeof options[decamelizedOptName] !== 'object') {
+      throw new UsageError(`The config file at ${configFileName} specified ` + `an unknown option: "${option}"`);
+    }
+
+    if (options[decamelizedOptName].type === undefined) {
+      // This means yargs option type wasn't not defined correctly
+      throw new WebExtError(`Option: ${option} was defined without a type.`);
+    }
+
+    const expectedType = options[decamelizedOptName].type === 'count' ? 'number' : options[decamelizedOptName].type;
+    const optionType = Array.isArray(configObject[option]) ? 'array' : typeof configObject[option];
+
+    if (optionType !== expectedType) {
+      throw new UsageError(`The config file at ${configFileName} specified ` + `the type of "${option}" incorrectly as "${optionType}"` + ` (expected type "${expectedType}")`);
+    }
+
+    let defaultValue;
+
+    if (options[decamelizedOptName]) {
+      if (options[decamelizedOptName].default !== undefined) {
+        defaultValue = options[decamelizedOptName].default;
+      } else if (expectedType === 'boolean') {
+        defaultValue = false;
+      }
+    } // This is our best effort (without patching yargs) to detect
+    // if a value was set on the CLI instead of in the config.
+    // It looks for a default value and if the argv value is
+    // different, it assumes that the value was configured on the CLI.
+
+
+    const wasValueSetOnCLI = typeof argvFromCLI[option] !== 'undefined' && argvFromCLI[option] !== defaultValue;
+
+    if (wasValueSetOnCLI) {
+      log.debug(`Favoring CLI: ${option}=${argvFromCLI[option]} over ` + `configuration: ${option}=${configObject[option]}`);
+      newArgv[option] = argvFromCLI[option];
+      continue;
+    }
+
+    newArgv[option] = configObject[option];
+    const coerce = options[decamelizedOptName].coerce;
+
+    if (coerce) {
+      log.debug(`Calling coerce() on configured value for ${option}`);
+      newArgv[option] = coerce(newArgv[option]);
+    }
+
+    newArgv[decamelizedOptName] = newArgv[option];
+  }
+
+  return newArgv;
+}
+export function loadJSConfigFile(filePath) {
+  const resolvedFilePath = path.resolve(filePath);
+  log.debug(`Loading JS config file: "${filePath}" ` + `(resolved to "${resolvedFilePath}")`);
+  let configObject;
+
+  try {
+    configObject = importFresh(resolvedFilePath);
+  } catch (error) {
+    log.debug('Handling error:', error);
+    throw new UsageError(`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 = {...}?');
+  }
+
+  return configObject;
+}
+export async function discoverConfigFiles({
+  getHomeDir = os.homedir
+} = {}) {
+  const magicConfigName = 'web-ext-config.js'; // Config files will be loaded in this order.
+
+  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)];
+  const configs = await Promise.all(possibleConfigs.map(async fileName => {
+    const resolvedFileName = path.resolve(fileName);
+
+    if (await fileExists(resolvedFileName)) {
+      return resolvedFileName;
+    } else {
+      log.debug(`Discovered config "${resolvedFileName}" does not ` + 'exist or is not readable');
+      return undefined;
+    }
+  }));
+  const existingConfigs = [];
+  configs.forEach(f => {
+    if (typeof f === 'string') {
+      existingConfigs.push(f);
+    }
+  });
+  return existingConfigs;
+}
+//# sourceMappingURL=config.js.map

package/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","names":["os","path","importFresh","camelCase","decamelize","fileExists","createLogger","UsageError","WebExtError","log","import","meta","url","applyConfigToArgv","argv","argvFromCLI","configObject","options","configFileName","newArgv","option","Object","keys","Array","isArray","decamelizedOptName","separator","type","undefined","expectedType","optionType","defaultValue","default","wasValueSetOnCLI","debug","coerce","loadJSConfigFile","filePath","resolvedFilePath","resolve","error","message","endsWith","webExt","length","discoverConfigFiles","getHomeDir","homedir","magicConfigName","possibleConfigs","join","process","cwd","configs","Promise","all","map","fileName","resolvedFileName","existingConfigs","forEach","f","push"],"sources":["../src/config.js"],"sourcesContent":["/* @flow */\nimport os from 'os';\nimport path from 'path';\n\nimport importFresh from 'import-fresh';\nimport camelCase from 'camelcase';\nimport decamelize from 'decamelize';\n\nimport fileExists from './util/file-exists.js';\nimport {createLogger} from './util/logger.js';\nimport {UsageError, WebExtError} from './errors.js';\n\nconst log = createLogger(import.meta.url);\n\ntype ApplyConfigToArgvParams = {|\n  // This is the argv object which will get updated by each\n  // config applied.\n  argv: Object,\n  // This is the argv that only has CLI values applied to it.\n  argvFromCLI: Object,\n  configObject: Object,\n  options: Object,\n  configFileName: string,\n|};\n\nexport function applyConfigToArgv({\n  argv,\n  argvFromCLI,\n  configObject,\n  options,\n  configFileName,\n}: ApplyConfigToArgvParams): Object {\n  let newArgv = {...argv};\n\n  for (const option of Object.keys(configObject)) {\n    if (camelCase(option) !== option) {\n      throw new UsageError(\n        `The config option \"${option}\" must be ` +\n        `specified in camel case: \"${camelCase(option)}\"`);\n    }\n\n    // A config option cannot be a sub-command config\n    // object if it is an array.\n    if (!Array.isArray(configObject[option]) &&\n      typeof options[option] === 'object' &&\n      typeof configObject[option] === 'object') {\n      // Descend into the nested configuration for a sub-command.\n      newArgv = applyConfigToArgv({\n        argv: newArgv,\n        argvFromCLI,\n        configObject: configObject[option],\n        options: options[option],\n        configFileName});\n      continue;\n    }\n\n    const decamelizedOptName = decamelize(option, {separator: '-'});\n\n    if (typeof options[decamelizedOptName] !== 'object') {\n      throw new UsageError(`The config file at ${configFileName} specified ` +\n        `an unknown option: \"${option}\"`);\n    }\n    if (options[decamelizedOptName].type === undefined) {\n      // This means yargs option type wasn't not defined correctly\n      throw new WebExtError(\n        `Option: ${option} was defined without a type.`);\n    }\n\n    const expectedType = options[decamelizedOptName].type ===\n      'count' ? 'number' : options[decamelizedOptName].type;\n\n    const optionType = (\n      Array.isArray(configObject[option]) ?\n        'array' : typeof configObject[option]\n    );\n\n    if (optionType !== expectedType) {\n      throw new UsageError(`The config file at ${configFileName} specified ` +\n        `the type of \"${option}\" incorrectly as \"${optionType}\"` +\n        ` (expected type \"${expectedType}\")`);\n    }\n\n    let defaultValue;\n    if (options[decamelizedOptName]) {\n      if (options[decamelizedOptName].default !== undefined) {\n        defaultValue = options[decamelizedOptName].default;\n      } else if (expectedType === 'boolean') {\n        defaultValue = false;\n      }\n    }\n\n    // This is our best effort (without patching yargs) to detect\n    // if a value was set on the CLI instead of in the config.\n    // It looks for a default value and if the argv value is\n    // different, it assumes that the value was configured on the CLI.\n\n    const wasValueSetOnCLI =\n      typeof argvFromCLI[option] !== 'undefined' &&\n      argvFromCLI[option] !== defaultValue;\n    if (wasValueSetOnCLI) {\n      log.debug(\n        `Favoring CLI: ${option}=${argvFromCLI[option]} over ` +\n        `configuration: ${option}=${configObject[option]}`);\n      newArgv[option] = argvFromCLI[option];\n      continue;\n    }\n\n    newArgv[option] = configObject[option];\n\n    const coerce = options[decamelizedOptName].coerce;\n    if (coerce) {\n      log.debug(\n        `Calling coerce() on configured value for ${option}`);\n      newArgv[option] = coerce(newArgv[option]);\n    }\n\n    newArgv[decamelizedOptName] = newArgv[option];\n  }\n  return newArgv;\n}\n\nexport function loadJSConfigFile(filePath: string): Object {\n  const resolvedFilePath = path.resolve(filePath);\n  log.debug(\n    `Loading JS config file: \"${filePath}\" ` +\n    `(resolved to \"${resolvedFilePath}\")`);\n  let configObject;\n  try {\n    configObject = importFresh(resolvedFilePath);\n  } catch (error) {\n    log.debug('Handling error:', error);\n    throw new UsageError(\n      `Cannot read config file: ${resolvedFilePath}\\n` +\n      `Error: ${error.message}`);\n  }\n  if (filePath.endsWith('package.json')) {\n    log.debug('Looking for webExt key inside package.json file');\n    configObject = configObject.webExt || {};\n  }\n  if (Object.keys(configObject).length === 0) {\n    log.debug(`Config file ${resolvedFilePath} did not define any options. ` +\n      'Did you set module.exports = {...}?');\n  }\n  return configObject;\n}\n\ntype DiscoverConfigFilesParams = {\n  getHomeDir: () => string,\n};\n\nexport async function discoverConfigFiles(\n  {getHomeDir = os.homedir}: DiscoverConfigFilesParams = {}\n): Promise<Array<string>> {\n  const magicConfigName = 'web-ext-config.js';\n\n  // Config files will be loaded in this order.\n  const possibleConfigs = [\n    // Look for a magic hidden config (preceded by dot) in home dir.\n    path.join(getHomeDir(), `.${magicConfigName}`),\n    // Look for webExt key inside package.json file\n    path.join(process.cwd(), 'package.json'),\n    // Look for a magic config in the current working directory.\n    path.join(process.cwd(), magicConfigName),\n  ];\n\n  const configs = await Promise.all(possibleConfigs.map(\n    async (fileName) => {\n      const resolvedFileName = path.resolve(fileName);\n      if (await fileExists(resolvedFileName)) {\n        return resolvedFileName;\n      } else {\n        log.debug(\n          `Discovered config \"${resolvedFileName}\" does not ` +\n          'exist or is not readable');\n        return undefined;\n      }\n    }\n  ));\n\n  const existingConfigs = [];\n  configs.forEach((f) => {\n    if (typeof f === 'string') {\n      existingConfigs.push(f);\n    }\n  });\n  return existingConfigs;\n}\n"],"mappings":"AACA,OAAOA,EAAP,MAAe,IAAf;AACA,OAAOC,IAAP,MAAiB,MAAjB;AAEA,OAAOC,WAAP,MAAwB,cAAxB;AACA,OAAOC,SAAP,MAAsB,WAAtB;AACA,OAAOC,UAAP,MAAuB,YAAvB;AAEA,OAAOC,UAAP,MAAuB,uBAAvB;AACA,SAAQC,YAAR,QAA2B,kBAA3B;AACA,SAAQC,UAAR,EAAoBC,WAApB,QAAsC,aAAtC;AAEA,MAAMC,GAAG,GAAGH,YAAY,CAACI,MAAM,CAACC,IAAP,CAAYC,GAAb,CAAxB;AAaA,OAAO,SAASC,iBAAT,CAA2B;EAChCC,IADgC;EAEhCC,WAFgC;EAGhCC,YAHgC;EAIhCC,OAJgC;EAKhCC;AALgC,CAA3B,EAM6B;EAClC,IAAIC,OAAO,GAAG,EAAC,GAAGL;EAAJ,CAAd;;EAEA,KAAK,MAAMM,MAAX,IAAqBC,MAAM,CAACC,IAAP,CAAYN,YAAZ,CAArB,EAAgD;IAC9C,IAAIb,SAAS,CAACiB,MAAD,CAAT,KAAsBA,MAA1B,EAAkC;MAChC,MAAM,IAAIb,UAAJ,CACH,sBAAqBa,MAAO,YAA7B,GACC,6BAA4BjB,SAAS,CAACiB,MAAD,CAAS,GAF3C,CAAN;IAGD,CAL6C,CAO9C;IACA;;;IACA,IAAI,CAACG,KAAK,CAACC,OAAN,CAAcR,YAAY,CAACI,MAAD,CAA1B,CAAD,IACF,OAAOH,OAAO,CAACG,MAAD,CAAd,KAA2B,QADzB,IAEF,OAAOJ,YAAY,CAACI,MAAD,CAAnB,KAAgC,QAFlC,EAE4C;MAC1C;MACAD,OAAO,GAAGN,iBAAiB,CAAC;QAC1BC,IAAI,EAAEK,OADoB;QAE1BJ,WAF0B;QAG1BC,YAAY,EAAEA,YAAY,CAACI,MAAD,CAHA;QAI1BH,OAAO,EAAEA,OAAO,CAACG,MAAD,CAJU;QAK1BF;MAL0B,CAAD,CAA3B;MAMA;IACD;;IAED,MAAMO,kBAAkB,GAAGrB,UAAU,CAACgB,MAAD,EAAS;MAACM,SAAS,EAAE;IAAZ,CAAT,CAArC;;IAEA,IAAI,OAAOT,OAAO,CAACQ,kBAAD,CAAd,KAAuC,QAA3C,EAAqD;MACnD,MAAM,IAAIlB,UAAJ,CAAgB,sBAAqBW,cAAe,aAArC,GAClB,uBAAsBE,MAAO,GAD1B,CAAN;IAED;;IACD,IAAIH,OAAO,CAACQ,kBAAD,CAAP,CAA4BE,IAA5B,KAAqCC,SAAzC,EAAoD;MAClD;MACA,MAAM,IAAIpB,WAAJ,CACH,WAAUY,MAAO,8BADd,CAAN;IAED;;IAED,MAAMS,YAAY,GAAGZ,OAAO,CAACQ,kBAAD,CAAP,CAA4BE,IAA5B,KACnB,OADmB,GACT,QADS,GACEV,OAAO,CAACQ,kBAAD,CAAP,CAA4BE,IADnD;IAGA,MAAMG,UAAU,GACdP,KAAK,CAACC,OAAN,CAAcR,YAAY,CAACI,MAAD,CAA1B,IACE,OADF,GACY,OAAOJ,YAAY,CAACI,MAAD,CAFjC;;IAKA,IAAIU,UAAU,KAAKD,YAAnB,EAAiC;MAC/B,MAAM,IAAItB,UAAJ,CAAgB,sBAAqBW,cAAe,aAArC,GAClB,gBAAeE,MAAO,qBAAoBU,UAAW,GADnC,GAElB,oBAAmBD,YAAa,IAF7B,CAAN;IAGD;;IAED,IAAIE,YAAJ;;IACA,IAAId,OAAO,CAACQ,kBAAD,CAAX,EAAiC;MAC/B,IAAIR,OAAO,CAACQ,kBAAD,CAAP,CAA4BO,OAA5B,KAAwCJ,SAA5C,EAAuD;QACrDG,YAAY,GAAGd,OAAO,CAACQ,kBAAD,CAAP,CAA4BO,OAA3C;MACD,CAFD,MAEO,IAAIH,YAAY,KAAK,SAArB,EAAgC;QACrCE,YAAY,GAAG,KAAf;MACD;IACF,CAvD6C,CAyD9C;IACA;IACA;IACA;;;IAEA,MAAME,gBAAgB,GACpB,OAAOlB,WAAW,CAACK,MAAD,CAAlB,KAA+B,WAA/B,IACAL,WAAW,CAACK,MAAD,CAAX,KAAwBW,YAF1B;;IAGA,IAAIE,gBAAJ,EAAsB;MACpBxB,GAAG,CAACyB,KAAJ,CACG,iBAAgBd,MAAO,IAAGL,WAAW,CAACK,MAAD,CAAS,QAA/C,GACC,kBAAiBA,MAAO,IAAGJ,YAAY,CAACI,MAAD,CAAS,EAFnD;MAGAD,OAAO,CAACC,MAAD,CAAP,GAAkBL,WAAW,CAACK,MAAD,CAA7B;MACA;IACD;;IAEDD,OAAO,CAACC,MAAD,CAAP,GAAkBJ,YAAY,CAACI,MAAD,CAA9B;IAEA,MAAMe,MAAM,GAAGlB,OAAO,CAACQ,kBAAD,CAAP,CAA4BU,MAA3C;;IACA,IAAIA,MAAJ,EAAY;MACV1B,GAAG,CAACyB,KAAJ,CACG,4CAA2Cd,MAAO,EADrD;MAEAD,OAAO,CAACC,MAAD,CAAP,GAAkBe,MAAM,CAAChB,OAAO,CAACC,MAAD,CAAR,CAAxB;IACD;;IAEDD,OAAO,CAACM,kBAAD,CAAP,GAA8BN,OAAO,CAACC,MAAD,CAArC;EACD;;EACD,OAAOD,OAAP;AACD;AAED,OAAO,SAASiB,gBAAT,CAA0BC,QAA1B,EAAoD;EACzD,MAAMC,gBAAgB,GAAGrC,IAAI,CAACsC,OAAL,CAAaF,QAAb,CAAzB;EACA5B,GAAG,CAACyB,KAAJ,CACG,4BAA2BG,QAAS,IAArC,GACC,iBAAgBC,gBAAiB,IAFpC;EAGA,IAAItB,YAAJ;;EACA,IAAI;IACFA,YAAY,GAAGd,WAAW,CAACoC,gBAAD,CAA1B;EACD,CAFD,CAEE,OAAOE,KAAP,EAAc;IACd/B,GAAG,CAACyB,KAAJ,CAAU,iBAAV,EAA6BM,KAA7B;IACA,MAAM,IAAIjC,UAAJ,CACH,4BAA2B+B,gBAAiB,IAA7C,GACC,UAASE,KAAK,CAACC,OAAQ,EAFpB,CAAN;EAGD;;EACD,IAAIJ,QAAQ,CAACK,QAAT,CAAkB,cAAlB,CAAJ,EAAuC;IACrCjC,GAAG,CAACyB,KAAJ,CAAU,iDAAV;IACAlB,YAAY,GAAGA,YAAY,CAAC2B,MAAb,IAAuB,EAAtC;EACD;;EACD,IAAItB,MAAM,CAACC,IAAP,CAAYN,YAAZ,EAA0B4B,MAA1B,KAAqC,CAAzC,EAA4C;IAC1CnC,GAAG,CAACyB,KAAJ,CAAW,eAAcI,gBAAiB,+BAAhC,GACR,qCADF;EAED;;EACD,OAAOtB,YAAP;AACD;AAMD,OAAO,eAAe6B,mBAAf,CACL;EAACC,UAAU,GAAG9C,EAAE,CAAC+C;AAAjB,IAAuD,EADlD,EAEmB;EACxB,MAAMC,eAAe,GAAG,mBAAxB,CADwB,CAGxB;;EACA,MAAMC,eAAe,GAAG,CACtB;EACAhD,IAAI,CAACiD,IAAL,CAAUJ,UAAU,EAApB,EAAyB,IAAGE,eAAgB,EAA5C,CAFsB,EAGtB;EACA/C,IAAI,CAACiD,IAAL,CAAUC,OAAO,CAACC,GAAR,EAAV,EAAyB,cAAzB,CAJsB,EAKtB;EACAnD,IAAI,CAACiD,IAAL,CAAUC,OAAO,CAACC,GAAR,EAAV,EAAyBJ,eAAzB,CANsB,CAAxB;EASA,MAAMK,OAAO,GAAG,MAAMC,OAAO,CAACC,GAAR,CAAYN,eAAe,CAACO,GAAhB,CAChC,MAAOC,QAAP,IAAoB;IAClB,MAAMC,gBAAgB,GAAGzD,IAAI,CAACsC,OAAL,CAAakB,QAAb,CAAzB;;IACA,IAAI,MAAMpD,UAAU,CAACqD,gBAAD,CAApB,EAAwC;MACtC,OAAOA,gBAAP;IACD,CAFD,MAEO;MACLjD,GAAG,CAACyB,KAAJ,CACG,sBAAqBwB,gBAAiB,aAAvC,GACA,0BAFF;MAGA,OAAO9B,SAAP;IACD;EACF,CAX+B,CAAZ,CAAtB;EAcA,MAAM+B,eAAe,GAAG,EAAxB;EACAN,OAAO,CAACO,OAAR,CAAiBC,CAAD,IAAO;IACrB,IAAI,OAAOA,CAAP,KAAa,QAAjB,EAA2B;MACzBF,eAAe,CAACG,IAAhB,CAAqBD,CAArB;IACD;EACF,CAJD;EAKA,OAAOF,eAAP;AACD"}