web-ext 6.7.0 → 7.1.0

package/src/cmd/build.js

@@ -1,319 +0,0 @@
-/* @flow */
-import path from 'path';
-import {createWriteStream} from 'fs';
-
-import {fs} from 'mz';
-import parseJSON from 'parse-json';
-import stripBom from 'strip-bom';
-import stripJsonComments from 'strip-json-comments';
-import defaultEventToPromise from 'event-to-promise';
-import zipDir from 'zip-dir';
-
-import defaultSourceWatcher from '../watcher';
-import getValidatedManifest, {getManifestId} from '../util/manifest';
-import {prepareArtifactsDir} from '../util/artifacts';
-import {createLogger} from '../util/logger';
-import {UsageError, isErrorWithCode} from '../errors';
-import {
-  createFileFilter as defaultFileFilterCreator,
-  FileFilter,
-} from '../util/file-filter';
-// Import flow types.
-import type {OnSourceChangeFn} from '../watcher';
-import type {ExtensionManifest} from '../util/manifest';
-import type {FileFilterCreatorFn} from '../util/file-filter';
-
-const log = createLogger(__filename);
-const DEFAULT_FILENAME_TEMPLATE = '{name}-{version}.zip';
-
-
-export function safeFileName(name: string): string {
-  return name.toLowerCase().replace(/[^a-z0-9.-]+/g, '_');
-}
-
-
-// defaultPackageCreator types and implementation.
-
-export type ExtensionBuildResult = {|
-  extensionPath: string,
-|};
-
-export type PackageCreatorParams = {|
-  manifestData?: ExtensionManifest,
-  sourceDir: string,
-  fileFilter: FileFilter,
-  artifactsDir: string,
-  overwriteDest: boolean,
-  showReadyMessage: boolean,
-  filename?: string,
-|};
-
-export type LocalizedNameParams = {|
-  messageFile: string,
-  manifestData: ExtensionManifest,
-|}
-
-export type PackageCreatorOptions = {|
-  eventToPromise: typeof defaultEventToPromise,
-|};
-
-// This defines the _locales/messages.json type. See:
-// https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Internationalization#Providing_localized_strings_in__locales
-type LocalizedMessageData = {|
-  [messageName: string]: {|
-    description: string,
-    message: string,
-  |},
-|}
-
-export async function getDefaultLocalizedName(
-  {messageFile, manifestData}: LocalizedNameParams
-): Promise<string> {
-
-  let messageData: LocalizedMessageData;
-  let messageContents: string | Buffer;
-  let extensionName: string = manifestData.name;
-
-  try {
-    messageContents = await fs.readFile(messageFile, {encoding: 'utf-8'});
-  } catch (error) {
-    throw new UsageError(
-      `Error reading messages.json file at ${messageFile}: ${error}`);
-  }
-
-  messageContents = stripBom(messageContents);
-
-  try {
-    messageData = parseJSON(stripJsonComments(messageContents));
-  } catch (error) {
-    throw new UsageError(
-      `Error parsing messages.json file at ${messageFile}: ${error}`);
-  }
-
-  extensionName = manifestData.name.replace(
-    /__MSG_([A-Za-z0-9@_]+?)__/g,
-    (match, messageName) => {
-      if (!(messageData[messageName]
-            && messageData[messageName].message)) {
-        const error = new UsageError(
-          `The locale file ${messageFile} ` +
-            `is missing key: ${messageName}`);
-        throw error;
-      } else {
-        return messageData[messageName].message;
-      }
-    });
-  return Promise.resolve(extensionName);
-}
-
-// https://stackoverflow.com/a/22129960
-export function getStringPropertyValue(
-  prop: string,
-  obj: Object,
-): string {
-  const properties = prop.split('.');
-  const value = properties.reduce((prev, curr) => prev && prev[curr], obj);
-  if (!['string', 'number'].includes(typeof value)) {
-    throw new UsageError(
-      `Manifest key "${prop}" is missing or has an invalid type: ${value}`
-    );
-  }
-  const stringValue = `${value}`;
-  if (!stringValue.length) {
-    throw new UsageError(`Manifest key "${prop}" value is an empty string`);
-  }
-  return stringValue;
-}
-
-function getPackageNameFromTemplate(
-  filenameTemplate: string,
-  manifestData: ExtensionManifest
-): string {
-  const packageName = filenameTemplate.replace(
-    /{([A-Za-z0-9._]+?)}/g,
-    (match, manifestProperty) => {
-      return safeFileName(
-        getStringPropertyValue(manifestProperty, manifestData));
-    }
-  );
-
-  // Validate the resulting packageName string, after interpolating the manifest property
-  // specified in the template string.
-  const parsed = path.parse(packageName);
-  if (parsed.dir) {
-    throw new UsageError(
-      `Invalid filename template "${filenameTemplate}". ` +
-      `Filename "${packageName}" should not contain a path`
-    );
-  }
-  if (!['.zip', '.xpi'].includes(parsed.ext)) {
-    throw new UsageError(
-      `Invalid filename template "${filenameTemplate}". ` +
-      `Filename "${packageName}" should have a zip or xpi extension`
-    );
-  }
-
-  return packageName;
-}
-
-export type PackageCreatorFn =
-    (params: PackageCreatorParams) => Promise<ExtensionBuildResult>;
-
-export async function defaultPackageCreator(
-  {
-    manifestData,
-    sourceDir,
-    fileFilter,
-    artifactsDir,
-    overwriteDest,
-    showReadyMessage,
-    filename = DEFAULT_FILENAME_TEMPLATE,
-  }: PackageCreatorParams,
-  {
-    eventToPromise = defaultEventToPromise,
-  }: PackageCreatorOptions = {}
-): Promise<ExtensionBuildResult> {
-  let id;
-  if (manifestData) {
-    id = getManifestId(manifestData);
-    log.debug(`Using manifest id=${id || '[not specified]'}`);
-  } else {
-    manifestData = await getValidatedManifest(sourceDir);
-  }
-
-  const buffer = await zipDir(sourceDir, {
-    filter: (...args) => fileFilter.wantFile(...args),
-  });
-
-  let filenameTemplate = filename;
-
-  let {default_locale} = manifestData;
-  if (default_locale) {
-    default_locale = default_locale.replace(/-/g, '_');
-    const messageFile = path.join(
-      sourceDir, '_locales',
-      default_locale, 'messages.json'
-    );
-    log.debug('Manifest declared default_locale, localizing extension name');
-    const extensionName = await getDefaultLocalizedName({
-      messageFile, manifestData,
-    });
-    // allow for a localized `{name}`, without mutating `manifestData`
-    filenameTemplate = filenameTemplate.replace(/{name}/g, extensionName);
-  }
-
-  const packageName = safeFileName(
-    getPackageNameFromTemplate(filenameTemplate, manifestData)
-  );
-  const extensionPath = path.join(artifactsDir, packageName);
-
-  // Added 'wx' flags to avoid overwriting of existing package.
-  const stream = createWriteStream(extensionPath, {flags: 'wx'});
-
-  stream.write(buffer, () => {
-    stream.end();
-  });
-
-  try {
-    await eventToPromise(stream, 'close');
-  } catch (error) {
-    if (!isErrorWithCode('EEXIST', error)) {
-      throw error;
-    }
-    if (!overwriteDest) {
-      throw new UsageError(
-        `Extension exists at the destination path: ${extensionPath}\n` +
-        'Use --overwrite-dest to enable overwriting.');
-    }
-    log.info(`Destination exists, overwriting: ${extensionPath}`);
-    const overwriteStream = createWriteStream(extensionPath);
-    overwriteStream.write(buffer, () => {
-      overwriteStream.end();
-    });
-    await eventToPromise(overwriteStream, 'close');
-  }
-
-  if (showReadyMessage) {
-    log.info(`Your web extension is ready: ${extensionPath}`);
-  }
-  return {extensionPath};
-}
-
-
-// Build command types and implementation.
-
-export type BuildCmdParams = {|
-  sourceDir: string,
-  artifactsDir: string,
-  asNeeded?: boolean,
-  overwriteDest?: boolean,
-  ignoreFiles?: Array<string>,
-  filename?: string,
-|};
-
-export type BuildCmdOptions = {|
-  manifestData?: ExtensionManifest,
-  fileFilter?: FileFilter,
-  onSourceChange?: OnSourceChangeFn,
-  packageCreator?: PackageCreatorFn,
-  showReadyMessage?: boolean,
-  createFileFilter?: FileFilterCreatorFn,
-  shouldExitProgram?: boolean,
-|};
-
-export default async function build(
-  {
-    sourceDir,
-    artifactsDir,
-    asNeeded = false,
-    overwriteDest = false,
-    ignoreFiles = [],
-    filename = DEFAULT_FILENAME_TEMPLATE,
-  }: BuildCmdParams,
-  {
-    manifestData,
-    createFileFilter = defaultFileFilterCreator,
-    fileFilter = createFileFilter({
-      sourceDir,
-      artifactsDir,
-      ignoreFiles,
-    }),
-    onSourceChange = defaultSourceWatcher,
-    packageCreator = defaultPackageCreator,
-    showReadyMessage = true,
-  }: BuildCmdOptions = {}
-): Promise<ExtensionBuildResult> {
-
-  const rebuildAsNeeded = asNeeded; // alias for `build --as-needed`
-  log.info(`Building web extension from ${sourceDir}`);
-
-  const createPackage = () => packageCreator({
-    manifestData,
-    sourceDir,
-    fileFilter,
-    artifactsDir,
-    overwriteDest,
-    showReadyMessage,
-    filename,
-  });
-
-  await prepareArtifactsDir(artifactsDir);
-  const result = await createPackage();
-
-  if (rebuildAsNeeded) {
-    log.info('Rebuilding when files change...');
-    onSourceChange({
-      sourceDir,
-      artifactsDir,
-      onChange: () => {
-        return createPackage().catch((error) => {
-          log.error(error.stack);
-          throw error;
-        });
-      },
-      shouldWatchFile: (...args) => fileFilter.wantFile(...args),
-    });
-  }
-
-  return result;
-}

package/src/cmd/docs.js

@@ -1,33 +0,0 @@
-/* @flow */
-import open from 'open';
-
-import {createLogger} from '../util/logger';
-
-const log = createLogger(__filename);
-
-export type DocsParams = {
-  noInput?: boolean,
-  shouldExitProgram?: boolean,
-}
-
-export type DocsOptions = {
-  openUrl?: typeof open,
-}
-
-// eslint-disable-next-line max-len
-export const url = 'https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/';
-
-export default function docs(
-  params: DocsParams, {openUrl = open}: DocsOptions = {}
-): Promise<void> {
-  return new Promise((resolve, reject) => {
-    openUrl(url, (error) => {
-      if (error) {
-        log.debug(`Encountered an error while opening URL ${url}`, error);
-        reject(error);
-      } else {
-        resolve();
-      }
-    });
-  });
-}

package/src/cmd/index.js

@@ -1,57 +0,0 @@
-/* @flow */
-
-import type {
-  BuildCmdParams, BuildCmdOptions, ExtensionBuildResult,
-} from './build';
-import type {LintCmdParams, LintCmdOptions} from './lint';
-import type {CmdRunParams, CmdRunOptions} from './run';
-import type {MultiExtensionRunner} from '../extension-runners';
-import type {SignParams, SignOptions, SignResult} from './sign';
-import type {DocsParams, DocsOptions} from './docs';
-
-// This module exports entry points for all supported commands. For performance
-// reasons (faster start-up), the implementations are not statically imported
-// at the top of the file, but lazily loaded in the (exported) functions.
-// The latter would slow down start-up by several seconds, as seen in #1302 .
-
-async function build(
-  params: BuildCmdParams, options: BuildCmdOptions
-): Promise<ExtensionBuildResult> {
-  // TODO: use async import instead of require - https://github.com/mozilla/web-ext/issues/1306
-  const {default: runCommand} = require('./build');
-  return runCommand(params, options);
-}
-
-async function lint(
-  params: LintCmdParams, options: LintCmdOptions
-): Promise<void> {
-  // TODO: use async import instead of require - https://github.com/mozilla/web-ext/issues/1306
-  const {default: runCommand} = require('./lint');
-  return runCommand(params, options);
-}
-
-async function run(
-  params: CmdRunParams, options: CmdRunOptions
-): Promise<MultiExtensionRunner> {
-  // TODO: use async import instead of require - https://github.com/mozilla/web-ext/issues/1306
-  const {default: runCommand} = require('./run');
-  return runCommand(params, options);
-}
-
-async function sign(
-  params: SignParams, options: SignOptions
-): Promise<SignResult> {
-  // TODO: use async import instead of require - https://github.com/mozilla/web-ext/issues/1306
-  const {default: runCommand} = require('./sign');
-  return runCommand(params, options);
-}
-
-async function docs(
-  params: DocsParams, options: DocsOptions
-): Promise<void> {
-  // TODO: use async import instead of require - https://github.com/mozilla/web-ext/issues/1306
-  const {default: runCommand} = require('./docs');
-  return runCommand(params, options);
-}
-
-export default {build, lint, run, sign, docs};

package/src/cmd/lint.js

@@ -1,102 +0,0 @@
-/* @flow */
-import {createInstance as defaultLinterCreator} from 'addons-linter';
-
-import {createLogger} from '../util/logger';
-import {
-  createFileFilter as defaultFileFilterCreator,
-} from '../util/file-filter';
-// import flow types
-import type {FileFilterCreatorFn} from '../util/file-filter';
-
-const log = createLogger(__filename);
-
-
-// Define the needed 'addons-linter' module flow types.
-
-export type LinterOutputType = 'text' | 'json';
-
-export type LinterCreatorParams = {|
-  config: {|
-    logLevel: 'debug' | 'fatal',
-    stack: boolean,
-    pretty?: boolean,
-    warningsAsErrors?: boolean,
-    metadata?: boolean,
-    output?: LinterOutputType,
-    boring?: boolean,
-    selfHosted?: boolean,
-    shouldScanFile: (fileName: string) => boolean,
-    _: Array<string>,
-  |},
-  runAsBinary: boolean,
-|};
-
-export type Linter = {|
-  run: () => Promise<void>,
-|};
-
-export type LinterCreatorFn = (params: LinterCreatorParams) => Linter;
-
-
-// Lint command types and implementation.
-
-export type LintCmdParams = {|
-  artifactsDir?: string,
-  boring?: boolean,
-  ignoreFiles?: Array<string>,
-  metadata?: boolean,
-  output?: LinterOutputType,
-  pretty?: boolean,
-  selfHosted?: boolean,
-  sourceDir: string,
-  verbose?: boolean,
-  warningsAsErrors?: boolean,
-|};
-
-export type LintCmdOptions = {|
-  createLinter?: LinterCreatorFn,
-  createFileFilter?: FileFilterCreatorFn,
-  shouldExitProgram?: boolean,
-|};
-
-export default function lint(
-  {
-    artifactsDir,
-    boring,
-    ignoreFiles,
-    metadata,
-    output,
-    pretty,
-    sourceDir,
-    selfHosted,
-    verbose,
-    warningsAsErrors,
-  }: LintCmdParams,
-  {
-    createLinter = defaultLinterCreator,
-    createFileFilter = defaultFileFilterCreator,
-    shouldExitProgram = true,
-  }: LintCmdOptions = {}
-): Promise<void> {
-  const fileFilter = createFileFilter({sourceDir, ignoreFiles, artifactsDir});
-
-  log.debug(`Running addons-linter on ${sourceDir}`);
-  const linter = createLinter({
-    config: {
-      logLevel: verbose ? 'debug' : 'fatal',
-      stack: Boolean(verbose),
-      pretty,
-      warningsAsErrors,
-      metadata,
-      output,
-      boring,
-      selfHosted,
-      shouldScanFile: (fileName) => fileFilter.wantFile(fileName),
-      // This mimics the first command line argument from yargs,
-      // which should be the directory to the extension.
-      _: [sourceDir],
-    },
-    runAsBinary: shouldExitProgram,
-  });
-  return linter.run();
-}