extension 2.0.0-alpha.3 → 2.0.0-alpha.30

package/README.md

@@ -1,5 +1,5 @@
-[action-image]: https://github.com/cezaraugusto/extension/actions/workflows/cli.yml/badge.svg?branch=main
-[action-url]: https://github.com/cezaraugusto/extension/actions
+[action-image]: https://github.com/extension-js/extension.js/actions/workflows/ci.yml/badge.svg?branch=main
+[action-url]: https://github.com/extension-js/extension.js/actions
 [npm-image]: https://img.shields.io/npm/v/extension.svg
 [npm-url]: https://npmjs.org/package/extension
 [downloads-image]: https://img.shields.io/npm/dm/extension.svg
@@ -7,14 +7,15 @@
 [node]: https://img.shields.io/node/v/extension.svg
 [node-url]: https://nodejs.org
 [prs]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
-[prs-url]: https://github.com/cezaraugusto/extension/blob/main/CONTRIBUTING.md
-[vunlerabilities]: https://snyk.io/test/github/cezaraugusto/extension/badge.svg
+[prs-url]: https://github.com/extension-js/extension/blob/main/CONTRIBUTING.md
+[snyk-image]: https://snyk.io/test/github/extension-js/extension/badge.svg
+[snyk-url]: https://snyk.io/test/github/extension-js/extension
 [fossa-image]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcezaraugusto%2Fextension.svg?type=shield&issueType=license
 [fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fcezaraugusto%2Fextension?ref=badge_shield&issueType=license
 [discord-image]: https://img.shields.io/discord/1253608412890271755?label=Discord&logo=discord&style=flat
 [discord-url]: https://discord.gg/1253608412890271755
 
-# Extension.js [![fossa][fossa-image]][fossa-url] [![vunlerabilities][vunlerabilities]][vunlerabilities] [![workflow][action-image]][action-url] [![discord][discord-image]][discord-url]
+# Extension.js [![fossa][fossa-image]][fossa-url] [![Known Vulnerabilities][snyk-image]][snyk-url] [![workflow][action-image]][action-url] [![discord][discord-image]][discord-url]
 
 <!-- > Plug-and-play, zero-config, cross-browser extension development tool. -->
 
@@ -27,7 +28,7 @@
 
 <!-- **Create cross-browser extensions with no build configuration.** -->
 
-> Create cross-browser extensions with no build configuration.
+> Plug-and-play, zero-config, cross-browser extension development tool.
 
 - [Create A New Extension](#create-a-new-extension) — How to create a new extension.
 - [Get Started Immediately](#get-started-immediately) — Get work done in no time.

package/dist/cli.d.ts

@@ -1 +1,2 @@
 #!/usr/bin/env node
+export { FileConfig, Manifest } from 'extension-develop';

package/dist/cli.js

@@ -22,8 +22,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // cli.ts
+var cli_exports = {};
+module.exports = __toCommonJS(cli_exports);
 var import_commander = require("commander");
 var import_extension_create = require("extension-create");
 var import_extension_develop = require("extension-develop");
@@ -45,37 +48,37 @@ Please update to the latest version to enjoy new features and improvements.
 }
 function programHelp() {
   return `\u{1F9E9}
-${(0, import_safe.brightGreen)("Help center for the Extension.js program")}
+${(0, import_safe.underline)("Help center for the Extension.js program")}
 
 ${(0, import_safe.brightYellow)("Usage:")} extension [command] [options]
 
-${(0, import_safe.brightBlue)("Note:")} If you are looking for a specific list of options,
+${(0, import_safe.brightYellow)("Note:")} If you are looking for a specific list of options,
 all high-level commands offer their own \`--help\` file with
 information about usage and a list of command flags available.
 
 For example:
 
-${(0, import_safe.brightBlue)("extension create --help")}
-outputs information about the \`create\` command.
+${(0, import_safe.brightGreen)("extension create --help")}
+outputs information about the "create" command.
 
 Options available:
 
-${(0, import_safe.brightBlue)("extension create <extension-name>")}
+${(0, import_safe.brightGreen)("extension create <extension-name>")}
 Creates a new extension from a template. The "create" command
 is optional and can be omitted.
 
-${(0, import_safe.brightBlue)("extension dev <extension-path>")}
+${(0, import_safe.brightGreen)("extension dev <extension-path>")}
 Starts a new browser instance in development mode, with the target
 extension loaded and auto-reloaded based on file changes.
 
-${(0, import_safe.brightBlue)("extension start <extension-path>")}
+${(0, import_safe.brightGreen)("extension start <extension-path>")}
 Starts a new browser instance in production mode, with the target
 extension compiled based on the browser choice.
 
-${(0, import_safe.brightBlue)("extension build <extension-path>")}
+${(0, import_safe.brightGreen)("extension build <extension-path>")}
 Builds the target extension with browser defaults, ready for packaging.
 
-${(0, import_safe.brightBlue)("extension --help")}
+${(0, import_safe.brightGreen)("extension --help")}
 This command ;) Outputs a help file with key command options.
 
 ${(0, import_safe.brightYellow)("Feels something is wrong? Help by reporting a bug:")}
@@ -114,7 +117,7 @@ var package_default = {
     node: ">=18"
   },
   name: "extension",
-  version: "2.0.0-alpha.3",
+  version: "2.0.0-alpha.30",
   description: "Create cross-browser extensions with no build configuration.",
   main: "./dist/cli.js",
   types: "./dist/cli.d.ts",
@@ -131,12 +134,13 @@ var package_default = {
     url: "https://cezaraugusto.com"
   },
   scripts: {
-    watch: "yarn compile --watch",
+    watch: "pnpm compile --watch",
+    "compile:types": "bash install_scripts.sh",
     "compile:readme-files": "node ./scripts/copyMarkdownFilesToCli.js",
     "compile:tailwind-config": "node ./scripts/copyTailwindConfig.js",
     "compile:stylelint-config": "node ./scripts/copyStylelintConfig.js",
     "compile:cli": "tsup-node ./cli.ts --format cjs --dts --target=node18",
-    compile: "yarn compile:readme-files && yarn compile:tailwind-config && yarn compile:stylelint-config &&yarn compile:cli",
+    compile: "pnpm compile:readme-files && pnpm compile:tailwind-config && pnpm compile:stylelint-config && pnpm compile:cli && pnpm compile:types",
     clean: "rm -rf dist",
     test: 'echo "Note: no test specified" && exit 0',
     "test:cli": "jest __spec__/cli.spec.ts"
@@ -156,16 +160,21 @@ var package_default = {
   ],
   dependencies: {
     "@colors/colors": "^1.6.0",
-    "extension-create": "2.0.0-alpha.3",
-    "extension-develop": "2.0.0-alpha.3",
+    "@types/chrome": "^0.0.270",
+    "@types/firefox-webext-browser": "^120.0.4",
+    "@types/node": "^22.5.3",
+    "@types/react": "^18.3.5",
+    "@types/react-dom": "^18.2.18",
     commander: "^11.1.0",
+    "extension-create": "workspace:*",
+    "extension-develop": "workspace:*",
     semver: "^7.5.4",
-    "update-check": "^1.5.4"
+    "update-check": "^1.5.4",
+    "webextension-polyfill": "^0.12.0"
   },
   devDependencies: {
     "@types/jest": "^29.5.11",
     "@types/mock-fs": "^4.13.4",
-    "@types/node": "^20.11.5",
     "@types/semver": "^7.5.6",
     jest: "^29.7.0",
     "mock-fs": "^5.2.0",
@@ -184,21 +193,36 @@ var vendors = (browser) => browser === "all" ? "chrome,edge,firefox".split(",")
 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"
-).action(async function(pathOrRemoteUrl, { template }) {
-  await (0, import_extension_create.extensionCreate)(pathOrRemoteUrl, { template });
+).option(
+  "--install",
+  "whether or not to install the dependencies after creating the project"
+).action(async function(pathOrRemoteUrl, { template, install }) {
+  await (0, import_extension_create.extensionCreate)(pathOrRemoteUrl, {
+    template,
+    install
+  });
 });
 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"
+).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(
   "--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`"
+  "what port should Extension.js WebSocket server run. Defaults to `8000`"
 ).action(async function(pathOrRemoteUrl, { browser = "chrome", ...devOptions }) {
   for (const vendor of vendors(browser)) {
     await (0, import_extension_develop.extensionDev)(pathOrRemoteUrl, {
@@ -209,10 +233,19 @@ extensionJs.command("dev").arguments("[project-path|remote-url]").usage("dev [pr
 });
 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"
+).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(
   "--polyfill [boolean]",
   "whether or not to apply the cross-browser polyfill. Defaults to `true`"

package/dist/types/css-content.d.ts

@@ -0,0 +1,7 @@
+type CSSContentData = Readonly<Record<string, string>>
+
+declare module '*.css' {
+  const content: CSSContentData
+
+  export default content
+}

package/dist/types/css-modules.d.ts

@@ -0,0 +1,19 @@
+type CSSModuleData = Readonly<Record<string, string>>
+
+declare module '*.module.css' {
+  const content: CSSModuleData
+
+  export default content
+}
+
+declare module '*.module.scss' {
+  const content: CSSModuleData
+
+  export default content
+}
+
+declare module '*.module.sass' {
+  const content: CSSModuleData
+
+  export default content
+}

package/dist/types/images.d.ts

@@ -0,0 +1,58 @@
+declare module '*.png' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.jpg' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.jpeg' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.gif' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.webp' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.avif' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.ico' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.bmp' {
+  const content: string
+
+  export default content
+}
+
+declare module '*.svg' {
+  /**
+   * Use `any` to avoid conflicts with
+   * `@svgr/webpack` plugin or
+   * `babel-plugin-inline-react-svg` plugin.
+   */
+  const content: any
+
+  export default content
+}

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+/// <reference types="react" />
+/// <reference types="react-dom" />
+/// <reference types="chrome" />
+/// <reference path="./css-content.d.ts" />
+/// <reference path="./css-modules.d.ts" />
+/// <reference path="./images.d.ts" />
+
+declare namespace NodeJS {
+  interface ProcessEnv {
+    readonly EXTENSION_ENV: 'development' | 'production' | 'test' | 'debug'
+  }
+}

package/dist/types/index.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+/// <reference types="react" />
+/// <reference types="react-dom" />
+/// <reference types="chrome" />
+/// <reference path="./css-content.d.ts" />
+/// <reference path="./css-modules.d.ts" />
+/// <reference path="./images.d.ts" />

package/dist/types/polyfill.d.ts

@@ -0,0 +1 @@
+/// <reference types="webextension-polyfill" />

package/package.json

@@ -9,7 +9,7 @@
     "node": ">=18"
   },
   "name": "extension",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.30",
   "description": "Create cross-browser extensions with no build configuration.",
   "main": "./dist/cli.js",
   "types": "./dist/cli.d.ts",
@@ -25,17 +25,6 @@
     "email": "boss@cezaraugusto.net",
     "url": "https://cezaraugusto.com"
   },
-  "scripts": {
-    "watch": "yarn compile --watch",
-    "compile:readme-files": "node ./scripts/copyMarkdownFilesToCli.js",
-    "compile:tailwind-config": "node ./scripts/copyTailwindConfig.js",
-    "compile:stylelint-config": "node ./scripts/copyStylelintConfig.js",
-    "compile:cli": "tsup-node ./cli.ts --format cjs --dts --target=node18",
-    "compile": "yarn compile:readme-files && yarn compile:tailwind-config && yarn compile:stylelint-config &&yarn compile:cli",
-    "clean": "rm -rf dist",
-    "test": "echo \"Note: no test specified\" && exit 0",
-    "test:cli": "jest __spec__/cli.spec.ts"
-  },
   "keywords": [
     "zero-config",
     "build",
@@ -51,16 +40,21 @@
   ],
   "dependencies": {
     "@colors/colors": "^1.6.0",
-    "extension-create": "2.0.0-alpha.3",
-    "extension-develop": "2.0.0-alpha.3",
+    "@types/chrome": "^0.0.270",
+    "@types/firefox-webext-browser": "^120.0.4",
+    "@types/node": "^22.5.3",
+    "@types/react": "^18.3.5",
+    "@types/react-dom": "^18.2.18",
     "commander": "^11.1.0",
     "semver": "^7.5.4",
-    "update-check": "^1.5.4"
+    "update-check": "^1.5.4",
+    "webextension-polyfill": "^0.12.0",
+    "extension-create": "2.0.0-alpha.30",
+    "extension-develop": "2.0.0-alpha.30"
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",
     "@types/mock-fs": "^4.13.4",
-    "@types/node": "^20.11.5",
     "@types/semver": "^7.5.6",
     "jest": "^29.7.0",
     "mock-fs": "^5.2.0",
@@ -68,5 +62,17 @@
     "tsconfig": "*",
     "tsup": "^8.0.1",
     "typescript": "5.3.3"
+  },
+  "scripts": {
+    "watch": "pnpm compile --watch",
+    "compile:types": "bash install_scripts.sh",
+    "compile:readme-files": "node ./scripts/copyMarkdownFilesToCli.js",
+    "compile:tailwind-config": "node ./scripts/copyTailwindConfig.js",
+    "compile:stylelint-config": "node ./scripts/copyStylelintConfig.js",
+    "compile:cli": "tsup-node ./cli.ts --format cjs --dts --target=node18",
+    "compile": "pnpm compile:readme-files && pnpm compile:tailwind-config && pnpm compile:stylelint-config && pnpm compile:cli && pnpm compile:types",
+    "clean": "rm -rf dist",
+    "test": "echo \"Note: no test specified\" && exit 0",
+    "test:cli": "jest __spec__/cli.spec.ts"
   }
-}
+}