extension 2.0.0-beta.2 → 2.0.0-beta.3

package/README.md

@@ -52,7 +52,7 @@ https://github.com/cezaraugusto/extension/assets/4672033/7263d368-99c4-434f-a60a
 
 ## Web Standards and Modern JavaScript Support
 
-For a preview of extensions running these technologies, see documentation about [Templates](https://extension.js.org/n/getting-started/templates/).
+For a preview of extensions running these technologies, see documentation about [Templates](https://extension.js.org/docs/getting-started/templates).
 
 | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/a9e2541a-96f0-4caa-9fc9-5fc5c3e901c8" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/b42c5330-9e2a-4045-99c3-1f7d264dfaf4" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/f19edff3-9005-4f50-b05c-fba615896a7f" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/ff64721d-d145-4213-930d-e70193f8d57e" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/15f1314a-aa65-4ce2-a3f3-cf53c4f730cf" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/c5f8a127-3c2a-4ceb-bb46-948cf2c8bd89" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/de1082fd-7cf6-4202-8c12-a5c3cd3e5b42" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/78e5fe3d-dc79-4aa2-954e-1a5973d1d9db" width="70"> | <img src="https://github.com/cezaraugusto/extension.js/assets/4672033/8807efd9-93e5-4db5-a1d2-9ac524f7ecc2" width="70"> |
 | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: |

package/dist/cli.js

@@ -117,7 +117,7 @@ var package_default = {
     node: ">=18"
   },
   name: "extension",
-  version: "2.0.0-beta.2",
+  version: "2.0.0-beta.3",
   description: "Create cross-browser extensions with no build configuration.",
   main: "./dist/cli.js",
   types: "./dist/cli.d.ts",
@@ -188,8 +188,8 @@ var package_default = {
 // cli.ts
 checkUpdates2(package_default);
 var extensionJs = import_commander.program;
-extensionJs.name(package_default.name).description(package_default.description).version(package_default.version).addHelpText("after", programHelp());
 var vendors = (browser) => browser === "all" ? "chrome,edge,firefox".split(",") : browser.split(",");
+extensionJs.name(package_default.name).description(package_default.description).version(package_default.version).addHelpText("after", programHelp());
 extensionJs.command("create").arguments("<project-name|project-path>").usage("create <project-name|project-path> [options]").description("Creates a new extension.").option(
   "-t, --template <template-name>",
   "specify a template for the created project"
@@ -203,14 +203,11 @@ extensionJs.command("create").arguments("<project-name|project-path>").usage("cr
   });
 });
 extensionJs.command("dev").arguments("[project-path|remote-url]").usage("dev [project-path|remote-url] [options]").description("Starts the development server (development mode)").option(
-  "-u, --user-data-dir <path-to-file | boolean>",
-  '[DEPRECATED - Use "--profile" instead] what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile'
-).option(
   "--profile <path-to-file | boolean>",
   "what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile"
 ).option(
-  "-b, --browser <chrome | edge | firefox>",
-  "specify a browser to run your extension in development mode"
+  "--browser <chrome | edge | firefox>",
+  "specify a browser to preview your extension in production mode. Defaults to `chrome`"
 ).option(
   "--chromium-binary <path-to-binary>",
   "specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default"
@@ -219,27 +216,37 @@ extensionJs.command("dev").arguments("[project-path|remote-url]").usage("dev [pr
   "specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default"
 ).option(
   "--polyfill [boolean]",
-  "whether or not to apply the cross-browser polyfill. Defaults to `true`"
+  "whether or not to apply the cross-browser polyfill. Defaults to `false`"
 ).option(
-  "-p, --port <number>",
-  "what port should Extension.js WebSocket server run. Defaults to `8000`"
+  "--open [boolean]",
+  "whether or not to open the browser automatically. Defaults to `true`"
+).option(
+  "--starting-url <url>",
+  "specify the starting URL for the browser. Defaults to `undefined`"
 ).action(async function(pathOrRemoteUrl, { browser = "chrome", ...devOptions }) {
   for (const vendor of vendors(browser)) {
     await (0, import_extension_develop.extensionDev)(pathOrRemoteUrl, {
+      ...devOptions,
+      profile: devOptions.profile,
       browser: vendor,
-      ...devOptions
+      chromiumBinary: devOptions.chromiumBinary,
+      geckoBinary: devOptions.geckoBinary,
+      // @ts-expect-error open is a boolean
+      polyfill: devOptions.polyfill === "false" ? false : true,
+      open: devOptions.open,
+      startingUrl: devOptions.startingUrl
     });
   }
 });
 extensionJs.command("start").arguments("[project-path|remote-url]").usage("start [project-path|remote-url] [options]").description("Starts the development server (production mode)").option(
-  "-u, --user-data-dir <path-to-file | boolean>",
-  '[DEPRECATED - Use "--profile" instead] what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile'
-).option(
   "--profile <path-to-file | boolean>",
   "what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile"
 ).option(
-  "-b, --browser <chrome | edge | firefox>",
-  "specify a browser to run your extension in development mode"
+  "--browser <chrome | edge | firefox>",
+  "specify a browser to preview your extension in production mode. Defaults to `chrome`"
+).option(
+  "--polyfill [boolean]",
+  "whether or not to apply the cross-browser polyfill. Defaults to `true`"
 ).option(
   "--chromium-binary <path-to-binary>",
   "specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default"
@@ -247,40 +254,50 @@ extensionJs.command("start").arguments("[project-path|remote-url]").usage("start
   "--gecko-binary <path-to-binary>",
   "specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default"
 ).option(
-  "--polyfill [boolean]",
-  "whether or not to apply the cross-browser polyfill. Defaults to `true`"
-).option(
-  "-p, --port <number>",
-  "what port should Extension.js run. Defaults to `3000`"
+  "--starting-url <url>",
+  "specify the starting URL for the browser. Defaults to `undefined`"
 ).action(async function(pathOrRemoteUrl, { browser = "chrome", ...startOptions }) {
   for (const vendor of vendors(browser)) {
     await (0, import_extension_develop.extensionStart)(pathOrRemoteUrl, {
+      mode: "production",
+      profile: startOptions.profile,
       browser: vendor,
-      ...startOptions
+      chromiumBinary: startOptions.chromiumBinary,
+      geckoBinary: startOptions.geckoBinary,
+      startingUrl: startOptions.startingUrl
     });
   }
 });
-extensionJs.command("preview").arguments("[project-name]").usage("preview [path-to-remote-extension] [options]").description("Builds the extension for production").option(
+extensionJs.command("preview").arguments("[project-name]").usage("preview [path-to-remote-extension] [options]").description("Preview the extension in production mode").option(
+  "--profile <path-to-file | boolean>",
+  "what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile"
+).option(
+  "--browser <chrome | edge | firefox>",
+  "specify a browser to preview your extension in production mode. Defaults to `chrome`"
+).option(
   "--chromium-binary <path-to-binary>",
   "specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default"
 ).option(
   "--gecko-binary <path-to-binary>",
   "specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default"
 ).option(
-  "-b, --browser <chrome | edge | firefox>",
-  "specify a browser to preview your extension in production mode"
+  "--starting-url <url>",
+  "specify the starting URL for the browser. Defaults to `undefined`"
 ).action(async function(pathOrRemoteUrl, { browser = "chrome", ...previewOptions }) {
   for (const vendor of vendors(browser)) {
     await (0, import_extension_develop.extensionPreview)(pathOrRemoteUrl, {
       mode: "production",
+      profile: previewOptions.profile,
       browser: vendor,
-      ...previewOptions
+      chromiumBinary: previewOptions.chromiumBinary,
+      geckoBinary: previewOptions.geckoBinary,
+      startingUrl: previewOptions.startingUrl
     });
   }
 });
 extensionJs.command("build").arguments("[project-name]").usage("build [path-to-remote-extension] [options]").description("Builds the extension for production").option(
-  "-b, --browser <chrome | edge | firefox>",
-  "specify a browser to run your extension in development mode"
+  "--browser <chrome | edge | firefox>",
+  "specify a browser to preview your extension in production mode. Defaults to `chrome`"
 ).option(
   "--polyfill [boolean]",
   "whether or not to apply the cross-browser polyfill. Defaults to `false`"
@@ -293,11 +310,18 @@ extensionJs.command("build").arguments("[project-name]").usage("build [path-to-r
 ).option(
   "--zip-filename <string>",
   "specify the name of the ZIP file. Defaults to the extension name and version"
+).option(
+  "--silent [boolean]",
+  "whether or not to open the browser automatically. Defaults to `false`"
 ).action(async function(pathOrRemoteUrl, { browser = "chrome", ...buildOptions }) {
   for (const vendor of vendors(browser)) {
     await (0, import_extension_develop.extensionBuild)(pathOrRemoteUrl, {
       browser: vendor,
-      ...buildOptions
+      polyfill: buildOptions.polyfill,
+      zip: buildOptions.zip,
+      zipSource: buildOptions.zipSource,
+      zipFilename: buildOptions.zipFilename,
+      silent: buildOptions.silent
     });
   }
 });

package/package.json

@@ -9,7 +9,7 @@
     "node": ">=18"
   },
   "name": "extension",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "Create cross-browser extensions with no build configuration.",
   "main": "./dist/cli.js",
   "types": "./dist/cli.d.ts",
@@ -49,8 +49,8 @@
     "semver": "^7.5.4",
     "update-check": "^1.5.4",
     "webextension-polyfill": "^0.12.0",
-    "extension-create": "2.0.0-beta.2",
-    "extension-develop": "2.0.0-beta.2"
+    "extension-create": "2.0.0-beta.3",
+    "extension-develop": "2.0.0-beta.3"
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",