extension-create 1.0.7 → 1.2.1

package/README.md

@@ -1,11 +1,18 @@
-[action-image]: https://github.com/cezaraugusto/extension-create/workflows/CI/badge.svg
+[action-image]: https://github.com/cezaraugusto/extension-create/actions/workflows/ci.yml/badge.svg?branch=main
 [action-url]: https://github.com/cezaraugusto/extension-create/actions
 [npm-image]: https://img.shields.io/npm/v/extension-create.svg
 [npm-url]: https://npmjs.org/package/extension-create
-[wip-image]: https://img.shields.io/badge/under-development-orange.svg
-[wip-url]: https://github.com/cezaraugusto/extension-create
-
-# extension-create [![workflow][action-image]][action-url] [![npm][npm-image]][npm-url] [![wip][wip-image]][wip-url]
+[downloads-image]: https://img.shields.io/npm/dm/extension-create.svg
+[downloads-url]: https://npmjs.org/package/extension-create
+[node]: https://img.shields.io/node/v/extension-create.svg
+[node-url]: https://nodejs.org
+[prs]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
+[prs-url]: https://github.com/cezaraugusto/extension-create/blob/main/CONTRIBUTING.md
+[vunlerabilities]: https://snyk.io/test/github/cezaraugusto/extension-create/badge.svg
+[fossa-image]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcezaraugusto%2Fextension-create.svg?type=shield
+[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fcezaraugusto%2Fextension-create?ref=badge_large
+
+# extension-create [![npm][npm-image]][npm-url] [![fossa][fossa-image]][fossa-url] [![workflow][action-image]][action-url] [![downloads][downloads-image]][downloads-url] [![PR's welcome][prs]][prs-url]
 
 <img alt="Logo" align="right" src="https://user-images.githubusercontent.com/4672033/102850460-4d22aa80-43f8-11eb-82db-9efce586f73e.png" width="25%" />
 
@@ -20,7 +27,7 @@ Create cross-browser extensions with no build configuration.
 ## Creating an Extension
 
 ```sh
-npx extension-create create my-extension-hello
+npx extension-create@latest create my-extension-hello
 cd my-extension-hello
 npm run dev
 ```
@@ -78,6 +85,9 @@ Just add `extension-create` to your npm scripts. Here's how it should look in yo
     "start": "npx extension-create start",
     "dev": "npx extension-create dev",
     "build": "npx extension-create build"
+  },
+  "devDependencies": {
+    "extension-create": "latest"
   }
 }
 ```

package/dist/cli.js

@@ -110,13 +110,14 @@ var package_default = {
   license: "MIT",
   repository: {
     type: "git",
-    url: "https://github.com/cezaraugusto/extension-create.git"
+    url: "https://github.com/cezaraugusto/extension-create.git",
+    directory: "programs/cli"
   },
   engines: {
     node: ">=18"
   },
   name: "extension-create",
-  version: "1.0.7",
+  version: "1.2.1",
   description: "Create cross-browser extensions with no build configuration.",
   main: "./dist/cli.js",
   types: "./dist/cli.d.ts",
@@ -132,9 +133,12 @@ var package_default = {
     url: "https://cezaraugusto.com"
   },
   scripts: {
-    copyMarkdownFilesToCli: "node ./scripts/copyMarkdownFilesToCli.js",
+    "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",
-    compile: "yarn copyMarkdownFilesToCli && tsup-node ./cli.ts --format cjs --dts --target=node18",
     test: "jest"
   },
   keywords: [
@@ -160,14 +164,13 @@ var package_default = {
     "@types/jest": "^29.5.11",
     "@types/mock-fs": "^4.13.4",
     "@types/node": "^20.11.5",
-    "@types/pacote": "^11.1.8",
     "@types/semver": "^7.5.6",
     jest: "^29.7.0",
     "mock-fs": "^5.2.0",
     "ts-jest": "^29.1.2",
     tsconfig: "*",
     tsup: "^8.0.1",
-    typescript: "^5.3.3"
+    typescript: "5.3.3"
   }
 };
 
@@ -180,12 +183,50 @@ if (import_semver.default.lte(process.version, "18.0.0")) {
 }
 var extensionCreate = import_commander.program;
 var isExtensionCreateNamespace = package_default.name === "extension-create";
+if (process.env.EXTENSION_ENV === "development") {
+  console.log(`Running extension-create via ${package_default.name}...`);
+}
 extensionCreate.name(package_default.name).description(package_default.description).version(package_default.version).addHelpText("after", messages_default.programHelp());
 extensionCreate.command("create", { isDefault: isExtensionCreateNamespace }).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(projectName, { template, targetDir }) {
-  await (0, import_create.default)(projectName, { targetDir, template });
+).action(async function(pathOrRemoteUrl, {
+  browser = "chrome",
+  template,
+  ...otherCommandOptions
+}) {
+  const vendors = browser.split(",");
+  switch (pathOrRemoteUrl) {
+    case "dev":
+      for (const vendor of vendors) {
+        await (0, import_develop.extensionDev)(pathOrRemoteUrl, {
+          mode: "development",
+          browser: vendor,
+          ...otherCommandOptions
+        });
+      }
+      break;
+    case "start":
+      for (const vendor of vendors) {
+        await (0, import_develop.extensionStart)(pathOrRemoteUrl, {
+          mode: "production",
+          browser: vendor,
+          ...otherCommandOptions
+        });
+      }
+      break;
+    case "build":
+      for (const vendor of vendors) {
+        await (0, import_develop.extensionBuild)(pathOrRemoteUrl, {
+          browser: vendor,
+          ...otherCommandOptions
+        });
+      }
+      break;
+    default:
+      await (0, import_create.default)(pathOrRemoteUrl, { template });
+      break;
+  }
 });
 extensionCreate.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>",

package/dist/module.d.ts

@@ -0,0 +1,3 @@
+declare function cli(): void;
+
+export { cli as default };

package/dist/module.js

@@ -0,0 +1,255 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// module.ts
+var module_exports = {};
+__export(module_exports, {
+  default: () => cli
+});
+module.exports = __toCommonJS(module_exports);
+var import_semver = __toESM(require("semver"));
+var import_commander = require("commander");
+
+// messages/blockingErrors.ts
+var blockingErrors_exports = {};
+__export(blockingErrors_exports, {
+  noURLWithoutStart: () => noURLWithoutStart,
+  notImplemented: () => notImplemented,
+  unsupportedNodeVersion: () => unsupportedNodeVersion
+});
+function unsupportedNodeVersion() {
+  return `
+    You are using an unsupported Node version (${process.version}).
+
+    Please update to a version higher than 18.
+  `;
+}
+function noURLWithoutStart(argument) {
+  return `
+    The default \`create\` command does not accept URLs.
+    Are you forgetting a \`start\` command? Maybe:
+
+    npx extension-create \`start\` ${argument}
+  `;
+}
+function notImplemented(argument) {
+  return `${argument} command not implemented yet.`;
+}
+
+// messages/programHelp.ts
+function programHelp() {
+  return `
+# Help center for the extension-create program
+
+## Usage: \`extension-create [command] [options]\`
+
+**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:
+
+\`extension-create create --help\`
+outputs information about the \`create\` command.
+
+## Options available
+
+\`extension-create create <extension-name>\`
+Creates a new extension from template. The "create" command
+is optional and can be ommitted.
+
+\`extension-create dev <extension-path>\`
+Starts a new browser instance in development mode, with the target
+extension loaded and auto-reloaded based on file changes.
+
+\`extension-create start <extension-path>\`
+Starts a new browser instance in production mode, with the target
+extension compiled based on the browser choice.
+
+\`extension-create build <extension-path>\`
+Builds the target extension with browser defaults, ready for packaging.
+
+\`extension-create --help\`
+This command ;) Outputs a help file with key command options.
+
+Feels something is wrong? Help by reporting a bug:
+https://github.com/cezaraugusto/extension-create/issues/new
+`;
+}
+
+// messages/index.ts
+var messages = {
+  ...blockingErrors_exports,
+  programHelp
+};
+var messages_default = messages;
+
+// package.json
+var package_default = {
+  license: "MIT",
+  repository: {
+    type: "git",
+    url: "https://github.com/cezaraugusto/extension-create.git",
+    directory: "programs/cli"
+  },
+  engines: {
+    node: ">=18"
+  },
+  name: "@extension-create/cli",
+  version: "1.2.0",
+  description: "Create cross-browser extensions with no build configuration.",
+  main: "./dist/module.js",
+  types: "./dist/module.d.ts",
+  files: [
+    "dist"
+  ],
+  author: {
+    name: "Cezar Augusto",
+    email: "boss@cezaraugusto.net",
+    url: "https://cezaraugusto.com"
+  },
+  scripts: {
+    "compile:tailwind-config": "node ./scripts/copyTailwindConfig.js",
+    "compile:stylelint-config": "node ./scripts/copyStylelintConfig.js",
+    "compile:module": "tsup-node ./module.ts --format cjs --dts --target=node18",
+    compile: "yarn compile:tailwind-config && yarn compile:stylelint-config && yarn compile:module",
+    clean: "rm -rf dist",
+    test: "jest"
+  },
+  keywords: [
+    "zero-config",
+    "build",
+    "develop",
+    "browser",
+    "extension",
+    "chrome extension",
+    "edge extension",
+    "firefox extension",
+    "web",
+    "react",
+    "typescript"
+  ],
+  dependencies: {
+    "@extension-create/create": "*",
+    "@extension-create/develop": "*",
+    commander: "^11.1.0",
+    semver: "^7.5.4"
+  },
+  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",
+    "ts-jest": "^29.1.2",
+    tsconfig: "*",
+    tsup: "^8.0.1",
+    typescript: "5.3.3"
+  }
+};
+
+// module.ts
+var import_create = __toESM(require("@extension-create/create"));
+var import_develop = require("@extension-create/develop");
+if (import_semver.default.lte(process.version, "18.0.0")) {
+  messages_default.unsupportedNodeVersion();
+  process.exit(1);
+}
+var extensionCreate = import_commander.program;
+var isExtensionCreateNamespace = package_default.name === "extension-create";
+extensionCreate.name(package_default.name).description(package_default.description).version(package_default.version).addHelpText("after", messages_default.programHelp());
+extensionCreate.command("create", { isDefault: isExtensionCreateNamespace }).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(projectName, { template, targetDir }) {
+  await (0, import_create.default)(projectName, { targetDir, template });
+});
+extensionCreate.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>",
+  "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>",
+  "specify a browser to run your extension in development mode"
+).option(
+  "--polyfill <boolean>",
+  "whether or not to apply the cross-browser polyfill. Defaults to `true`"
+).option(
+  "-p, --port <number>",
+  "what port should extension-create/develop run. Defaults to `3000`"
+).action(async function(pathOrRemoteUrl, { browser = "chrome", ...devOptions }) {
+  const vendors = browser.split(",");
+  for (const vendor of vendors) {
+    await (0, import_develop.extensionDev)(pathOrRemoteUrl, {
+      mode: "development",
+      browser: vendor,
+      ...devOptions
+    });
+  }
+});
+extensionCreate.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>",
+  "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>",
+  "specify a browser to run your extension in development mode"
+).option(
+  "--polyfill <boolean>",
+  "whether or not to apply the cross-browser polyfill. Defaults to `true`"
+).option(
+  "-p, --port <number>",
+  "what port should extension-create/develop run. Defaults to `3000`"
+).action(async function(pathOrRemoteUrl, { browser = "chrome", ...startOptions }) {
+  const vendors = browser.split(",");
+  for (const vendor of vendors) {
+    await (0, import_develop.extensionStart)(pathOrRemoteUrl, {
+      mode: "production",
+      browser: vendor,
+      ...startOptions
+    });
+  }
+});
+extensionCreate.command("build").arguments("[project-name]").usage("build [path-to-remote-extension] [options]").description("Builds the extension for production").option(
+  "-b, --browser <chrome | edge>",
+  "specify a browser to run your extension in development mode"
+).option(
+  "--polyfill <boolean>",
+  "whether or not to apply the cross-browser polyfill. Defaults to `false`"
+).action(async function(pathOrRemoteUrl, { browser = "chrome", ...buildOptions }) {
+  const vendors = browser.split(",");
+  for (const vendor of vendors) {
+    await (0, import_develop.extensionBuild)(pathOrRemoteUrl, {
+      browser: vendor,
+      ...buildOptions
+    });
+  }
+});
+function cli() {
+  extensionCreate.parse();
+}

package/dist/stylelint.config.js

@@ -0,0 +1,7 @@
+/** @type {import('stylelint').Config} */
+const stylelintRootConfig = {
+  extends: [],
+  rules: {}
+}
+
+module.exports = stylelintRootConfig

package/dist/tailwind.config.js

@@ -0,0 +1,25 @@
+const path = require('path')
+const fs = require('fs')
+
+const [, pathOrRemoteUrl] = process.argv.slice(2)
+const projectDir = pathOrRemoteUrl.startsWith('http')
+  ? process.cwd() + path.basename(pathOrRemoteUrl)
+  : path.resolve(__dirname, pathOrRemoteUrl)
+
+const tailwindConfig = path.join(projectDir, 'tailwind.config.js')
+
+/** @type {import('tailwindcss').Config} */
+const tailwindConfigData = fs.existsSync(tailwindConfig)
+  ? require(tailwindConfig)
+  : {content: []}
+
+/** @type {import('tailwindcss').Config} */
+const tailwindRootConfig = {
+  ...tailwindConfigData,
+  content: [
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    ...tailwindConfigData.content.map((file) => path.join(projectDir, file))
+  ]
+}
+
+module.exports = tailwindRootConfig

package/package.json

@@ -2,13 +2,14 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/cezaraugusto/extension-create.git"
+    "url": "https://github.com/cezaraugusto/extension-create.git",
+    "directory": "programs/cli"
   },
   "engines": {
     "node": ">=18"
   },
   "name": "extension-create",
-  "version": "1.0.7",
+  "version": "1.2.1",
   "description": "Create cross-browser extensions with no build configuration.",
   "main": "./dist/cli.js",
   "types": "./dist/cli.d.ts",
@@ -24,9 +25,12 @@
     "url": "https://cezaraugusto.com"
   },
   "scripts": {
-    "copyMarkdownFilesToCli": "node ./scripts/copyMarkdownFilesToCli.js",
+    "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",
-    "compile": "yarn copyMarkdownFilesToCli && tsup-node ./cli.ts --format cjs --dts --target=node18",
     "test": "jest"
   },
   "keywords": [
@@ -52,13 +56,12 @@
     "@types/jest": "^29.5.11",
     "@types/mock-fs": "^4.13.4",
     "@types/node": "^20.11.5",
-    "@types/pacote": "^11.1.8",
     "@types/semver": "^7.5.6",
     "jest": "^29.7.0",
     "mock-fs": "^5.2.0",
     "ts-jest": "^29.1.2",
     "tsconfig": "*",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.3"
+    "typescript": "5.3.3"
   }
-}
+}